Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type RoleListInternalServerError
- func (o *RoleListInternalServerError) Code() int
- func (o *RoleListInternalServerError) Error() string
- func (o *RoleListInternalServerError) IsClientError() bool
- func (o *RoleListInternalServerError) IsCode(code int) bool
- func (o *RoleListInternalServerError) IsRedirect() bool
- func (o *RoleListInternalServerError) IsServerError() bool
- func (o *RoleListInternalServerError) IsSuccess() bool
- func (o *RoleListInternalServerError) String() string
- type RoleListOK
- func (o *RoleListOK) Code() int
- func (o *RoleListOK) Error() string
- func (o *RoleListOK) GetPayload() []*models.PortainereeRole
- func (o *RoleListOK) IsClientError() bool
- func (o *RoleListOK) IsCode(code int) bool
- func (o *RoleListOK) IsRedirect() bool
- func (o *RoleListOK) IsServerError() bool
- func (o *RoleListOK) IsSuccess() bool
- func (o *RoleListOK) String() string
- type RoleListParams
- func (o *RoleListParams) SetContext(ctx context.Context)
- func (o *RoleListParams) SetDefaults()
- func (o *RoleListParams) SetHTTPClient(client *http.Client)
- func (o *RoleListParams) SetTimeout(timeout time.Duration)
- func (o *RoleListParams) WithContext(ctx context.Context) *RoleListParams
- func (o *RoleListParams) WithDefaults() *RoleListParams
- func (o *RoleListParams) WithHTTPClient(client *http.Client) *RoleListParams
- func (o *RoleListParams) WithTimeout(timeout time.Duration) *RoleListParams
- func (o *RoleListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type RoleListReader
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 roles API
func (*Client) RoleList ¶
func (a *Client) RoleList(params *RoleListParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RoleListOK, error)
RoleList lists roles List all roles available for use
**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 {
RoleList(params *RoleListParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RoleListOK, 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 roles API client.
func NewClientWithBasicAuth ¶
func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService
New creates a new roles 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 roles 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 RoleListInternalServerError ¶
type RoleListInternalServerError struct {
}
RoleListInternalServerError describes a response with status code 500, with default header values.
Server error
func NewRoleListInternalServerError ¶
func NewRoleListInternalServerError() *RoleListInternalServerError
NewRoleListInternalServerError creates a RoleListInternalServerError with default headers values
func (*RoleListInternalServerError) Code ¶
func (o *RoleListInternalServerError) Code() int
Code gets the status code for the role list internal server error response
func (*RoleListInternalServerError) Error ¶
func (o *RoleListInternalServerError) Error() string
func (*RoleListInternalServerError) IsClientError ¶
func (o *RoleListInternalServerError) IsClientError() bool
IsClientError returns true when this role list internal server error response has a 4xx status code
func (*RoleListInternalServerError) IsCode ¶
func (o *RoleListInternalServerError) IsCode(code int) bool
IsCode returns true when this role list internal server error response a status code equal to that given
func (*RoleListInternalServerError) IsRedirect ¶
func (o *RoleListInternalServerError) IsRedirect() bool
IsRedirect returns true when this role list internal server error response has a 3xx status code
func (*RoleListInternalServerError) IsServerError ¶
func (o *RoleListInternalServerError) IsServerError() bool
IsServerError returns true when this role list internal server error response has a 5xx status code
func (*RoleListInternalServerError) IsSuccess ¶
func (o *RoleListInternalServerError) IsSuccess() bool
IsSuccess returns true when this role list internal server error response has a 2xx status code
func (*RoleListInternalServerError) String ¶
func (o *RoleListInternalServerError) String() string
type RoleListOK ¶
type RoleListOK struct {
Payload []*models.PortainereeRole
}
RoleListOK describes a response with status code 200, with default header values.
Success
func NewRoleListOK ¶
func NewRoleListOK() *RoleListOK
NewRoleListOK creates a RoleListOK with default headers values
func (*RoleListOK) Code ¶
func (o *RoleListOK) Code() int
Code gets the status code for the role list o k response
func (*RoleListOK) Error ¶
func (o *RoleListOK) Error() string
func (*RoleListOK) GetPayload ¶
func (o *RoleListOK) GetPayload() []*models.PortainereeRole
func (*RoleListOK) IsClientError ¶
func (o *RoleListOK) IsClientError() bool
IsClientError returns true when this role list o k response has a 4xx status code
func (*RoleListOK) IsCode ¶
func (o *RoleListOK) IsCode(code int) bool
IsCode returns true when this role list o k response a status code equal to that given
func (*RoleListOK) IsRedirect ¶
func (o *RoleListOK) IsRedirect() bool
IsRedirect returns true when this role list o k response has a 3xx status code
func (*RoleListOK) IsServerError ¶
func (o *RoleListOK) IsServerError() bool
IsServerError returns true when this role list o k response has a 5xx status code
func (*RoleListOK) IsSuccess ¶
func (o *RoleListOK) IsSuccess() bool
IsSuccess returns true when this role list o k response has a 2xx status code
func (*RoleListOK) String ¶
func (o *RoleListOK) String() string
type RoleListParams ¶
type RoleListParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
RoleListParams contains all the parameters to send to the API endpoint
for the role list operation. Typically these are written to a http.Request.
func NewRoleListParams ¶
func NewRoleListParams() *RoleListParams
NewRoleListParams creates a new RoleListParams 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 NewRoleListParamsWithContext ¶
func NewRoleListParamsWithContext(ctx context.Context) *RoleListParams
NewRoleListParamsWithContext creates a new RoleListParams object with the ability to set a context for a request.
func NewRoleListParamsWithHTTPClient ¶
func NewRoleListParamsWithHTTPClient(client *http.Client) *RoleListParams
NewRoleListParamsWithHTTPClient creates a new RoleListParams object with the ability to set a custom HTTPClient for a request.
func NewRoleListParamsWithTimeout ¶
func NewRoleListParamsWithTimeout(timeout time.Duration) *RoleListParams
NewRoleListParamsWithTimeout creates a new RoleListParams object with the ability to set a timeout on a request.
func (*RoleListParams) SetContext ¶
func (o *RoleListParams) SetContext(ctx context.Context)
SetContext adds the context to the role list params
func (*RoleListParams) SetDefaults ¶
func (o *RoleListParams) SetDefaults()
SetDefaults hydrates default values in the role list params (not the query body).
All values with no default are reset to their zero value.
func (*RoleListParams) SetHTTPClient ¶
func (o *RoleListParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the role list params
func (*RoleListParams) SetTimeout ¶
func (o *RoleListParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the role list params
func (*RoleListParams) WithContext ¶
func (o *RoleListParams) WithContext(ctx context.Context) *RoleListParams
WithContext adds the context to the role list params
func (*RoleListParams) WithDefaults ¶
func (o *RoleListParams) WithDefaults() *RoleListParams
WithDefaults hydrates default values in the role list params (not the query body).
All values with no default are reset to their zero value.
func (*RoleListParams) WithHTTPClient ¶
func (o *RoleListParams) WithHTTPClient(client *http.Client) *RoleListParams
WithHTTPClient adds the HTTPClient to the role list params
func (*RoleListParams) WithTimeout ¶
func (o *RoleListParams) WithTimeout(timeout time.Duration) *RoleListParams
WithTimeout adds the timeout to the role list params
func (*RoleListParams) WriteToRequest ¶
func (o *RoleListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type RoleListReader ¶
type RoleListReader struct {
// contains filtered or unexported fields
}
RoleListReader is a Reader for the RoleList structure.
func (*RoleListReader) ReadResponse ¶
func (o *RoleListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files