Documentation
¶
Index ¶
- type AuthCheckForbidden
- type AuthCheckInternalServerError
- type AuthCheckOK
- type AuthCheckParams
- func (o *AuthCheckParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
- func (o *AuthCheckParams) SetContext(ctx context.Context)
- func (o *AuthCheckParams) SetFlightId(flightId string)
- func (o *AuthCheckParams) SetHTTPClient(client *http.Client)
- func (o *AuthCheckParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
- func (o *AuthCheckParams) SetTimeout(timeout time.Duration)
- func (o *AuthCheckParams) WithContext(ctx context.Context) *AuthCheckParams
- func (o *AuthCheckParams) WithHTTPClient(client *http.Client) *AuthCheckParams
- func (o *AuthCheckParams) WithTimeout(timeout time.Duration) *AuthCheckParams
- func (o *AuthCheckParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type AuthCheckReader
- type AuthCheckUnauthorized
- type Client
- func (a *Client) AuthCheck(params *AuthCheckParams, authInfo runtime.ClientAuthInfoWriter) (*AuthCheckOK, *AuthCheckUnauthorized, *AuthCheckForbidden, ...)deprecated
- func (a *Client) AuthCheckShort(params *AuthCheckParams, authInfo runtime.ClientAuthInfoWriter) (*AuthCheckOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type ClientService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthCheckForbidden ¶
type AuthCheckForbidden struct {
Payload *amsclientmodels.ResponseErrorResponse
}
AuthCheckForbidden handles this case with default header values.
forbidden
func NewAuthCheckForbidden ¶
func NewAuthCheckForbidden() *AuthCheckForbidden
NewAuthCheckForbidden creates a AuthCheckForbidden with default headers values
func (*AuthCheckForbidden) Error ¶
func (o *AuthCheckForbidden) Error() string
func (*AuthCheckForbidden) GetPayload ¶
func (o *AuthCheckForbidden) GetPayload() *amsclientmodels.ResponseErrorResponse
func (*AuthCheckForbidden) ToJSONString ¶
func (o *AuthCheckForbidden) ToJSONString() string
type AuthCheckInternalServerError ¶
type AuthCheckInternalServerError struct {
Payload *amsclientmodels.ResponseErrorResponse
}
AuthCheckInternalServerError handles this case with default header values.
internal server error
func NewAuthCheckInternalServerError ¶
func NewAuthCheckInternalServerError() *AuthCheckInternalServerError
NewAuthCheckInternalServerError creates a AuthCheckInternalServerError with default headers values
func (*AuthCheckInternalServerError) Error ¶
func (o *AuthCheckInternalServerError) Error() string
func (*AuthCheckInternalServerError) GetPayload ¶
func (o *AuthCheckInternalServerError) GetPayload() *amsclientmodels.ResponseErrorResponse
func (*AuthCheckInternalServerError) ToJSONString ¶
func (o *AuthCheckInternalServerError) ToJSONString() string
type AuthCheckOK ¶
type AuthCheckOK struct {
}
AuthCheckOK handles this case with default header values.
success
func NewAuthCheckOK ¶
func NewAuthCheckOK() *AuthCheckOK
NewAuthCheckOK creates a AuthCheckOK with default headers values
func (*AuthCheckOK) Error ¶
func (o *AuthCheckOK) Error() string
type AuthCheckParams ¶
type AuthCheckParams struct {
/*RetryPolicy*/
RetryPolicy *utils.Retry
AuthInfoWriter runtime.ClientAuthInfoWriter
Context context.Context
HTTPClient *http.Client
// XFlightId is an optional parameter from this SDK
XFlightId *string
// contains filtered or unexported fields
}
AuthCheckParams contains all the parameters to send to the API endpoint for the auth check operation typically these are written to a http.Request
func NewAuthCheckParams ¶
func NewAuthCheckParams() *AuthCheckParams
NewAuthCheckParams creates a new AuthCheckParams object with the default values initialized.
func NewAuthCheckParamsWithContext ¶
func NewAuthCheckParamsWithContext(ctx context.Context) *AuthCheckParams
NewAuthCheckParamsWithContext creates a new AuthCheckParams object with the default values initialized, and the ability to set a context for a request
func NewAuthCheckParamsWithHTTPClient ¶
func NewAuthCheckParamsWithHTTPClient(client *http.Client) *AuthCheckParams
NewAuthCheckParamsWithHTTPClient creates a new AuthCheckParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewAuthCheckParamsWithTimeout ¶
func NewAuthCheckParamsWithTimeout(timeout time.Duration) *AuthCheckParams
NewAuthCheckParamsWithTimeout creates a new AuthCheckParams object with the default values initialized, and the ability to set a timeout on a request
func (*AuthCheckParams) SetAuthInfoWriter ¶
func (o *AuthCheckParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
SetAuthInfoWriter adds the authInfoWriter to the auth check params
func (*AuthCheckParams) SetContext ¶
func (o *AuthCheckParams) SetContext(ctx context.Context)
SetContext adds the context to the auth check params
func (*AuthCheckParams) SetFlightId ¶
func (o *AuthCheckParams) SetFlightId(flightId string)
SetFlightId adds the flightId as the header value for this specific endpoint
func (*AuthCheckParams) SetHTTPClient ¶
func (o *AuthCheckParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the auth check params
func (*AuthCheckParams) SetHTTPClientTransport ¶
func (o *AuthCheckParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
SetHTTPClient adds the HTTPClient Transport to the auth check params
func (*AuthCheckParams) SetTimeout ¶
func (o *AuthCheckParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the auth check params
func (*AuthCheckParams) WithContext ¶
func (o *AuthCheckParams) WithContext(ctx context.Context) *AuthCheckParams
WithContext adds the context to the auth check params
func (*AuthCheckParams) WithHTTPClient ¶
func (o *AuthCheckParams) WithHTTPClient(client *http.Client) *AuthCheckParams
WithHTTPClient adds the HTTPClient to the auth check params
func (*AuthCheckParams) WithTimeout ¶
func (o *AuthCheckParams) WithTimeout(timeout time.Duration) *AuthCheckParams
WithTimeout adds the timeout to the auth check params
func (*AuthCheckParams) WriteToRequest ¶
func (o *AuthCheckParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type AuthCheckReader ¶
type AuthCheckReader struct {
// contains filtered or unexported fields
}
AuthCheckReader is a Reader for the AuthCheck structure.
func (*AuthCheckReader) ReadResponse ¶
func (o *AuthCheckReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type AuthCheckUnauthorized ¶
type AuthCheckUnauthorized struct {
}
AuthCheckUnauthorized handles this case with default header values.
unauthorized
func NewAuthCheckUnauthorized ¶
func NewAuthCheckUnauthorized() *AuthCheckUnauthorized
NewAuthCheckUnauthorized creates a AuthCheckUnauthorized with default headers values
func (*AuthCheckUnauthorized) Error ¶
func (o *AuthCheckUnauthorized) Error() string
func (*AuthCheckUnauthorized) GetPayload ¶
func (o *AuthCheckUnauthorized) GetPayload() *amsclientmodels.ResponseErrorResponse
func (*AuthCheckUnauthorized) ToJSONString ¶
func (o *AuthCheckUnauthorized) ToJSONString() string
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for auth API
func (*Client) AuthCheck
deprecated
func (a *Client) AuthCheck(params *AuthCheckParams, authInfo runtime.ClientAuthInfoWriter) (*AuthCheckOK, *AuthCheckUnauthorized, *AuthCheckForbidden, *AuthCheckInternalServerError, error)
Deprecated: 2022-08-10 - Use AuthCheckShort instead.
AuthCheck checks if fleet commander can auth with ams Check if fleet commander is authorized to talk to AMS with this IAM
func (*Client) AuthCheckShort ¶
func (a *Client) AuthCheckShort(params *AuthCheckParams, authInfo runtime.ClientAuthInfoWriter) (*AuthCheckOK, error)
AuthCheckShort checks if fleet commander can auth with ams Check if fleet commander is authorized to talk to AMS with this IAM
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶
type ClientService interface {
AuthCheck(params *AuthCheckParams, authInfo runtime.ClientAuthInfoWriter) (*AuthCheckOK, *AuthCheckUnauthorized, *AuthCheckForbidden, *AuthCheckInternalServerError, error)
AuthCheckShort(params *AuthCheckParams, authInfo runtime.ClientAuthInfoWriter) (*AuthCheckOK, 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 auth API client.
Source Files