Documentation
¶
Index ¶
- type Client
- func (a *Client) CreateAuthToken(params *CreateAuthTokenParams, authInfo runtime.ClientAuthInfoWriter) (*CreateAuthTokenOK, error)
- func (a *Client) DeleteAuthToken(params *DeleteAuthTokenParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteAuthTokenOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type CreateAuthTokenOK
- type CreateAuthTokenParams
- func NewCreateAuthTokenParams() *CreateAuthTokenParams
- func NewCreateAuthTokenParamsWithContext(ctx context.Context) *CreateAuthTokenParams
- func NewCreateAuthTokenParamsWithHTTPClient(client *http.Client) *CreateAuthTokenParams
- func NewCreateAuthTokenParamsWithTimeout(timeout time.Duration) *CreateAuthTokenParams
- func (o *CreateAuthTokenParams) SetBody(body *models.V4CreateAuthTokenRequest)
- func (o *CreateAuthTokenParams) SetContext(ctx context.Context)
- func (o *CreateAuthTokenParams) SetHTTPClient(client *http.Client)
- func (o *CreateAuthTokenParams) SetTimeout(timeout time.Duration)
- func (o *CreateAuthTokenParams) SetXGiantSwarmActivity(xGiantSwarmActivity *string)
- func (o *CreateAuthTokenParams) SetXGiantSwarmCmdLine(xGiantSwarmCmdLine *string)
- func (o *CreateAuthTokenParams) SetXRequestID(xRequestID *string)
- func (o *CreateAuthTokenParams) WithBody(body *models.V4CreateAuthTokenRequest) *CreateAuthTokenParams
- func (o *CreateAuthTokenParams) WithContext(ctx context.Context) *CreateAuthTokenParams
- func (o *CreateAuthTokenParams) WithHTTPClient(client *http.Client) *CreateAuthTokenParams
- func (o *CreateAuthTokenParams) WithTimeout(timeout time.Duration) *CreateAuthTokenParams
- func (o *CreateAuthTokenParams) WithXGiantSwarmActivity(xGiantSwarmActivity *string) *CreateAuthTokenParams
- func (o *CreateAuthTokenParams) WithXGiantSwarmCmdLine(xGiantSwarmCmdLine *string) *CreateAuthTokenParams
- func (o *CreateAuthTokenParams) WithXRequestID(xRequestID *string) *CreateAuthTokenParams
- func (o *CreateAuthTokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type CreateAuthTokenReader
- type CreateAuthTokenUnauthorized
- type DeleteAuthTokenOK
- type DeleteAuthTokenParams
- func NewDeleteAuthTokenParams() *DeleteAuthTokenParams
- func NewDeleteAuthTokenParamsWithContext(ctx context.Context) *DeleteAuthTokenParams
- func NewDeleteAuthTokenParamsWithHTTPClient(client *http.Client) *DeleteAuthTokenParams
- func NewDeleteAuthTokenParamsWithTimeout(timeout time.Duration) *DeleteAuthTokenParams
- func (o *DeleteAuthTokenParams) SetContext(ctx context.Context)
- func (o *DeleteAuthTokenParams) SetHTTPClient(client *http.Client)
- func (o *DeleteAuthTokenParams) SetTimeout(timeout time.Duration)
- func (o *DeleteAuthTokenParams) SetXGiantSwarmActivity(xGiantSwarmActivity *string)
- func (o *DeleteAuthTokenParams) SetXGiantSwarmCmdLine(xGiantSwarmCmdLine *string)
- func (o *DeleteAuthTokenParams) SetXRequestID(xRequestID *string)
- func (o *DeleteAuthTokenParams) WithContext(ctx context.Context) *DeleteAuthTokenParams
- func (o *DeleteAuthTokenParams) WithHTTPClient(client *http.Client) *DeleteAuthTokenParams
- func (o *DeleteAuthTokenParams) WithTimeout(timeout time.Duration) *DeleteAuthTokenParams
- func (o *DeleteAuthTokenParams) WithXGiantSwarmActivity(xGiantSwarmActivity *string) *DeleteAuthTokenParams
- func (o *DeleteAuthTokenParams) WithXGiantSwarmCmdLine(xGiantSwarmCmdLine *string) *DeleteAuthTokenParams
- func (o *DeleteAuthTokenParams) WithXRequestID(xRequestID *string) *DeleteAuthTokenParams
- func (o *DeleteAuthTokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type DeleteAuthTokenReader
- type DeleteAuthTokenUnauthorized
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 auth tokens API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new auth tokens API client.
func (*Client) CreateAuthToken ¶
func (a *Client) CreateAuthToken(params *CreateAuthTokenParams, authInfo runtime.ClientAuthInfoWriter) (*CreateAuthTokenOK, error)
CreateAuthToken creates auth token login
Creates a Auth Token for a given user. Must authenticate with email and password.
func (*Client) DeleteAuthToken ¶
func (a *Client) DeleteAuthToken(params *DeleteAuthTokenParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteAuthTokenOK, error)
DeleteAuthToken deletes auth token logout
Deletes the authentication token provided in the Authorization header. This effectively logs you out.
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type CreateAuthTokenOK ¶
type CreateAuthTokenOK struct {
Payload *models.V4CreateAuthTokenResponse
}
CreateAuthTokenOK handles this case with default header values.
Success
func NewCreateAuthTokenOK ¶
func NewCreateAuthTokenOK() *CreateAuthTokenOK
NewCreateAuthTokenOK creates a CreateAuthTokenOK with default headers values
func (*CreateAuthTokenOK) Error ¶
func (o *CreateAuthTokenOK) Error() string
type CreateAuthTokenParams ¶
type CreateAuthTokenParams struct { /*XGiantSwarmActivity Name of an activity to track, like "list-clusters". This allows to analyze several API requests sent in context and gives an idea on the purpose. */ XGiantSwarmActivity *string /*XGiantSwarmCmdLine If activity has been issued by a CLI, this header can contain the command line */ XGiantSwarmCmdLine *string /*XRequestID A randomly generated key that can be used to track a request throughout services of Giant Swarm. */ XRequestID *string /*Body Create Auth Token Request */ Body *models.V4CreateAuthTokenRequest Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
CreateAuthTokenParams contains all the parameters to send to the API endpoint for the create auth token operation typically these are written to a http.Request
func NewCreateAuthTokenParams ¶
func NewCreateAuthTokenParams() *CreateAuthTokenParams
NewCreateAuthTokenParams creates a new CreateAuthTokenParams object with the default values initialized.
func NewCreateAuthTokenParamsWithContext ¶
func NewCreateAuthTokenParamsWithContext(ctx context.Context) *CreateAuthTokenParams
NewCreateAuthTokenParamsWithContext creates a new CreateAuthTokenParams object with the default values initialized, and the ability to set a context for a request
func NewCreateAuthTokenParamsWithHTTPClient ¶
func NewCreateAuthTokenParamsWithHTTPClient(client *http.Client) *CreateAuthTokenParams
NewCreateAuthTokenParamsWithHTTPClient creates a new CreateAuthTokenParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewCreateAuthTokenParamsWithTimeout ¶
func NewCreateAuthTokenParamsWithTimeout(timeout time.Duration) *CreateAuthTokenParams
NewCreateAuthTokenParamsWithTimeout creates a new CreateAuthTokenParams object with the default values initialized, and the ability to set a timeout on a request
func (*CreateAuthTokenParams) SetBody ¶
func (o *CreateAuthTokenParams) SetBody(body *models.V4CreateAuthTokenRequest)
SetBody adds the body to the create auth token params
func (*CreateAuthTokenParams) SetContext ¶
func (o *CreateAuthTokenParams) SetContext(ctx context.Context)
SetContext adds the context to the create auth token params
func (*CreateAuthTokenParams) SetHTTPClient ¶
func (o *CreateAuthTokenParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the create auth token params
func (*CreateAuthTokenParams) SetTimeout ¶
func (o *CreateAuthTokenParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the create auth token params
func (*CreateAuthTokenParams) SetXGiantSwarmActivity ¶
func (o *CreateAuthTokenParams) SetXGiantSwarmActivity(xGiantSwarmActivity *string)
SetXGiantSwarmActivity adds the xGiantSwarmActivity to the create auth token params
func (*CreateAuthTokenParams) SetXGiantSwarmCmdLine ¶
func (o *CreateAuthTokenParams) SetXGiantSwarmCmdLine(xGiantSwarmCmdLine *string)
SetXGiantSwarmCmdLine adds the xGiantSwarmCmdLine to the create auth token params
func (*CreateAuthTokenParams) SetXRequestID ¶
func (o *CreateAuthTokenParams) SetXRequestID(xRequestID *string)
SetXRequestID adds the xRequestId to the create auth token params
func (*CreateAuthTokenParams) WithBody ¶
func (o *CreateAuthTokenParams) WithBody(body *models.V4CreateAuthTokenRequest) *CreateAuthTokenParams
WithBody adds the body to the create auth token params
func (*CreateAuthTokenParams) WithContext ¶
func (o *CreateAuthTokenParams) WithContext(ctx context.Context) *CreateAuthTokenParams
WithContext adds the context to the create auth token params
func (*CreateAuthTokenParams) WithHTTPClient ¶
func (o *CreateAuthTokenParams) WithHTTPClient(client *http.Client) *CreateAuthTokenParams
WithHTTPClient adds the HTTPClient to the create auth token params
func (*CreateAuthTokenParams) WithTimeout ¶
func (o *CreateAuthTokenParams) WithTimeout(timeout time.Duration) *CreateAuthTokenParams
WithTimeout adds the timeout to the create auth token params
func (*CreateAuthTokenParams) WithXGiantSwarmActivity ¶
func (o *CreateAuthTokenParams) WithXGiantSwarmActivity(xGiantSwarmActivity *string) *CreateAuthTokenParams
WithXGiantSwarmActivity adds the xGiantSwarmActivity to the create auth token params
func (*CreateAuthTokenParams) WithXGiantSwarmCmdLine ¶
func (o *CreateAuthTokenParams) WithXGiantSwarmCmdLine(xGiantSwarmCmdLine *string) *CreateAuthTokenParams
WithXGiantSwarmCmdLine adds the xGiantSwarmCmdLine to the create auth token params
func (*CreateAuthTokenParams) WithXRequestID ¶
func (o *CreateAuthTokenParams) WithXRequestID(xRequestID *string) *CreateAuthTokenParams
WithXRequestID adds the xRequestID to the create auth token params
func (*CreateAuthTokenParams) WriteToRequest ¶
func (o *CreateAuthTokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type CreateAuthTokenReader ¶
type CreateAuthTokenReader struct {
// contains filtered or unexported fields
}
CreateAuthTokenReader is a Reader for the CreateAuthToken structure.
func (*CreateAuthTokenReader) ReadResponse ¶
func (o *CreateAuthTokenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type CreateAuthTokenUnauthorized ¶
type CreateAuthTokenUnauthorized struct {
}CreateAuthTokenUnauthorized handles this case with default header values.
Permission denied
func NewCreateAuthTokenUnauthorized ¶
func NewCreateAuthTokenUnauthorized() *CreateAuthTokenUnauthorized
NewCreateAuthTokenUnauthorized creates a CreateAuthTokenUnauthorized with default headers values
func (*CreateAuthTokenUnauthorized) Error ¶
func (o *CreateAuthTokenUnauthorized) Error() string
type DeleteAuthTokenOK ¶
type DeleteAuthTokenOK struct {
Payload *models.V4GenericResponse
}
DeleteAuthTokenOK handles this case with default header values.
Success
func NewDeleteAuthTokenOK ¶
func NewDeleteAuthTokenOK() *DeleteAuthTokenOK
NewDeleteAuthTokenOK creates a DeleteAuthTokenOK with default headers values
func (*DeleteAuthTokenOK) Error ¶
func (o *DeleteAuthTokenOK) Error() string
type DeleteAuthTokenParams ¶
type DeleteAuthTokenParams struct { /*XGiantSwarmActivity Name of an activity to track, like "list-clusters". This allows to analyze several API requests sent in context and gives an idea on the purpose. */ XGiantSwarmActivity *string /*XGiantSwarmCmdLine If activity has been issued by a CLI, this header can contain the command line */ XGiantSwarmCmdLine *string /*XRequestID A randomly generated key that can be used to track a request throughout services of Giant Swarm. */ XRequestID *string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
DeleteAuthTokenParams contains all the parameters to send to the API endpoint for the delete auth token operation typically these are written to a http.Request
func NewDeleteAuthTokenParams ¶
func NewDeleteAuthTokenParams() *DeleteAuthTokenParams
NewDeleteAuthTokenParams creates a new DeleteAuthTokenParams object with the default values initialized.
func NewDeleteAuthTokenParamsWithContext ¶
func NewDeleteAuthTokenParamsWithContext(ctx context.Context) *DeleteAuthTokenParams
NewDeleteAuthTokenParamsWithContext creates a new DeleteAuthTokenParams object with the default values initialized, and the ability to set a context for a request
func NewDeleteAuthTokenParamsWithHTTPClient ¶
func NewDeleteAuthTokenParamsWithHTTPClient(client *http.Client) *DeleteAuthTokenParams
NewDeleteAuthTokenParamsWithHTTPClient creates a new DeleteAuthTokenParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewDeleteAuthTokenParamsWithTimeout ¶
func NewDeleteAuthTokenParamsWithTimeout(timeout time.Duration) *DeleteAuthTokenParams
NewDeleteAuthTokenParamsWithTimeout creates a new DeleteAuthTokenParams object with the default values initialized, and the ability to set a timeout on a request
func (*DeleteAuthTokenParams) SetContext ¶
func (o *DeleteAuthTokenParams) SetContext(ctx context.Context)
SetContext adds the context to the delete auth token params
func (*DeleteAuthTokenParams) SetHTTPClient ¶
func (o *DeleteAuthTokenParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the delete auth token params
func (*DeleteAuthTokenParams) SetTimeout ¶
func (o *DeleteAuthTokenParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the delete auth token params
func (*DeleteAuthTokenParams) SetXGiantSwarmActivity ¶
func (o *DeleteAuthTokenParams) SetXGiantSwarmActivity(xGiantSwarmActivity *string)
SetXGiantSwarmActivity adds the xGiantSwarmActivity to the delete auth token params
func (*DeleteAuthTokenParams) SetXGiantSwarmCmdLine ¶
func (o *DeleteAuthTokenParams) SetXGiantSwarmCmdLine(xGiantSwarmCmdLine *string)
SetXGiantSwarmCmdLine adds the xGiantSwarmCmdLine to the delete auth token params
func (*DeleteAuthTokenParams) SetXRequestID ¶
func (o *DeleteAuthTokenParams) SetXRequestID(xRequestID *string)
SetXRequestID adds the xRequestId to the delete auth token params
func (*DeleteAuthTokenParams) WithContext ¶
func (o *DeleteAuthTokenParams) WithContext(ctx context.Context) *DeleteAuthTokenParams
WithContext adds the context to the delete auth token params
func (*DeleteAuthTokenParams) WithHTTPClient ¶
func (o *DeleteAuthTokenParams) WithHTTPClient(client *http.Client) *DeleteAuthTokenParams
WithHTTPClient adds the HTTPClient to the delete auth token params
func (*DeleteAuthTokenParams) WithTimeout ¶
func (o *DeleteAuthTokenParams) WithTimeout(timeout time.Duration) *DeleteAuthTokenParams
WithTimeout adds the timeout to the delete auth token params
func (*DeleteAuthTokenParams) WithXGiantSwarmActivity ¶
func (o *DeleteAuthTokenParams) WithXGiantSwarmActivity(xGiantSwarmActivity *string) *DeleteAuthTokenParams
WithXGiantSwarmActivity adds the xGiantSwarmActivity to the delete auth token params
func (*DeleteAuthTokenParams) WithXGiantSwarmCmdLine ¶
func (o *DeleteAuthTokenParams) WithXGiantSwarmCmdLine(xGiantSwarmCmdLine *string) *DeleteAuthTokenParams
WithXGiantSwarmCmdLine adds the xGiantSwarmCmdLine to the delete auth token params
func (*DeleteAuthTokenParams) WithXRequestID ¶
func (o *DeleteAuthTokenParams) WithXRequestID(xRequestID *string) *DeleteAuthTokenParams
WithXRequestID adds the xRequestID to the delete auth token params
func (*DeleteAuthTokenParams) WriteToRequest ¶
func (o *DeleteAuthTokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type DeleteAuthTokenReader ¶
type DeleteAuthTokenReader struct {
// contains filtered or unexported fields
}
DeleteAuthTokenReader is a Reader for the DeleteAuthToken structure.
func (*DeleteAuthTokenReader) ReadResponse ¶
func (o *DeleteAuthTokenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type DeleteAuthTokenUnauthorized ¶
type DeleteAuthTokenUnauthorized struct {
}DeleteAuthTokenUnauthorized handles this case with default header values.
Permission denied
func NewDeleteAuthTokenUnauthorized ¶
func NewDeleteAuthTokenUnauthorized() *DeleteAuthTokenUnauthorized
NewDeleteAuthTokenUnauthorized creates a DeleteAuthTokenUnauthorized with default headers values
func (*DeleteAuthTokenUnauthorized) Error ¶
func (o *DeleteAuthTokenUnauthorized) Error() string