health

Documentation

Index

• type Client
  • func (a *Client) GetHealth(params *GetHealthParams, opts ...ClientOption) (*GetHealthOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type ClientOption
• type ClientService
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
  • func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService
  • func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService
• type GetHealthInternalServerError
  • func NewGetHealthInternalServerError() *GetHealthInternalServerError
  • func (o *GetHealthInternalServerError) Code() int
  • func (o *GetHealthInternalServerError) Error() string
  • func (o *GetHealthInternalServerError) GetPayload() *models.Health
  • func (o *GetHealthInternalServerError) IsClientError() bool
  • func (o *GetHealthInternalServerError) IsCode(code int) bool
  • func (o *GetHealthInternalServerError) IsRedirect() bool
  • func (o *GetHealthInternalServerError) IsServerError() bool
  • func (o *GetHealthInternalServerError) IsSuccess() bool
  • func (o *GetHealthInternalServerError) String() string
• type GetHealthOK
  • func NewGetHealthOK() *GetHealthOK
  • func (o *GetHealthOK) Code() int
  • func (o *GetHealthOK) Error() string
  • func (o *GetHealthOK) GetPayload() *models.Health
  • func (o *GetHealthOK) IsClientError() bool
  • func (o *GetHealthOK) IsCode(code int) bool
  • func (o *GetHealthOK) IsRedirect() bool
  • func (o *GetHealthOK) IsServerError() bool
  • func (o *GetHealthOK) IsSuccess() bool
  • func (o *GetHealthOK) String() string
• type GetHealthParams
  • func NewGetHealthParams() *GetHealthParams
  • func NewGetHealthParamsWithContext(ctx context.Context) *GetHealthParams
  • func NewGetHealthParamsWithHTTPClient(client *http.Client) *GetHealthParams
  • func NewGetHealthParamsWithTimeout(timeout time.Duration) *GetHealthParams
  • func (o *GetHealthParams) SetContext(ctx context.Context)
  • func (o *GetHealthParams) SetDefaults()
  • func (o *GetHealthParams) SetHTTPClient(client *http.Client)
  • func (o *GetHealthParams) SetTimeout(timeout time.Duration)
  • func (o *GetHealthParams) WithContext(ctx context.Context) *GetHealthParams
  • func (o *GetHealthParams) WithDefaults() *GetHealthParams
  • func (o *GetHealthParams) WithHTTPClient(client *http.Client) *GetHealthParams
  • func (o *GetHealthParams) WithTimeout(timeout time.Duration) *GetHealthParams
  • func (o *GetHealthParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type GetHealthReader
  • func (o *GetHealthReader) 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 (*Client) GetHealth

func (a *Client) GetHealth(params *GetHealthParams, opts ...ClientOption) (*GetHealthOK, error)

GetHealth gets health information

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 may be used to customize the behavior of Client methods.

type ClientService

type ClientService interface {
	GetHealth(params *GetHealthParams, opts ...ClientOption) (*GetHealthOK, 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.

func NewClientWithBasicAuth

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new health API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new health API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type GetHealthInternalServerError

type GetHealthInternalServerError struct {
	Payload *models.Health
}

GetHealthInternalServerError describes a response with status code 500, with default header values.

Ok

func NewGetHealthInternalServerError

func NewGetHealthInternalServerError() *GetHealthInternalServerError

NewGetHealthInternalServerError creates a GetHealthInternalServerError with default headers values

func (*GetHealthInternalServerError) Code

func (o *GetHealthInternalServerError) Code() int

Code gets the status code for the get health internal server error response

func (*GetHealthInternalServerError) Error

func (o *GetHealthInternalServerError) Error() string

func (*GetHealthInternalServerError) GetPayload

func (o *GetHealthInternalServerError) GetPayload() *models.Health

func (*GetHealthInternalServerError) IsClientError

func (o *GetHealthInternalServerError) IsClientError() bool

IsClientError returns true when this get health internal server error response has a 4xx status code

func (*GetHealthInternalServerError) IsCode

func (o *GetHealthInternalServerError) IsCode(code int) bool

IsCode returns true when this get health internal server error response a status code equal to that given

func (*GetHealthInternalServerError) IsRedirect

func (o *GetHealthInternalServerError) IsRedirect() bool

IsRedirect returns true when this get health internal server error response has a 3xx status code

func (*GetHealthInternalServerError) IsServerError

func (o *GetHealthInternalServerError) IsServerError() bool

IsServerError returns true when this get health internal server error response has a 5xx status code

func (*GetHealthInternalServerError) IsSuccess

func (o *GetHealthInternalServerError) IsSuccess() bool

IsSuccess returns true when this get health internal server error response has a 2xx status code

func (*GetHealthInternalServerError) String

func (o *GetHealthInternalServerError) String() string

type GetHealthOK

type GetHealthOK struct {
	Payload *models.Health
}

GetHealthOK describes a response with status code 200, with default header values.

Ok

func NewGetHealthOK

func NewGetHealthOK() *GetHealthOK

NewGetHealthOK creates a GetHealthOK with default headers values

func (*GetHealthOK) Code

func (o *GetHealthOK) Code() int

Code gets the status code for the get health o k response

func (*GetHealthOK) Error

func (o *GetHealthOK) Error() string

func (*GetHealthOK) GetPayload

func (o *GetHealthOK) GetPayload() *models.Health

func (*GetHealthOK) IsClientError

func (o *GetHealthOK) IsClientError() bool

IsClientError returns true when this get health o k response has a 4xx status code

func (*GetHealthOK) IsCode

func (o *GetHealthOK) IsCode(code int) bool

IsCode returns true when this get health o k response a status code equal to that given

func (*GetHealthOK) IsRedirect

func (o *GetHealthOK) IsRedirect() bool

IsRedirect returns true when this get health o k response has a 3xx status code

func (*GetHealthOK) IsServerError

func (o *GetHealthOK) IsServerError() bool

IsServerError returns true when this get health o k response has a 5xx status code

func (*GetHealthOK) IsSuccess

func (o *GetHealthOK) IsSuccess() bool

IsSuccess returns true when this get health o k response has a 2xx status code

func (*GetHealthOK) String

func (o *GetHealthOK) String() string

type GetHealthParams

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

GetHealthParams contains all the parameters to send to the API endpoint

for the get health operation.

Typically these are written to a http.Request.

func NewGetHealthParams

func NewGetHealthParams() *GetHealthParams

NewGetHealthParams creates a new GetHealthParams 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 NewGetHealthParamsWithContext

func NewGetHealthParamsWithContext(ctx context.Context) *GetHealthParams

NewGetHealthParamsWithContext creates a new GetHealthParams object with the ability to set a context for a request.

func NewGetHealthParamsWithHTTPClient

func NewGetHealthParamsWithHTTPClient(client *http.Client) *GetHealthParams

NewGetHealthParamsWithHTTPClient creates a new GetHealthParams object with the ability to set a custom HTTPClient for a request.

func NewGetHealthParamsWithTimeout

func NewGetHealthParamsWithTimeout(timeout time.Duration) *GetHealthParams

NewGetHealthParamsWithTimeout creates a new GetHealthParams object with the ability to set a timeout on a request.

func (*GetHealthParams) SetContext

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

SetContext adds the context to the get health params

func (*GetHealthParams) SetDefaults

func (o *GetHealthParams) SetDefaults()

SetDefaults hydrates default values in the get health params (not the query body).

All values with no default are reset to their zero value.

func (*GetHealthParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get health params

func (*GetHealthParams) SetTimeout

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

SetTimeout adds the timeout to the get health params

func (*GetHealthParams) WithContext

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

WithContext adds the context to the get health params

func (*GetHealthParams) WithDefaults

func (o *GetHealthParams) WithDefaults() *GetHealthParams

WithDefaults hydrates default values in the get health params (not the query body).

All values with no default are reset to their zero value.

func (*GetHealthParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get health params

func (*GetHealthParams) WithTimeout

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

WithTimeout adds the timeout to the get health params

func (*GetHealthParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetHealthReader

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

GetHealthReader is a Reader for the GetHealth structure.

func (*GetHealthReader) ReadResponse

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

ReadResponse reads a server response into the received o.