health

Documentation

Index

• type Client
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
  • func (a *Client) Health(params *HealthParams) (*HealthOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type HealthDefault
  • func NewHealthDefault(code int) *HealthDefault
  • func (o *HealthDefault) Code() int
  • func (o *HealthDefault) Error() string
• type HealthOK
  • func NewHealthOK() *HealthOK
  • func (o *HealthOK) Error() string
• type HealthParams
  • func NewHealthParams() *HealthParams
  • func NewHealthParamsWithContext(ctx context.Context) *HealthParams
  • func NewHealthParamsWithHTTPClient(client *http.Client) *HealthParams
  • func NewHealthParamsWithTimeout(timeout time.Duration) *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
  • func (o *HealthReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type Client

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

Client for health API

func New

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

New creates a new health API client.

func (*Client) Health

func (a *Client) Health(params *HealthParams) (*HealthOK, error)

Health us n v e r s i o n e d health check endpoint required for all services

Performs detailed internal checks and reports back whether or not the service is operating properly https://confluence.splunk.com/display/PROD/Common+Microservice+Endpoints+and+Version+Management

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type HealthDefault

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

HealthDefault handles this case with default header values.

Unexpected error

func NewHealthDefault

func NewHealthDefault(code int) *HealthDefault

NewHealthDefault creates a HealthDefault with default headers values

func (*HealthDefault) Code

func (o *HealthDefault) Code() int

Code gets the status code for the health default response

func (*HealthDefault) Error

func (o *HealthDefault) Error() string

type HealthOK

type HealthOK struct {
	Payload *models.Health
}

HealthOK handles this case with default header values.

Service is operating normally

func NewHealthOK

func NewHealthOK() *HealthOK

NewHealthOK creates a HealthOK with default headers values

func (*HealthOK) Error

func (o *HealthOK) Error() string

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.