Documentation
¶
Index ¶
- type Client
- type ClientService
- type HealthInternalServerError
- type HealthOK
- type HealthParams
- func (o *HealthParams) SetContext(ctx context.Context)
- func (o *HealthParams) SetHTTPClient(client *http.Client)
- func (o *HealthParams) SetTimeout(timeout time.Duration)
- func (o *HealthParams) WithContext(ctx context.Context) *HealthParams
- func (o *HealthParams) WithHTTPClient(client *http.Client) *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) (*HealthOK, error)
Health performs a healthcheck
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶ added in v0.11.0
type ClientService interface {
Health(params *HealthParams, authInfo runtime.ClientAuthInfoWriter) (*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 HealthInternalServerError ¶
type HealthInternalServerError struct {
Payload *models.RestStatus
}
HealthInternalServerError handles this case 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.RestStatus
type HealthOK ¶
type HealthOK struct {
Payload *models.RestStatus
}
HealthOK handles this case 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.RestStatus
type HealthParams ¶
type HealthParams struct {
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 values initialized.
func NewHealthParamsWithContext ¶
func NewHealthParamsWithContext(ctx context.Context) *HealthParams
NewHealthParamsWithContext creates a new HealthParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) SetHTTPClient ¶
func (o *HealthParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient 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) WithHTTPClient ¶
func (o *HealthParams) WithHTTPClient(client *http.Client) *HealthParams
WithHTTPClient adds the HTTPClient 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