license

package
v2.29.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 27, 2025 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for license API

func (*Client) LicensesAttach

func (a *Client) LicensesAttach(params *LicensesAttachParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*LicensesAttachOK, error)

LicensesAttach attaches a list of licenses to portainer

**Access policy**: administrator

func (*Client) LicensesDelete

func (a *Client) LicensesDelete(params *LicensesDeleteParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*LicensesDeleteOK, error)

LicensesDelete deletes license from portainer instance

**Access policy**: administrator

func (*Client) LicensesInfo

func (a *Client) LicensesInfo(params *LicensesInfoParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*LicensesInfoOK, error)

LicensesInfo summarizes licenses on portainer

**Access policy**: administrator

func (*Client) LicensesList

func (a *Client) LicensesList(params *LicensesListParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*LicensesListOK, error)

LicensesList fetches the list of licenses on portainer

**Access policy**: administrator

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService

type ClientService interface {
	LicensesAttach(params *LicensesAttachParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*LicensesAttachOK, error)

	LicensesDelete(params *LicensesDeleteParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*LicensesDeleteOK, error)

	LicensesInfo(params *LicensesInfoParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*LicensesInfoOK, error)

	LicensesList(params *LicensesListParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*LicensesListOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new license API client.

func NewClientWithBasicAuth

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new license API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new license API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type LicensesAttachOK

type LicensesAttachOK struct {
	Payload *models.LicensesAttachResponse
}

LicensesAttachOK describes a response with status code 200, with default header values.

Success license data will be in `body.Licenses`, Failures will be in `body.ConflictingKeys = error`

func NewLicensesAttachOK

func NewLicensesAttachOK() *LicensesAttachOK

NewLicensesAttachOK creates a LicensesAttachOK with default headers values

func (*LicensesAttachOK) Code

func (o *LicensesAttachOK) Code() int

Code gets the status code for the licenses attach o k response

func (*LicensesAttachOK) Error

func (o *LicensesAttachOK) Error() string

func (*LicensesAttachOK) GetPayload

func (*LicensesAttachOK) IsClientError

func (o *LicensesAttachOK) IsClientError() bool

IsClientError returns true when this licenses attach o k response has a 4xx status code

func (*LicensesAttachOK) IsCode

func (o *LicensesAttachOK) IsCode(code int) bool

IsCode returns true when this licenses attach o k response a status code equal to that given

func (*LicensesAttachOK) IsRedirect

func (o *LicensesAttachOK) IsRedirect() bool

IsRedirect returns true when this licenses attach o k response has a 3xx status code

func (*LicensesAttachOK) IsServerError

func (o *LicensesAttachOK) IsServerError() bool

IsServerError returns true when this licenses attach o k response has a 5xx status code

func (*LicensesAttachOK) IsSuccess

func (o *LicensesAttachOK) IsSuccess() bool

IsSuccess returns true when this licenses attach o k response has a 2xx status code

func (*LicensesAttachOK) String

func (o *LicensesAttachOK) String() string

type LicensesAttachParams

type LicensesAttachParams struct {

	/* Body.

	   list of licenses keys to attach
	*/
	Body *models.LicensesAttachPayload

	/* Force.

	   remove conflicting licenses
	*/
	Force *bool

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

LicensesAttachParams contains all the parameters to send to the API endpoint

for the licenses attach operation.

Typically these are written to a http.Request.

func NewLicensesAttachParams

func NewLicensesAttachParams() *LicensesAttachParams

NewLicensesAttachParams creates a new LicensesAttachParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewLicensesAttachParamsWithContext

func NewLicensesAttachParamsWithContext(ctx context.Context) *LicensesAttachParams

NewLicensesAttachParamsWithContext creates a new LicensesAttachParams object with the ability to set a context for a request.

func NewLicensesAttachParamsWithHTTPClient

func NewLicensesAttachParamsWithHTTPClient(client *http.Client) *LicensesAttachParams

NewLicensesAttachParamsWithHTTPClient creates a new LicensesAttachParams object with the ability to set a custom HTTPClient for a request.

func NewLicensesAttachParamsWithTimeout

func NewLicensesAttachParamsWithTimeout(timeout time.Duration) *LicensesAttachParams

NewLicensesAttachParamsWithTimeout creates a new LicensesAttachParams object with the ability to set a timeout on a request.

func (*LicensesAttachParams) SetBody

SetBody adds the body to the licenses attach params

func (*LicensesAttachParams) SetContext

func (o *LicensesAttachParams) SetContext(ctx context.Context)

SetContext adds the context to the licenses attach params

func (*LicensesAttachParams) SetDefaults

func (o *LicensesAttachParams) SetDefaults()

SetDefaults hydrates default values in the licenses attach params (not the query body).

All values with no default are reset to their zero value.

func (*LicensesAttachParams) SetForce

func (o *LicensesAttachParams) SetForce(force *bool)

SetForce adds the force to the licenses attach params

func (*LicensesAttachParams) SetHTTPClient

func (o *LicensesAttachParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the licenses attach params

func (*LicensesAttachParams) SetTimeout

func (o *LicensesAttachParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the licenses attach params

func (*LicensesAttachParams) WithBody

WithBody adds the body to the licenses attach params

func (*LicensesAttachParams) WithContext

WithContext adds the context to the licenses attach params

func (*LicensesAttachParams) WithDefaults

func (o *LicensesAttachParams) WithDefaults() *LicensesAttachParams

WithDefaults hydrates default values in the licenses attach params (not the query body).

All values with no default are reset to their zero value.

func (*LicensesAttachParams) WithForce

func (o *LicensesAttachParams) WithForce(force *bool) *LicensesAttachParams

WithForce adds the force to the licenses attach params

func (*LicensesAttachParams) WithHTTPClient

func (o *LicensesAttachParams) WithHTTPClient(client *http.Client) *LicensesAttachParams

WithHTTPClient adds the HTTPClient to the licenses attach params

func (*LicensesAttachParams) WithTimeout

func (o *LicensesAttachParams) WithTimeout(timeout time.Duration) *LicensesAttachParams

WithTimeout adds the timeout to the licenses attach params

func (*LicensesAttachParams) WriteToRequest

func (o *LicensesAttachParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type LicensesAttachReader

type LicensesAttachReader struct {
	// contains filtered or unexported fields
}

LicensesAttachReader is a Reader for the LicensesAttach structure.

func (*LicensesAttachReader) ReadResponse

func (o *LicensesAttachReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type LicensesDeleteOK

type LicensesDeleteOK struct {
}

LicensesDeleteOK describes a response with status code 200, with default header values.

OK

func NewLicensesDeleteOK

func NewLicensesDeleteOK() *LicensesDeleteOK

NewLicensesDeleteOK creates a LicensesDeleteOK with default headers values

func (*LicensesDeleteOK) Code

func (o *LicensesDeleteOK) Code() int

Code gets the status code for the licenses delete o k response

func (*LicensesDeleteOK) Error

func (o *LicensesDeleteOK) Error() string

func (*LicensesDeleteOK) IsClientError

func (o *LicensesDeleteOK) IsClientError() bool

IsClientError returns true when this licenses delete o k response has a 4xx status code

func (*LicensesDeleteOK) IsCode

func (o *LicensesDeleteOK) IsCode(code int) bool

IsCode returns true when this licenses delete o k response a status code equal to that given

func (*LicensesDeleteOK) IsRedirect

func (o *LicensesDeleteOK) IsRedirect() bool

IsRedirect returns true when this licenses delete o k response has a 3xx status code

func (*LicensesDeleteOK) IsServerError

func (o *LicensesDeleteOK) IsServerError() bool

IsServerError returns true when this licenses delete o k response has a 5xx status code

func (*LicensesDeleteOK) IsSuccess

func (o *LicensesDeleteOK) IsSuccess() bool

IsSuccess returns true when this licenses delete o k response has a 2xx status code

func (*LicensesDeleteOK) String

func (o *LicensesDeleteOK) String() string

type LicensesDeleteParams

type LicensesDeleteParams struct {

	/* Body.

	   list of license keys to remove
	*/
	Body *models.LicensesDeletePayload

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

LicensesDeleteParams contains all the parameters to send to the API endpoint

for the licenses delete operation.

Typically these are written to a http.Request.

func NewLicensesDeleteParams

func NewLicensesDeleteParams() *LicensesDeleteParams

NewLicensesDeleteParams creates a new LicensesDeleteParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewLicensesDeleteParamsWithContext

func NewLicensesDeleteParamsWithContext(ctx context.Context) *LicensesDeleteParams

NewLicensesDeleteParamsWithContext creates a new LicensesDeleteParams object with the ability to set a context for a request.

func NewLicensesDeleteParamsWithHTTPClient

func NewLicensesDeleteParamsWithHTTPClient(client *http.Client) *LicensesDeleteParams

NewLicensesDeleteParamsWithHTTPClient creates a new LicensesDeleteParams object with the ability to set a custom HTTPClient for a request.

func NewLicensesDeleteParamsWithTimeout

func NewLicensesDeleteParamsWithTimeout(timeout time.Duration) *LicensesDeleteParams

NewLicensesDeleteParamsWithTimeout creates a new LicensesDeleteParams object with the ability to set a timeout on a request.

func (*LicensesDeleteParams) SetBody

SetBody adds the body to the licenses delete params

func (*LicensesDeleteParams) SetContext

func (o *LicensesDeleteParams) SetContext(ctx context.Context)

SetContext adds the context to the licenses delete params

func (*LicensesDeleteParams) SetDefaults

func (o *LicensesDeleteParams) SetDefaults()

SetDefaults hydrates default values in the licenses delete params (not the query body).

All values with no default are reset to their zero value.

func (*LicensesDeleteParams) SetHTTPClient

func (o *LicensesDeleteParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the licenses delete params

func (*LicensesDeleteParams) SetTimeout

func (o *LicensesDeleteParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the licenses delete params

func (*LicensesDeleteParams) WithBody

WithBody adds the body to the licenses delete params

func (*LicensesDeleteParams) WithContext

WithContext adds the context to the licenses delete params

func (*LicensesDeleteParams) WithDefaults

func (o *LicensesDeleteParams) WithDefaults() *LicensesDeleteParams

WithDefaults hydrates default values in the licenses delete params (not the query body).

All values with no default are reset to their zero value.

func (*LicensesDeleteParams) WithHTTPClient

func (o *LicensesDeleteParams) WithHTTPClient(client *http.Client) *LicensesDeleteParams

WithHTTPClient adds the HTTPClient to the licenses delete params

func (*LicensesDeleteParams) WithTimeout

func (o *LicensesDeleteParams) WithTimeout(timeout time.Duration) *LicensesDeleteParams

WithTimeout adds the timeout to the licenses delete params

func (*LicensesDeleteParams) WriteToRequest

func (o *LicensesDeleteParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type LicensesDeleteReader

type LicensesDeleteReader struct {
	// contains filtered or unexported fields
}

LicensesDeleteReader is a Reader for the LicensesDelete structure.

func (*LicensesDeleteReader) ReadResponse

func (o *LicensesDeleteReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type LicensesInfoOK

type LicensesInfoOK struct {
	Payload *models.LicensesLicenseInfo
}

LicensesInfoOK describes a response with status code 200, with default header values.

License info

func NewLicensesInfoOK

func NewLicensesInfoOK() *LicensesInfoOK

NewLicensesInfoOK creates a LicensesInfoOK with default headers values

func (*LicensesInfoOK) Code

func (o *LicensesInfoOK) Code() int

Code gets the status code for the licenses info o k response

func (*LicensesInfoOK) Error

func (o *LicensesInfoOK) Error() string

func (*LicensesInfoOK) GetPayload

func (o *LicensesInfoOK) GetPayload() *models.LicensesLicenseInfo

func (*LicensesInfoOK) IsClientError

func (o *LicensesInfoOK) IsClientError() bool

IsClientError returns true when this licenses info o k response has a 4xx status code

func (*LicensesInfoOK) IsCode

func (o *LicensesInfoOK) IsCode(code int) bool

IsCode returns true when this licenses info o k response a status code equal to that given

func (*LicensesInfoOK) IsRedirect

func (o *LicensesInfoOK) IsRedirect() bool

IsRedirect returns true when this licenses info o k response has a 3xx status code

func (*LicensesInfoOK) IsServerError

func (o *LicensesInfoOK) IsServerError() bool

IsServerError returns true when this licenses info o k response has a 5xx status code

func (*LicensesInfoOK) IsSuccess

func (o *LicensesInfoOK) IsSuccess() bool

IsSuccess returns true when this licenses info o k response has a 2xx status code

func (*LicensesInfoOK) String

func (o *LicensesInfoOK) String() string

type LicensesInfoParams

type LicensesInfoParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

LicensesInfoParams contains all the parameters to send to the API endpoint

for the licenses info operation.

Typically these are written to a http.Request.

func NewLicensesInfoParams

func NewLicensesInfoParams() *LicensesInfoParams

NewLicensesInfoParams creates a new LicensesInfoParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewLicensesInfoParamsWithContext

func NewLicensesInfoParamsWithContext(ctx context.Context) *LicensesInfoParams

NewLicensesInfoParamsWithContext creates a new LicensesInfoParams object with the ability to set a context for a request.

func NewLicensesInfoParamsWithHTTPClient

func NewLicensesInfoParamsWithHTTPClient(client *http.Client) *LicensesInfoParams

NewLicensesInfoParamsWithHTTPClient creates a new LicensesInfoParams object with the ability to set a custom HTTPClient for a request.

func NewLicensesInfoParamsWithTimeout

func NewLicensesInfoParamsWithTimeout(timeout time.Duration) *LicensesInfoParams

NewLicensesInfoParamsWithTimeout creates a new LicensesInfoParams object with the ability to set a timeout on a request.

func (*LicensesInfoParams) SetContext

func (o *LicensesInfoParams) SetContext(ctx context.Context)

SetContext adds the context to the licenses info params

func (*LicensesInfoParams) SetDefaults

func (o *LicensesInfoParams) SetDefaults()

SetDefaults hydrates default values in the licenses info params (not the query body).

All values with no default are reset to their zero value.

func (*LicensesInfoParams) SetHTTPClient

func (o *LicensesInfoParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the licenses info params

func (*LicensesInfoParams) SetTimeout

func (o *LicensesInfoParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the licenses info params

func (*LicensesInfoParams) WithContext

WithContext adds the context to the licenses info params

func (*LicensesInfoParams) WithDefaults

func (o *LicensesInfoParams) WithDefaults() *LicensesInfoParams

WithDefaults hydrates default values in the licenses info params (not the query body).

All values with no default are reset to their zero value.

func (*LicensesInfoParams) WithHTTPClient

func (o *LicensesInfoParams) WithHTTPClient(client *http.Client) *LicensesInfoParams

WithHTTPClient adds the HTTPClient to the licenses info params

func (*LicensesInfoParams) WithTimeout

func (o *LicensesInfoParams) WithTimeout(timeout time.Duration) *LicensesInfoParams

WithTimeout adds the timeout to the licenses info params

func (*LicensesInfoParams) WriteToRequest

func (o *LicensesInfoParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type LicensesInfoReader

type LicensesInfoReader struct {
	// contains filtered or unexported fields
}

LicensesInfoReader is a Reader for the LicensesInfo structure.

func (*LicensesInfoReader) ReadResponse

func (o *LicensesInfoReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type LicensesListOK

type LicensesListOK struct {
	Payload []*models.LiblicensePortainerLicense
}

LicensesListOK describes a response with status code 200, with default header values.

Licenses

func NewLicensesListOK

func NewLicensesListOK() *LicensesListOK

NewLicensesListOK creates a LicensesListOK with default headers values

func (*LicensesListOK) Code

func (o *LicensesListOK) Code() int

Code gets the status code for the licenses list o k response

func (*LicensesListOK) Error

func (o *LicensesListOK) Error() string

func (*LicensesListOK) GetPayload

func (*LicensesListOK) IsClientError

func (o *LicensesListOK) IsClientError() bool

IsClientError returns true when this licenses list o k response has a 4xx status code

func (*LicensesListOK) IsCode

func (o *LicensesListOK) IsCode(code int) bool

IsCode returns true when this licenses list o k response a status code equal to that given

func (*LicensesListOK) IsRedirect

func (o *LicensesListOK) IsRedirect() bool

IsRedirect returns true when this licenses list o k response has a 3xx status code

func (*LicensesListOK) IsServerError

func (o *LicensesListOK) IsServerError() bool

IsServerError returns true when this licenses list o k response has a 5xx status code

func (*LicensesListOK) IsSuccess

func (o *LicensesListOK) IsSuccess() bool

IsSuccess returns true when this licenses list o k response has a 2xx status code

func (*LicensesListOK) String

func (o *LicensesListOK) String() string

type LicensesListParams

type LicensesListParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

LicensesListParams contains all the parameters to send to the API endpoint

for the licenses list operation.

Typically these are written to a http.Request.

func NewLicensesListParams

func NewLicensesListParams() *LicensesListParams

NewLicensesListParams creates a new LicensesListParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewLicensesListParamsWithContext

func NewLicensesListParamsWithContext(ctx context.Context) *LicensesListParams

NewLicensesListParamsWithContext creates a new LicensesListParams object with the ability to set a context for a request.

func NewLicensesListParamsWithHTTPClient

func NewLicensesListParamsWithHTTPClient(client *http.Client) *LicensesListParams

NewLicensesListParamsWithHTTPClient creates a new LicensesListParams object with the ability to set a custom HTTPClient for a request.

func NewLicensesListParamsWithTimeout

func NewLicensesListParamsWithTimeout(timeout time.Duration) *LicensesListParams

NewLicensesListParamsWithTimeout creates a new LicensesListParams object with the ability to set a timeout on a request.

func (*LicensesListParams) SetContext

func (o *LicensesListParams) SetContext(ctx context.Context)

SetContext adds the context to the licenses list params

func (*LicensesListParams) SetDefaults

func (o *LicensesListParams) SetDefaults()

SetDefaults hydrates default values in the licenses list params (not the query body).

All values with no default are reset to their zero value.

func (*LicensesListParams) SetHTTPClient

func (o *LicensesListParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the licenses list params

func (*LicensesListParams) SetTimeout

func (o *LicensesListParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the licenses list params

func (*LicensesListParams) WithContext

WithContext adds the context to the licenses list params

func (*LicensesListParams) WithDefaults

func (o *LicensesListParams) WithDefaults() *LicensesListParams

WithDefaults hydrates default values in the licenses list params (not the query body).

All values with no default are reset to their zero value.

func (*LicensesListParams) WithHTTPClient

func (o *LicensesListParams) WithHTTPClient(client *http.Client) *LicensesListParams

WithHTTPClient adds the HTTPClient to the licenses list params

func (*LicensesListParams) WithTimeout

func (o *LicensesListParams) WithTimeout(timeout time.Duration) *LicensesListParams

WithTimeout adds the timeout to the licenses list params

func (*LicensesListParams) WriteToRequest

func (o *LicensesListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type LicensesListReader

type LicensesListReader struct {
	// contains filtered or unexported fields
}

LicensesListReader is a Reader for the LicensesList structure.

func (*LicensesListReader) ReadResponse

func (o *LicensesListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL