Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type HealthDefault
- type HealthInternalServerError
- type HealthOK
- type HealthParams
- func (o *HealthParams) SetContext(ctx context.Context)
- func (o *HealthParams) SetDefaults()
- func (o *HealthParams) SetHTTPClient(client *http.Client)
- func (o *HealthParams) SetService(service *string)
- func (o *HealthParams) SetTimeout(timeout time.Duration)
- func (o *HealthParams) WithContext(ctx context.Context) *HealthParams
- func (o *HealthParams) WithDefaults() *HealthParams
- func (o *HealthParams) WithHTTPClient(client *http.Client) *HealthParams
- func (o *HealthParams) WithService(service *string) *HealthParams
- func (o *HealthParams) WithTimeout(timeout time.Duration) *HealthParams
- func (o *HealthParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type HealthReader
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 API
func (*Client) Health ¶
func (a *Client) Health(params *HealthParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*HealthOK, error)
Health performs a healthcheck
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientOption ¶ added in v0.13.1
type ClientOption func(*runtime.ClientOperation)
ClientOption is the option for Client methods
type ClientService ¶ added in v0.11.0
type ClientService interface {
Health(params *HealthParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*HealthOK, 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 API client.
type HealthDefault ¶ added in v0.15.7
type HealthDefault struct {
Payload *httperrors.HTTPErrorResponse
// contains filtered or unexported fields
}
HealthDefault describes a response with status code -1, with default header values.
Error
func NewHealthDefault ¶ added in v0.15.7
func NewHealthDefault(code int) *HealthDefault
NewHealthDefault creates a HealthDefault with default headers values
func (*HealthDefault) Code ¶ added in v0.15.7
func (o *HealthDefault) Code() int
Code gets the status code for the health default response
func (*HealthDefault) Error ¶ added in v0.15.7
func (o *HealthDefault) Error() string
func (*HealthDefault) GetPayload ¶ added in v0.15.7
func (o *HealthDefault) GetPayload() *httperrors.HTTPErrorResponse
type HealthInternalServerError ¶
type HealthInternalServerError struct {
Payload *models.RestHealthResponse
}
HealthInternalServerError describes a response with status code 500, with default header values.
Unhealthy
func NewHealthInternalServerError ¶
func NewHealthInternalServerError() *HealthInternalServerError
NewHealthInternalServerError creates a HealthInternalServerError with default headers values
func (*HealthInternalServerError) Error ¶
func (o *HealthInternalServerError) Error() string
func (*HealthInternalServerError) GetPayload ¶ added in v0.11.0
func (o *HealthInternalServerError) GetPayload() *models.RestHealthResponse
type HealthOK ¶
type HealthOK struct {
Payload *models.RestHealthResponse
}
HealthOK describes a response with status code 200, with default header values.
OK
func NewHealthOK ¶
func NewHealthOK() *HealthOK
NewHealthOK creates a HealthOK with default headers values
func (*HealthOK) GetPayload ¶ added in v0.11.0
func (o *HealthOK) GetPayload() *models.RestHealthResponse
type HealthParams ¶
type HealthParams struct {
/* Service.
return health for this specific service only
*/
Service *string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
HealthParams contains all the parameters to send to the API endpoint
for the health operation. Typically these are written to a http.Request.
func NewHealthParams ¶
func NewHealthParams() *HealthParams
NewHealthParams creates a new HealthParams 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 NewHealthParamsWithContext ¶
func NewHealthParamsWithContext(ctx context.Context) *HealthParams
NewHealthParamsWithContext creates a new HealthParams object with the ability to set a context for a request.
func NewHealthParamsWithHTTPClient ¶
func NewHealthParamsWithHTTPClient(client *http.Client) *HealthParams
NewHealthParamsWithHTTPClient creates a new HealthParams object with the ability to set a custom HTTPClient for a request.
func NewHealthParamsWithTimeout ¶
func NewHealthParamsWithTimeout(timeout time.Duration) *HealthParams
NewHealthParamsWithTimeout creates a new HealthParams object with the ability to set a timeout on a request.
func (*HealthParams) SetContext ¶
func (o *HealthParams) SetContext(ctx context.Context)
SetContext adds the context to the health params
func (*HealthParams) SetDefaults ¶ added in v0.12.1
func (o *HealthParams) SetDefaults()
SetDefaults hydrates default values in the health params (not the query body).
All values with no default are reset to their zero value.
func (*HealthParams) SetHTTPClient ¶
func (o *HealthParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the health params
func (*HealthParams) SetService ¶ added in v0.16.3
func (o *HealthParams) SetService(service *string)
SetService adds the service to the health params
func (*HealthParams) SetTimeout ¶
func (o *HealthParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the health params
func (*HealthParams) WithContext ¶
func (o *HealthParams) WithContext(ctx context.Context) *HealthParams
WithContext adds the context to the health params
func (*HealthParams) WithDefaults ¶ added in v0.12.1
func (o *HealthParams) WithDefaults() *HealthParams
WithDefaults hydrates default values in the health params (not the query body).
All values with no default are reset to their zero value.
func (*HealthParams) WithHTTPClient ¶
func (o *HealthParams) WithHTTPClient(client *http.Client) *HealthParams
WithHTTPClient adds the HTTPClient to the health params
func (*HealthParams) WithService ¶ added in v0.16.3
func (o *HealthParams) WithService(service *string) *HealthParams
WithService adds the service to the health params
func (*HealthParams) WithTimeout ¶
func (o *HealthParams) WithTimeout(timeout time.Duration) *HealthParams
WithTimeout adds the timeout to the health params
func (*HealthParams) WriteToRequest ¶
func (o *HealthParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type HealthReader ¶
type HealthReader struct {
// contains filtered or unexported fields
}
HealthReader is a Reader for the Health structure.
func (*HealthReader) ReadResponse ¶
func (o *HealthReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files