Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type HealthCheckOK
- func (o *HealthCheckOK) Code() int
- func (o *HealthCheckOK) Error() string
- func (o *HealthCheckOK) GetPayload() *models.HealthCheckResponse
- func (o *HealthCheckOK) IsClientError() bool
- func (o *HealthCheckOK) IsCode(code int) bool
- func (o *HealthCheckOK) IsRedirect() bool
- func (o *HealthCheckOK) IsServerError() bool
- func (o *HealthCheckOK) IsSuccess() bool
- func (o *HealthCheckOK) String() string
- type HealthCheckParams
- func (o *HealthCheckParams) SetContext(ctx context.Context)
- func (o *HealthCheckParams) SetDefaults()
- func (o *HealthCheckParams) SetHTTPClient(client *http.Client)
- func (o *HealthCheckParams) SetTimeout(timeout time.Duration)
- func (o *HealthCheckParams) WithContext(ctx context.Context) *HealthCheckParams
- func (o *HealthCheckParams) WithDefaults() *HealthCheckParams
- func (o *HealthCheckParams) WithHTTPClient(client *http.Client) *HealthCheckParams
- func (o *HealthCheckParams) WithTimeout(timeout time.Duration) *HealthCheckParams
- func (o *HealthCheckParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type HealthCheckReader
- type HealthCheckUnauthorized
- func (o *HealthCheckUnauthorized) Code() int
- func (o *HealthCheckUnauthorized) Error() string
- func (o *HealthCheckUnauthorized) IsClientError() bool
- func (o *HealthCheckUnauthorized) IsCode(code int) bool
- func (o *HealthCheckUnauthorized) IsRedirect() bool
- func (o *HealthCheckUnauthorized) IsServerError() bool
- func (o *HealthCheckUnauthorized) IsSuccess() bool
- func (o *HealthCheckUnauthorized) String() string
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 health check API
func (*Client) HealthCheck ¶
func (a *Client) HealthCheck(params *HealthCheckParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*HealthCheckOK, error)
HealthCheck returns a status and current date time
Returns a status and current date/time
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 is the option for Client methods
type ClientService ¶
type ClientService interface {
HealthCheck(params *HealthCheckParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*HealthCheckOK, 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 health check API client.
type HealthCheckOK ¶
type HealthCheckOK struct {
Payload *models.HealthCheckResponse
}
HealthCheckOK describes a response with status code 200, with default header values.
OK
func NewHealthCheckOK ¶
func NewHealthCheckOK() *HealthCheckOK
NewHealthCheckOK creates a HealthCheckOK with default headers values
func (*HealthCheckOK) Code ¶
func (o *HealthCheckOK) Code() int
Code gets the status code for the health check o k response
func (*HealthCheckOK) Error ¶
func (o *HealthCheckOK) Error() string
func (*HealthCheckOK) GetPayload ¶
func (o *HealthCheckOK) GetPayload() *models.HealthCheckResponse
func (*HealthCheckOK) IsClientError ¶
func (o *HealthCheckOK) IsClientError() bool
IsClientError returns true when this health check o k response has a 4xx status code
func (*HealthCheckOK) IsCode ¶
func (o *HealthCheckOK) IsCode(code int) bool
IsCode returns true when this health check o k response a status code equal to that given
func (*HealthCheckOK) IsRedirect ¶
func (o *HealthCheckOK) IsRedirect() bool
IsRedirect returns true when this health check o k response has a 3xx status code
func (*HealthCheckOK) IsServerError ¶
func (o *HealthCheckOK) IsServerError() bool
IsServerError returns true when this health check o k response has a 5xx status code
func (*HealthCheckOK) IsSuccess ¶
func (o *HealthCheckOK) IsSuccess() bool
IsSuccess returns true when this health check o k response has a 2xx status code
func (*HealthCheckOK) String ¶
func (o *HealthCheckOK) String() string
type HealthCheckParams ¶
type HealthCheckParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
HealthCheckParams contains all the parameters to send to the API endpoint
for the health check operation. Typically these are written to a http.Request.
func NewHealthCheckParams ¶
func NewHealthCheckParams() *HealthCheckParams
NewHealthCheckParams creates a new HealthCheckParams 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 NewHealthCheckParamsWithContext ¶
func NewHealthCheckParamsWithContext(ctx context.Context) *HealthCheckParams
NewHealthCheckParamsWithContext creates a new HealthCheckParams object with the ability to set a context for a request.
func NewHealthCheckParamsWithHTTPClient ¶
func NewHealthCheckParamsWithHTTPClient(client *http.Client) *HealthCheckParams
NewHealthCheckParamsWithHTTPClient creates a new HealthCheckParams object with the ability to set a custom HTTPClient for a request.
func NewHealthCheckParamsWithTimeout ¶
func NewHealthCheckParamsWithTimeout(timeout time.Duration) *HealthCheckParams
NewHealthCheckParamsWithTimeout creates a new HealthCheckParams object with the ability to set a timeout on a request.
func (*HealthCheckParams) SetContext ¶
func (o *HealthCheckParams) SetContext(ctx context.Context)
SetContext adds the context to the health check params
func (*HealthCheckParams) SetDefaults ¶
func (o *HealthCheckParams) SetDefaults()
SetDefaults hydrates default values in the health check params (not the query body).
All values with no default are reset to their zero value.
func (*HealthCheckParams) SetHTTPClient ¶
func (o *HealthCheckParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the health check params
func (*HealthCheckParams) SetTimeout ¶
func (o *HealthCheckParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the health check params
func (*HealthCheckParams) WithContext ¶
func (o *HealthCheckParams) WithContext(ctx context.Context) *HealthCheckParams
WithContext adds the context to the health check params
func (*HealthCheckParams) WithDefaults ¶
func (o *HealthCheckParams) WithDefaults() *HealthCheckParams
WithDefaults hydrates default values in the health check params (not the query body).
All values with no default are reset to their zero value.
func (*HealthCheckParams) WithHTTPClient ¶
func (o *HealthCheckParams) WithHTTPClient(client *http.Client) *HealthCheckParams
WithHTTPClient adds the HTTPClient to the health check params
func (*HealthCheckParams) WithTimeout ¶
func (o *HealthCheckParams) WithTimeout(timeout time.Duration) *HealthCheckParams
WithTimeout adds the timeout to the health check params
func (*HealthCheckParams) WriteToRequest ¶
func (o *HealthCheckParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type HealthCheckReader ¶
type HealthCheckReader struct {
// contains filtered or unexported fields
}
HealthCheckReader is a Reader for the HealthCheck structure.
func (*HealthCheckReader) ReadResponse ¶
func (o *HealthCheckReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type HealthCheckUnauthorized ¶
type HealthCheckUnauthorized struct {
}
HealthCheckUnauthorized describes a response with status code 401, with default header values.
Access Denied
func NewHealthCheckUnauthorized ¶
func NewHealthCheckUnauthorized() *HealthCheckUnauthorized
NewHealthCheckUnauthorized creates a HealthCheckUnauthorized with default headers values
func (*HealthCheckUnauthorized) Code ¶
func (o *HealthCheckUnauthorized) Code() int
Code gets the status code for the health check unauthorized response
func (*HealthCheckUnauthorized) Error ¶
func (o *HealthCheckUnauthorized) Error() string
func (*HealthCheckUnauthorized) IsClientError ¶
func (o *HealthCheckUnauthorized) IsClientError() bool
IsClientError returns true when this health check unauthorized response has a 4xx status code
func (*HealthCheckUnauthorized) IsCode ¶
func (o *HealthCheckUnauthorized) IsCode(code int) bool
IsCode returns true when this health check unauthorized response a status code equal to that given
func (*HealthCheckUnauthorized) IsRedirect ¶
func (o *HealthCheckUnauthorized) IsRedirect() bool
IsRedirect returns true when this health check unauthorized response has a 3xx status code
func (*HealthCheckUnauthorized) IsServerError ¶
func (o *HealthCheckUnauthorized) IsServerError() bool
IsServerError returns true when this health check unauthorized response has a 5xx status code
func (*HealthCheckUnauthorized) IsSuccess ¶
func (o *HealthCheckUnauthorized) IsSuccess() bool
IsSuccess returns true when this health check unauthorized response has a 2xx status code
func (*HealthCheckUnauthorized) String ¶
func (o *HealthCheckUnauthorized) String() string
Source Files