health

package
v0.210.0 Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2024 License: Apache-2.0 Imports: 10 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API interface {
	/*
	   GetHealth checks the status of harbor components

	   Check the status of Harbor components. This path does not require authentication.*/
	GetHealth(ctx context.Context, params *GetHealthParams) (*GetHealthOK, error)
}

API is the interface of the health client

type Client 

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

Client for health API

func New 

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

New creates a new health API client.

func (*Client) GetHealth 

func (a *Client) GetHealth(ctx context.Context, params *GetHealthParams) (*GetHealthOK, error)

GetHealth checks the status of harbor components

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

type GetHealthInternalServerError 

type GetHealthInternalServerError struct {

	/* The ID of the corresponding request for the response
	 */
	XRequestID string

	Payload *models.Errors
}

GetHealthInternalServerError describes a response with status code 500, 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() *models.Errors

func (*GetHealthInternalServerError) IsClientError added in v0.26.2 

func (o *GetHealthInternalServerError) IsClientError() bool

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

func (*GetHealthInternalServerError) IsCode added in v0.26.2 

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 added in v0.26.2 

func (o *GetHealthInternalServerError) IsRedirect() bool

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

func (*GetHealthInternalServerError) IsServerError added in v0.26.2 

func (o *GetHealthInternalServerError) IsServerError() bool

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

func (*GetHealthInternalServerError) IsSuccess added in v0.26.2 

func (o *GetHealthInternalServerError) IsSuccess() bool

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

func (*GetHealthInternalServerError) String added in v0.26.2 

func (o *GetHealthInternalServerError) String() string

type GetHealthOK 

type GetHealthOK struct {
	Payload *models.OverallHealthStatus
}

GetHealthOK describes a response with status code 200, 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() *models.OverallHealthStatus

func (*GetHealthOK) IsClientError added in v0.26.2 

func (o *GetHealthOK) IsClientError() bool

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

func (*GetHealthOK) IsCode added in v0.26.2 

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 added in v0.26.2 

func (o *GetHealthOK) IsRedirect() bool

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

func (*GetHealthOK) IsServerError added in v0.26.2 

func (o *GetHealthOK) IsServerError() bool

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

func (*GetHealthOK) IsSuccess added in v0.26.2 

func (o *GetHealthOK) IsSuccess() bool

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

func (*GetHealthOK) String added in v0.26.2 

func (o *GetHealthOK) String() string

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.