healthz

Documentation

Index

• type Client
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
  • func (a *Client) GetHealthz(params *GetHealthzParams) (*GetHealthzOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type GetHealthzDefault
  • func NewGetHealthzDefault(code int) *GetHealthzDefault
  • func (o *GetHealthzDefault) Code() int
  • func (o *GetHealthzDefault) Error() string
• type GetHealthzOK
  • func NewGetHealthzOK() *GetHealthzOK
  • func (o *GetHealthzOK) Error() string
• type GetHealthzParams
  • func NewGetHealthzParams() *GetHealthzParams
  • func NewGetHealthzParamsWithContext(ctx context.Context) *GetHealthzParams
  • func NewGetHealthzParamsWithHTTPClient(client *http.Client) *GetHealthzParams
  • func NewGetHealthzParamsWithTimeout(timeout time.Duration) *GetHealthzParams
  • func (o *GetHealthzParams) SetContext(ctx context.Context)
  • func (o *GetHealthzParams) SetHTTPClient(client *http.Client)
  • func (o *GetHealthzParams) SetTimeout(timeout time.Duration)
  • func (o *GetHealthzParams) WithContext(ctx context.Context) *GetHealthzParams
  • func (o *GetHealthzParams) WithHTTPClient(client *http.Client) *GetHealthzParams
  • func (o *GetHealthzParams) WithTimeout(timeout time.Duration) *GetHealthzParams
  • func (o *GetHealthzParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type GetHealthzReader
  • func (o *GetHealthzReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for healthz API

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client

New creates a new healthz API client.

func (*Client) GetHealthz

func (a *Client) GetHealthz(params *GetHealthzParams) (*GetHealthzOK, error)

GetHealthz returns the health of the application

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type GetHealthzDefault

type GetHealthzDefault struct {
	Payload *models.Error
	// contains filtered or unexported fields
}

GetHealthzDefault handles this case with default header values.

unexpected error

func NewGetHealthzDefault

func NewGetHealthzDefault(code int) *GetHealthzDefault

NewGetHealthzDefault creates a GetHealthzDefault with default headers values

func (*GetHealthzDefault) Code

func (o *GetHealthzDefault) Code() int

Code gets the status code for the get healthz default response

func (*GetHealthzDefault) Error

func (o *GetHealthzDefault) Error() string

type GetHealthzOK

type GetHealthzOK struct {
}

GetHealthzOK handles this case with default header values.

The response indicating that the application is healthy.

func NewGetHealthzOK

func NewGetHealthzOK() *GetHealthzOK

NewGetHealthzOK creates a GetHealthzOK with default headers values

func (*GetHealthzOK) Error

func (o *GetHealthzOK) Error() string

type GetHealthzParams

type GetHealthzParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetHealthzParams contains all the parameters to send to the API endpoint for the get healthz operation typically these are written to a http.Request

func NewGetHealthzParams

func NewGetHealthzParams() *GetHealthzParams

NewGetHealthzParams creates a new GetHealthzParams object with the default values initialized.

func NewGetHealthzParamsWithContext

func NewGetHealthzParamsWithContext(ctx context.Context) *GetHealthzParams

NewGetHealthzParamsWithContext creates a new GetHealthzParams object with the default values initialized, and the ability to set a context for a request

func NewGetHealthzParamsWithHTTPClient

func NewGetHealthzParamsWithHTTPClient(client *http.Client) *GetHealthzParams

NewGetHealthzParamsWithHTTPClient creates a new GetHealthzParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetHealthzParamsWithTimeout

func NewGetHealthzParamsWithTimeout(timeout time.Duration) *GetHealthzParams

NewGetHealthzParamsWithTimeout creates a new GetHealthzParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetHealthzParams) SetContext

func (o *GetHealthzParams) SetContext(ctx context.Context)

SetContext adds the context to the get healthz params

func (*GetHealthzParams) SetHTTPClient

func (o *GetHealthzParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get healthz params

func (*GetHealthzParams) SetTimeout

func (o *GetHealthzParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get healthz params

func (*GetHealthzParams) WithContext

func (o *GetHealthzParams) WithContext(ctx context.Context) *GetHealthzParams

WithContext adds the context to the get healthz params

func (*GetHealthzParams) WithHTTPClient

func (o *GetHealthzParams) WithHTTPClient(client *http.Client) *GetHealthzParams

WithHTTPClient adds the HTTPClient to the get healthz params

func (*GetHealthzParams) WithTimeout

func (o *GetHealthzParams) WithTimeout(timeout time.Duration) *GetHealthzParams

WithTimeout adds the timeout to the get healthz params

func (*GetHealthzParams) WriteToRequest

func (o *GetHealthzParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetHealthzReader

type GetHealthzReader struct {
	// contains filtered or unexported fields
}

GetHealthzReader is a Reader for the GetHealthz structure.

func (*GetHealthzReader) ReadResponse

func (o *GetHealthzReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.