health

package
v0.0.0-...-59d2d35 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 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) GetHealth 

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

GetHealth apiHealthHandler will return ok if Grafana's web server is running and it can access the database. If the database cannot be accessed it will return http status code 503.

func (*Client) GetHealthWithParams 

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

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 is the option for Client methods

func WithAuthInfo 

func WithAuthInfo(authInfo runtime.ClientAuthInfoWriter) ClientOption

WithAuthInfo changes the transport on the client

type ClientService 

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

type GetHealthOK 

type GetHealthOK struct {
	Payload *models.HealthResponse
}

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

healthResponse

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 Ok response

func (*GetHealthOK) Error 

func (o *GetHealthOK) Error() string

func (*GetHealthOK) GetPayload 

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

func (*GetHealthOK) IsClientError 

func (o *GetHealthOK) IsClientError() bool

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

func (*GetHealthOK) IsCode 

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

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

func (*GetHealthOK) IsRedirect 

func (o *GetHealthOK) IsRedirect() bool

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

func (*GetHealthOK) IsServerError 

func (o *GetHealthOK) IsServerError() bool

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

func (*GetHealthOK) IsSuccess 

func (o *GetHealthOK) IsSuccess() bool

IsSuccess returns true when this get health Ok 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.

type GetHealthServiceUnavailable 

type GetHealthServiceUnavailable struct {
	Payload *models.ErrorResponseBody
}

GetHealthServiceUnavailable describes a response with status code 503, with default header values.

InternalServerError is a general error indicating something went wrong internally.

func NewGetHealthServiceUnavailable 

func NewGetHealthServiceUnavailable() *GetHealthServiceUnavailable

NewGetHealthServiceUnavailable creates a GetHealthServiceUnavailable with default headers values

func (*GetHealthServiceUnavailable) Code 

func (o *GetHealthServiceUnavailable) Code() int

Code gets the status code for the get health service unavailable response

func (*GetHealthServiceUnavailable) Error 

func (o *GetHealthServiceUnavailable) Error() string

func (*GetHealthServiceUnavailable) GetPayload 

func (o *GetHealthServiceUnavailable) GetPayload() *models.ErrorResponseBody

func (*GetHealthServiceUnavailable) IsClientError 

func (o *GetHealthServiceUnavailable) IsClientError() bool

IsClientError returns true when this get health service unavailable response has a 4xx status code

func (*GetHealthServiceUnavailable) IsCode 

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

IsCode returns true when this get health service unavailable response a status code equal to that given

func (*GetHealthServiceUnavailable) IsRedirect 

func (o *GetHealthServiceUnavailable) IsRedirect() bool

IsRedirect returns true when this get health service unavailable response has a 3xx status code

func (*GetHealthServiceUnavailable) IsServerError 

func (o *GetHealthServiceUnavailable) IsServerError() bool

IsServerError returns true when this get health service unavailable response has a 5xx status code

func (*GetHealthServiceUnavailable) IsSuccess 

func (o *GetHealthServiceUnavailable) IsSuccess() bool

IsSuccess returns true when this get health service unavailable response has a 2xx status code

func (*GetHealthServiceUnavailable) String 

func (o *GetHealthServiceUnavailable) String() string

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.