health

package
v0.5.6-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 28, 2020 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

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) IsInstanceAlive

func (a *Client) IsInstanceAlive(params *IsInstanceAliveParams) (*IsInstanceAliveOK, error)
IsInstanceAlive checks alive status

This endpoint returns a 200 status code when the HTTP server is up running.

This status does currently not include checks whether the database connection is working.

If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

func (*Client) IsInstanceReady

func (a *Client) IsInstanceReady(params *IsInstanceReadyParams) (*IsInstanceReadyOK, error)
IsInstanceReady checks readiness status

This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g.

the database) are responsive as well.

If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	IsInstanceAlive(params *IsInstanceAliveParams) (*IsInstanceAliveOK, error)

	IsInstanceReady(params *IsInstanceReadyParams) (*IsInstanceReadyOK, 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 IsInstanceAliveInternalServerError

type IsInstanceAliveInternalServerError struct {
	Payload *IsInstanceAliveInternalServerErrorBody
}

IsInstanceAliveInternalServerError handles this case with default header values.

The standard error format

func NewIsInstanceAliveInternalServerError

func NewIsInstanceAliveInternalServerError() *IsInstanceAliveInternalServerError

NewIsInstanceAliveInternalServerError creates a IsInstanceAliveInternalServerError with default headers values

func (*IsInstanceAliveInternalServerError) Error

func (*IsInstanceAliveInternalServerError) GetPayload

type IsInstanceAliveInternalServerErrorBody

type IsInstanceAliveInternalServerErrorBody struct {

	// code
	Code int64 `json:"code,omitempty"`

	// details
	Details []interface{} `json:"details"`

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

IsInstanceAliveInternalServerErrorBody is instance alive internal server error body swagger:model IsInstanceAliveInternalServerErrorBody

func (*IsInstanceAliveInternalServerErrorBody) MarshalBinary

func (o *IsInstanceAliveInternalServerErrorBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*IsInstanceAliveInternalServerErrorBody) UnmarshalBinary

func (o *IsInstanceAliveInternalServerErrorBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*IsInstanceAliveInternalServerErrorBody) Validate

Validate validates this is instance alive internal server error body

type IsInstanceAliveOK

type IsInstanceAliveOK struct {
	Payload *models.HealthStatus
}

IsInstanceAliveOK handles this case with default header values.

healthStatus

func NewIsInstanceAliveOK

func NewIsInstanceAliveOK() *IsInstanceAliveOK

NewIsInstanceAliveOK creates a IsInstanceAliveOK with default headers values

func (*IsInstanceAliveOK) Error

func (o *IsInstanceAliveOK) Error() string

func (*IsInstanceAliveOK) GetPayload

func (o *IsInstanceAliveOK) GetPayload() *models.HealthStatus

type IsInstanceAliveParams

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

IsInstanceAliveParams contains all the parameters to send to the API endpoint for the is instance alive operation typically these are written to a http.Request

func NewIsInstanceAliveParams

func NewIsInstanceAliveParams() *IsInstanceAliveParams

NewIsInstanceAliveParams creates a new IsInstanceAliveParams object with the default values initialized.

func NewIsInstanceAliveParamsWithContext

func NewIsInstanceAliveParamsWithContext(ctx context.Context) *IsInstanceAliveParams

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

func NewIsInstanceAliveParamsWithHTTPClient

func NewIsInstanceAliveParamsWithHTTPClient(client *http.Client) *IsInstanceAliveParams

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

func NewIsInstanceAliveParamsWithTimeout

func NewIsInstanceAliveParamsWithTimeout(timeout time.Duration) *IsInstanceAliveParams

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

func (*IsInstanceAliveParams) SetContext

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

SetContext adds the context to the is instance alive params

func (*IsInstanceAliveParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the is instance alive params

func (*IsInstanceAliveParams) SetTimeout

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

SetTimeout adds the timeout to the is instance alive params

func (*IsInstanceAliveParams) WithContext

WithContext adds the context to the is instance alive params

func (*IsInstanceAliveParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the is instance alive params

func (*IsInstanceAliveParams) WithTimeout

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

WithTimeout adds the timeout to the is instance alive params

func (*IsInstanceAliveParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type IsInstanceAliveReader

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

IsInstanceAliveReader is a Reader for the IsInstanceAlive structure.

func (*IsInstanceAliveReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type IsInstanceReadyOK

type IsInstanceReadyOK struct {
	Payload *models.HealthStatus
}

IsInstanceReadyOK handles this case with default header values.

healthStatus

func NewIsInstanceReadyOK

func NewIsInstanceReadyOK() *IsInstanceReadyOK

NewIsInstanceReadyOK creates a IsInstanceReadyOK with default headers values

func (*IsInstanceReadyOK) Error

func (o *IsInstanceReadyOK) Error() string

func (*IsInstanceReadyOK) GetPayload

func (o *IsInstanceReadyOK) GetPayload() *models.HealthStatus

type IsInstanceReadyParams

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

IsInstanceReadyParams contains all the parameters to send to the API endpoint for the is instance ready operation typically these are written to a http.Request

func NewIsInstanceReadyParams

func NewIsInstanceReadyParams() *IsInstanceReadyParams

NewIsInstanceReadyParams creates a new IsInstanceReadyParams object with the default values initialized.

func NewIsInstanceReadyParamsWithContext

func NewIsInstanceReadyParamsWithContext(ctx context.Context) *IsInstanceReadyParams

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

func NewIsInstanceReadyParamsWithHTTPClient

func NewIsInstanceReadyParamsWithHTTPClient(client *http.Client) *IsInstanceReadyParams

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

func NewIsInstanceReadyParamsWithTimeout

func NewIsInstanceReadyParamsWithTimeout(timeout time.Duration) *IsInstanceReadyParams

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

func (*IsInstanceReadyParams) SetContext

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

SetContext adds the context to the is instance ready params

func (*IsInstanceReadyParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the is instance ready params

func (*IsInstanceReadyParams) SetTimeout

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

SetTimeout adds the timeout to the is instance ready params

func (*IsInstanceReadyParams) WithContext

WithContext adds the context to the is instance ready params

func (*IsInstanceReadyParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the is instance ready params

func (*IsInstanceReadyParams) WithTimeout

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

WithTimeout adds the timeout to the is instance ready params

func (*IsInstanceReadyParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type IsInstanceReadyReader

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

IsInstanceReadyReader is a Reader for the IsInstanceReady structure.

func (*IsInstanceReadyReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type IsInstanceReadyServiceUnavailable

type IsInstanceReadyServiceUnavailable struct {
	Payload *models.HealthNotReadyStatus
}

IsInstanceReadyServiceUnavailable handles this case with default header values.

healthNotReadyStatus

func NewIsInstanceReadyServiceUnavailable

func NewIsInstanceReadyServiceUnavailable() *IsInstanceReadyServiceUnavailable

NewIsInstanceReadyServiceUnavailable creates a IsInstanceReadyServiceUnavailable with default headers values

func (*IsInstanceReadyServiceUnavailable) Error

func (*IsInstanceReadyServiceUnavailable) GetPayload

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL