health

Documentation

Index

• type Client
  • func (a *Client) GetHealth(params *GetHealthParams, authInfo runtime.ClientAuthInfoWriter) (*GetHealthOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type ClientService
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
• type GetHealthInternalServerError
  • func NewGetHealthInternalServerError() *GetHealthInternalServerError
  • func (o *GetHealthInternalServerError) Error() string
  • func (o *GetHealthInternalServerError) GetPayload() *model.Errors
• type GetHealthOK
  • func NewGetHealthOK() *GetHealthOK
  • func (o *GetHealthOK) Error() string
  • func (o *GetHealthOK) GetPayload() *model.OverallHealthStatus
• 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) SetHTTPClient(client *http.Client)
  • func (o *GetHealthParams) SetTimeout(timeout time.Duration)
  • func (o *GetHealthParams) SetXRequestID(xRequestID *string)
  • func (o *GetHealthParams) WithContext(ctx context.Context) *GetHealthParams
  • func (o *GetHealthParams) WithHTTPClient(client *http.Client) *GetHealthParams
  • func (o *GetHealthParams) WithTimeout(timeout time.Duration) *GetHealthParams
  • func (o *GetHealthParams) WithXRequestID(xRequestID *string) *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, authInfo runtime.ClientAuthInfoWriter) (*GetHealthOK, error)

GetHealth checks the status of harbor components

Check the status of Harbor components. This path does not require authentication.

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	GetHealth(params *GetHealthParams, authInfo runtime.ClientAuthInfoWriter) (*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.

type GetHealthInternalServerError

type GetHealthInternalServerError struct {
	/*The ID of the corresponding request for the response
	 */
	XRequestID string

	Payload *model.Errors
}

GetHealthInternalServerError handles this case with default header values.

Internal server error

func NewGetHealthInternalServerError

func NewGetHealthInternalServerError() *GetHealthInternalServerError

NewGetHealthInternalServerError creates a GetHealthInternalServerError with default headers values

func (*GetHealthInternalServerError) Error

func (o *GetHealthInternalServerError) Error() string

func (*GetHealthInternalServerError) GetPayload

func (o *GetHealthInternalServerError) GetPayload() *model.Errors

type GetHealthOK

type GetHealthOK struct {
	Payload *model.OverallHealthStatus
}

GetHealthOK handles this case with default header values.

The health status of Harbor components

func NewGetHealthOK

func NewGetHealthOK() *GetHealthOK

NewGetHealthOK creates a GetHealthOK with default headers values

func (*GetHealthOK) Error

func (o *GetHealthOK) Error() string

func (*GetHealthOK) GetPayload

func (o *GetHealthOK) GetPayload() *model.OverallHealthStatus

type GetHealthParams

type GetHealthParams struct {

	/*XRequestID
	  An unique ID for the request

	*/
	XRequestID *string

	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 values initialized.

func NewGetHealthParamsWithContext

func NewGetHealthParamsWithContext(ctx context.Context) *GetHealthParams

NewGetHealthParamsWithContext creates a new GetHealthParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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) SetXRequestID

func (o *GetHealthParams) SetXRequestID(xRequestID *string)

SetXRequestID adds the xRequestId 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) 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) WithXRequestID

func (o *GetHealthParams) WithXRequestID(xRequestID *string) *GetHealthParams

WithXRequestID adds the xRequestID 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.