health

package
v0.0.0-...-6bd88e3 Latest Latest
Warning

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

 Go to latest Published: Aug 1, 2024 License: AGPL-3.0-or-later Imports: 8 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) LiveGet 

func (a *Client) LiveGet(params *LiveGetParams, opts ...ClientOption) (*LiveGetOK, error)

LiveGet returns code 200 with no body if go to social is live ie able to respond to HTTP requests

func (*Client) LiveHead 

func (a *Client) LiveHead(params *LiveHeadParams, opts ...ClientOption) (*LiveHeadOK, error)

LiveHead returns code 200 if go to social is live ie able to respond to HTTP requests

func (*Client) ReadyGet 

func (a *Client) ReadyGet(params *ReadyGetParams, opts ...ClientOption) (*ReadyGetOK, error)

ReadyGet returns code 200 with no body if go to social is ready ie able to connect to the database backend and do a simple s e l e c t

If GtS is not ready, 500 Internal Error will be returned, and an error will be logged (but not returned to the caller, to avoid leaking internals).

func (*Client) ReadyHead 

func (a *Client) ReadyHead(params *ReadyHeadParams, opts ...ClientOption) (*ReadyHeadOK, error)

ReadyHead returns code 200 with no body if go to social is ready ie able to connect to the database backend and do a simple s e l e c t

If GtS is not ready, 500 Internal Error will be returned, and an error will be logged (but not returned to the caller, to avoid leaking internals).

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 {
	LiveGet(params *LiveGetParams, opts ...ClientOption) (*LiveGetOK, error)

	LiveHead(params *LiveHeadParams, opts ...ClientOption) (*LiveHeadOK, error)

	ReadyGet(params *ReadyGetParams, opts ...ClientOption) (*ReadyGetOK, error)

	ReadyHead(params *ReadyHeadParams, opts ...ClientOption) (*ReadyHeadOK, 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 LiveGetOK 

type LiveGetOK struct {
}

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

OK

func NewLiveGetOK 

func NewLiveGetOK() *LiveGetOK

NewLiveGetOK creates a LiveGetOK with default headers values

func (*LiveGetOK) Code 

func (o *LiveGetOK) Code() int

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

func (*LiveGetOK) Error 

func (o *LiveGetOK) Error() string

func (*LiveGetOK) IsClientError 

func (o *LiveGetOK) IsClientError() bool

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

func (*LiveGetOK) IsCode 

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

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

func (*LiveGetOK) IsRedirect 

func (o *LiveGetOK) IsRedirect() bool

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

func (*LiveGetOK) IsServerError 

func (o *LiveGetOK) IsServerError() bool

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

func (*LiveGetOK) IsSuccess 

func (o *LiveGetOK) IsSuccess() bool

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

func (*LiveGetOK) String 

func (o *LiveGetOK) String() string

type LiveGetParams 

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

LiveGetParams contains all the parameters to send to the API endpoint 

for the live get operation.

Typically these are written to a http.Request.

func NewLiveGetParams 

func NewLiveGetParams() *LiveGetParams

NewLiveGetParams creates a new LiveGetParams 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 NewLiveGetParamsWithContext 

func NewLiveGetParamsWithContext(ctx context.Context) *LiveGetParams

NewLiveGetParamsWithContext creates a new LiveGetParams object with the ability to set a context for a request.

func NewLiveGetParamsWithHTTPClient 

func NewLiveGetParamsWithHTTPClient(client *http.Client) *LiveGetParams

NewLiveGetParamsWithHTTPClient creates a new LiveGetParams object with the ability to set a custom HTTPClient for a request.

func NewLiveGetParamsWithTimeout 

func NewLiveGetParamsWithTimeout(timeout time.Duration) *LiveGetParams

NewLiveGetParamsWithTimeout creates a new LiveGetParams object with the ability to set a timeout on a request.

func (*LiveGetParams) SetContext 

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

SetContext adds the context to the live get params

func (*LiveGetParams) SetDefaults 

func (o *LiveGetParams) SetDefaults()

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

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

func (*LiveGetParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the live get params

func (*LiveGetParams) SetTimeout 

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

SetTimeout adds the timeout to the live get params

func (*LiveGetParams) WithContext 

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

WithContext adds the context to the live get params

func (*LiveGetParams) WithDefaults 

func (o *LiveGetParams) WithDefaults() *LiveGetParams

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

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

func (*LiveGetParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the live get params

func (*LiveGetParams) WithTimeout 

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

WithTimeout adds the timeout to the live get params

func (*LiveGetParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type LiveGetReader 

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

LiveGetReader is a Reader for the LiveGet structure.

func (*LiveGetReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type LiveHeadOK 

type LiveHeadOK struct {
}

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

OK

func NewLiveHeadOK 

func NewLiveHeadOK() *LiveHeadOK

NewLiveHeadOK creates a LiveHeadOK with default headers values

func (*LiveHeadOK) Code 

func (o *LiveHeadOK) Code() int

Code gets the status code for the live head o k response

func (*LiveHeadOK) Error 

func (o *LiveHeadOK) Error() string

func (*LiveHeadOK) IsClientError 

func (o *LiveHeadOK) IsClientError() bool

IsClientError returns true when this live head o k response has a 4xx status code

func (*LiveHeadOK) IsCode 

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

IsCode returns true when this live head o k response a status code equal to that given

func (*LiveHeadOK) IsRedirect 

func (o *LiveHeadOK) IsRedirect() bool

IsRedirect returns true when this live head o k response has a 3xx status code

func (*LiveHeadOK) IsServerError 

func (o *LiveHeadOK) IsServerError() bool

IsServerError returns true when this live head o k response has a 5xx status code

func (*LiveHeadOK) IsSuccess 

func (o *LiveHeadOK) IsSuccess() bool

IsSuccess returns true when this live head o k response has a 2xx status code

func (*LiveHeadOK) String 

func (o *LiveHeadOK) String() string

type LiveHeadParams 

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

LiveHeadParams contains all the parameters to send to the API endpoint 

for the live head operation.

Typically these are written to a http.Request.

func NewLiveHeadParams 

func NewLiveHeadParams() *LiveHeadParams

NewLiveHeadParams creates a new LiveHeadParams 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 NewLiveHeadParamsWithContext 

func NewLiveHeadParamsWithContext(ctx context.Context) *LiveHeadParams

NewLiveHeadParamsWithContext creates a new LiveHeadParams object with the ability to set a context for a request.

func NewLiveHeadParamsWithHTTPClient 

func NewLiveHeadParamsWithHTTPClient(client *http.Client) *LiveHeadParams

NewLiveHeadParamsWithHTTPClient creates a new LiveHeadParams object with the ability to set a custom HTTPClient for a request.

func NewLiveHeadParamsWithTimeout 

func NewLiveHeadParamsWithTimeout(timeout time.Duration) *LiveHeadParams

NewLiveHeadParamsWithTimeout creates a new LiveHeadParams object with the ability to set a timeout on a request.

func (*LiveHeadParams) SetContext 

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

SetContext adds the context to the live head params

func (*LiveHeadParams) SetDefaults 

func (o *LiveHeadParams) SetDefaults()

SetDefaults hydrates default values in the live head params (not the query body).

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

func (*LiveHeadParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the live head params

func (*LiveHeadParams) SetTimeout 

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

SetTimeout adds the timeout to the live head params

func (*LiveHeadParams) WithContext 

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

WithContext adds the context to the live head params

func (*LiveHeadParams) WithDefaults 

func (o *LiveHeadParams) WithDefaults() *LiveHeadParams

WithDefaults hydrates default values in the live head params (not the query body).

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

func (*LiveHeadParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the live head params

func (*LiveHeadParams) WithTimeout 

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

WithTimeout adds the timeout to the live head params

func (*LiveHeadParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type LiveHeadReader 

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

LiveHeadReader is a Reader for the LiveHead structure.

func (*LiveHeadReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ReadyGetInternalServerError 

type ReadyGetInternalServerError struct {
}

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

Not ready. Check logs for error message.

func NewReadyGetInternalServerError 

func NewReadyGetInternalServerError() *ReadyGetInternalServerError

NewReadyGetInternalServerError creates a ReadyGetInternalServerError with default headers values

func (*ReadyGetInternalServerError) Code 

func (o *ReadyGetInternalServerError) Code() int

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

func (*ReadyGetInternalServerError) Error 

func (o *ReadyGetInternalServerError) Error() string

func (*ReadyGetInternalServerError) IsClientError 

func (o *ReadyGetInternalServerError) IsClientError() bool

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

func (*ReadyGetInternalServerError) IsCode 

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

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

func (*ReadyGetInternalServerError) IsRedirect 

func (o *ReadyGetInternalServerError) IsRedirect() bool

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

func (*ReadyGetInternalServerError) IsServerError 

func (o *ReadyGetInternalServerError) IsServerError() bool

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

func (*ReadyGetInternalServerError) IsSuccess 

func (o *ReadyGetInternalServerError) IsSuccess() bool

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

func (*ReadyGetInternalServerError) String 

func (o *ReadyGetInternalServerError) String() string

type ReadyGetOK 

type ReadyGetOK struct {
}

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

OK

func NewReadyGetOK 

func NewReadyGetOK() *ReadyGetOK

NewReadyGetOK creates a ReadyGetOK with default headers values

func (*ReadyGetOK) Code 

func (o *ReadyGetOK) Code() int

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

func (*ReadyGetOK) Error 

func (o *ReadyGetOK) Error() string

func (*ReadyGetOK) IsClientError 

func (o *ReadyGetOK) IsClientError() bool

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

func (*ReadyGetOK) IsCode 

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

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

func (*ReadyGetOK) IsRedirect 

func (o *ReadyGetOK) IsRedirect() bool

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

func (*ReadyGetOK) IsServerError 

func (o *ReadyGetOK) IsServerError() bool

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

func (*ReadyGetOK) IsSuccess 

func (o *ReadyGetOK) IsSuccess() bool

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

func (*ReadyGetOK) String 

func (o *ReadyGetOK) String() string

type ReadyGetParams 

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

ReadyGetParams contains all the parameters to send to the API endpoint 

for the ready get operation.

Typically these are written to a http.Request.

func NewReadyGetParams 

func NewReadyGetParams() *ReadyGetParams

NewReadyGetParams creates a new ReadyGetParams 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 NewReadyGetParamsWithContext 

func NewReadyGetParamsWithContext(ctx context.Context) *ReadyGetParams

NewReadyGetParamsWithContext creates a new ReadyGetParams object with the ability to set a context for a request.

func NewReadyGetParamsWithHTTPClient 

func NewReadyGetParamsWithHTTPClient(client *http.Client) *ReadyGetParams

NewReadyGetParamsWithHTTPClient creates a new ReadyGetParams object with the ability to set a custom HTTPClient for a request.

func NewReadyGetParamsWithTimeout 

func NewReadyGetParamsWithTimeout(timeout time.Duration) *ReadyGetParams

NewReadyGetParamsWithTimeout creates a new ReadyGetParams object with the ability to set a timeout on a request.

func (*ReadyGetParams) SetContext 

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

SetContext adds the context to the ready get params

func (*ReadyGetParams) SetDefaults 

func (o *ReadyGetParams) SetDefaults()

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

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

func (*ReadyGetParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the ready get params

func (*ReadyGetParams) SetTimeout 

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

SetTimeout adds the timeout to the ready get params

func (*ReadyGetParams) WithContext 

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

WithContext adds the context to the ready get params

func (*ReadyGetParams) WithDefaults 

func (o *ReadyGetParams) WithDefaults() *ReadyGetParams

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

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

func (*ReadyGetParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the ready get params

func (*ReadyGetParams) WithTimeout 

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

WithTimeout adds the timeout to the ready get params

func (*ReadyGetParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ReadyGetReader 

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

ReadyGetReader is a Reader for the ReadyGet structure.

func (*ReadyGetReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ReadyHeadOK 

type ReadyHeadOK struct {
}

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

OK

func NewReadyHeadOK 

func NewReadyHeadOK() *ReadyHeadOK

NewReadyHeadOK creates a ReadyHeadOK with default headers values

func (*ReadyHeadOK) Code 

func (o *ReadyHeadOK) Code() int

Code gets the status code for the ready head o k response

func (*ReadyHeadOK) Error 

func (o *ReadyHeadOK) Error() string

func (*ReadyHeadOK) IsClientError 

func (o *ReadyHeadOK) IsClientError() bool

IsClientError returns true when this ready head o k response has a 4xx status code

func (*ReadyHeadOK) IsCode 

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

IsCode returns true when this ready head o k response a status code equal to that given

func (*ReadyHeadOK) IsRedirect 

func (o *ReadyHeadOK) IsRedirect() bool

IsRedirect returns true when this ready head o k response has a 3xx status code

func (*ReadyHeadOK) IsServerError 

func (o *ReadyHeadOK) IsServerError() bool

IsServerError returns true when this ready head o k response has a 5xx status code

func (*ReadyHeadOK) IsSuccess 

func (o *ReadyHeadOK) IsSuccess() bool

IsSuccess returns true when this ready head o k response has a 2xx status code

func (*ReadyHeadOK) String 

func (o *ReadyHeadOK) String() string

type ReadyHeadParams 

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

ReadyHeadParams contains all the parameters to send to the API endpoint 

for the ready head operation.

Typically these are written to a http.Request.

func NewReadyHeadParams 

func NewReadyHeadParams() *ReadyHeadParams

NewReadyHeadParams creates a new ReadyHeadParams 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 NewReadyHeadParamsWithContext 

func NewReadyHeadParamsWithContext(ctx context.Context) *ReadyHeadParams

NewReadyHeadParamsWithContext creates a new ReadyHeadParams object with the ability to set a context for a request.

func NewReadyHeadParamsWithHTTPClient 

func NewReadyHeadParamsWithHTTPClient(client *http.Client) *ReadyHeadParams

NewReadyHeadParamsWithHTTPClient creates a new ReadyHeadParams object with the ability to set a custom HTTPClient for a request.

func NewReadyHeadParamsWithTimeout 

func NewReadyHeadParamsWithTimeout(timeout time.Duration) *ReadyHeadParams

NewReadyHeadParamsWithTimeout creates a new ReadyHeadParams object with the ability to set a timeout on a request.

func (*ReadyHeadParams) SetContext 

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

SetContext adds the context to the ready head params

func (*ReadyHeadParams) SetDefaults 

func (o *ReadyHeadParams) SetDefaults()

SetDefaults hydrates default values in the ready head params (not the query body).

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

func (*ReadyHeadParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the ready head params

func (*ReadyHeadParams) SetTimeout 

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

SetTimeout adds the timeout to the ready head params

func (*ReadyHeadParams) WithContext 

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

WithContext adds the context to the ready head params

func (*ReadyHeadParams) WithDefaults 

func (o *ReadyHeadParams) WithDefaults() *ReadyHeadParams

WithDefaults hydrates default values in the ready head params (not the query body).

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

func (*ReadyHeadParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the ready head params

func (*ReadyHeadParams) WithTimeout 

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

WithTimeout adds the timeout to the ready head params

func (*ReadyHeadParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ReadyHeadReader 

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

ReadyHeadReader is a Reader for the ReadyHead structure.

func (*ReadyHeadReader) ReadResponse 

func (o *ReadyHeadReader) 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.