status

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

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

 Go to latest Published: Dec 15, 2024 License: MIT Imports: 10 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 status API

func (*Client) GetSystemStatusChecks 

func (a *Client) GetSystemStatusChecks(params *GetSystemStatusChecksParams, opts ...ClientOption) (*GetSystemStatusChecksOK, error)

GetSystemStatusChecks healths check endpoint that returns the results of the system status checks

func (*Client) IsAvailable 

func (a *Client) IsAvailable(params *IsAvailableParams, opts ...ClientOption) (*IsAvailableOK, error)

IsAvailable healths check endpoint that validates server can respond to read requests

func (*Client) IsWritable 

func (a *Client) IsWritable(params *IsWritableParams, opts ...ClientOption) (*IsWritableOK, error)

IsWritable healths check endpoint that validates server can respond to read and write requests

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

type ClientService 

type ClientService interface {
	GetSystemStatusChecks(params *GetSystemStatusChecksParams, opts ...ClientOption) (*GetSystemStatusChecksOK, error)

	IsAvailable(params *IsAvailableParams, opts ...ClientOption) (*IsAvailableOK, error)

	IsWritable(params *IsWritableParams, opts ...ClientOption) (*IsWritableOK, 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 status API client.

type GetSystemStatusChecksOK 

type GetSystemStatusChecksOK struct {
	Payload map[string]models.Result
}

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

The system status check results

func NewGetSystemStatusChecksOK 

func NewGetSystemStatusChecksOK() *GetSystemStatusChecksOK

NewGetSystemStatusChecksOK creates a GetSystemStatusChecksOK with default headers values

func (*GetSystemStatusChecksOK) Code 

func (o *GetSystemStatusChecksOK) Code() int

Code gets the status code for the get system status checks o k response

func (*GetSystemStatusChecksOK) Error 

func (o *GetSystemStatusChecksOK) Error() string

func (*GetSystemStatusChecksOK) GetPayload 

func (o *GetSystemStatusChecksOK) GetPayload() map[string]models.Result

func (*GetSystemStatusChecksOK) IsClientError 

func (o *GetSystemStatusChecksOK) IsClientError() bool

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

func (*GetSystemStatusChecksOK) IsCode 

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

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

func (*GetSystemStatusChecksOK) IsRedirect 

func (o *GetSystemStatusChecksOK) IsRedirect() bool

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

func (*GetSystemStatusChecksOK) IsServerError 

func (o *GetSystemStatusChecksOK) IsServerError() bool

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

func (*GetSystemStatusChecksOK) IsSuccess 

func (o *GetSystemStatusChecksOK) IsSuccess() bool

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

func (*GetSystemStatusChecksOK) String 

func (o *GetSystemStatusChecksOK) String() string

type GetSystemStatusChecksParams 

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

GetSystemStatusChecksParams contains all the parameters to send to the API endpoint 

for the get system status checks operation.

Typically these are written to a http.Request.

func NewGetSystemStatusChecksParams 

func NewGetSystemStatusChecksParams() *GetSystemStatusChecksParams

NewGetSystemStatusChecksParams creates a new GetSystemStatusChecksParams 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 NewGetSystemStatusChecksParamsWithContext 

func NewGetSystemStatusChecksParamsWithContext(ctx context.Context) *GetSystemStatusChecksParams

NewGetSystemStatusChecksParamsWithContext creates a new GetSystemStatusChecksParams object with the ability to set a context for a request.

func NewGetSystemStatusChecksParamsWithHTTPClient 

func NewGetSystemStatusChecksParamsWithHTTPClient(client *http.Client) *GetSystemStatusChecksParams

NewGetSystemStatusChecksParamsWithHTTPClient creates a new GetSystemStatusChecksParams object with the ability to set a custom HTTPClient for a request.

func NewGetSystemStatusChecksParamsWithTimeout 

func NewGetSystemStatusChecksParamsWithTimeout(timeout time.Duration) *GetSystemStatusChecksParams

NewGetSystemStatusChecksParamsWithTimeout creates a new GetSystemStatusChecksParams object with the ability to set a timeout on a request.

func (*GetSystemStatusChecksParams) SetContext 

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

SetContext adds the context to the get system status checks params

func (*GetSystemStatusChecksParams) SetDefaults 

func (o *GetSystemStatusChecksParams) SetDefaults()

SetDefaults hydrates default values in the get system status checks params (not the query body).

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

func (*GetSystemStatusChecksParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get system status checks params

func (*GetSystemStatusChecksParams) SetTimeout 

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

SetTimeout adds the timeout to the get system status checks params

func (*GetSystemStatusChecksParams) WithContext 

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

WithContext adds the context to the get system status checks params

func (*GetSystemStatusChecksParams) WithDefaults 

func (o *GetSystemStatusChecksParams) WithDefaults() *GetSystemStatusChecksParams

WithDefaults hydrates default values in the get system status checks params (not the query body).

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

func (*GetSystemStatusChecksParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get system status checks params

func (*GetSystemStatusChecksParams) WithTimeout 

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

WithTimeout adds the timeout to the get system status checks params

func (*GetSystemStatusChecksParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetSystemStatusChecksReader 

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

GetSystemStatusChecksReader is a Reader for the GetSystemStatusChecks structure.

func (*GetSystemStatusChecksReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type IsAvailableOK 

type IsAvailableOK struct {
}

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

Available to service requests

func NewIsAvailableOK 

func NewIsAvailableOK() *IsAvailableOK

NewIsAvailableOK creates a IsAvailableOK with default headers values

func (*IsAvailableOK) Code 

func (o *IsAvailableOK) Code() int

Code gets the status code for the is available o k response

func (*IsAvailableOK) Error 

func (o *IsAvailableOK) Error() string

func (*IsAvailableOK) IsClientError 

func (o *IsAvailableOK) IsClientError() bool

IsClientError returns true when this is available o k response has a 4xx status code

func (*IsAvailableOK) IsCode 

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

IsCode returns true when this is available o k response a status code equal to that given

func (*IsAvailableOK) IsRedirect 

func (o *IsAvailableOK) IsRedirect() bool

IsRedirect returns true when this is available o k response has a 3xx status code

func (*IsAvailableOK) IsServerError 

func (o *IsAvailableOK) IsServerError() bool

IsServerError returns true when this is available o k response has a 5xx status code

func (*IsAvailableOK) IsSuccess 

func (o *IsAvailableOK) IsSuccess() bool

IsSuccess returns true when this is available o k response has a 2xx status code

func (*IsAvailableOK) String 

func (o *IsAvailableOK) String() string

type IsAvailableParams 

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

IsAvailableParams contains all the parameters to send to the API endpoint 

for the is available operation.

Typically these are written to a http.Request.

func NewIsAvailableParams 

func NewIsAvailableParams() *IsAvailableParams

NewIsAvailableParams creates a new IsAvailableParams 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 NewIsAvailableParamsWithContext 

func NewIsAvailableParamsWithContext(ctx context.Context) *IsAvailableParams

NewIsAvailableParamsWithContext creates a new IsAvailableParams object with the ability to set a context for a request.

func NewIsAvailableParamsWithHTTPClient 

func NewIsAvailableParamsWithHTTPClient(client *http.Client) *IsAvailableParams

NewIsAvailableParamsWithHTTPClient creates a new IsAvailableParams object with the ability to set a custom HTTPClient for a request.

func NewIsAvailableParamsWithTimeout 

func NewIsAvailableParamsWithTimeout(timeout time.Duration) *IsAvailableParams

NewIsAvailableParamsWithTimeout creates a new IsAvailableParams object with the ability to set a timeout on a request.

func (*IsAvailableParams) SetContext 

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

SetContext adds the context to the is available params

func (*IsAvailableParams) SetDefaults 

func (o *IsAvailableParams) SetDefaults()

SetDefaults hydrates default values in the is available params (not the query body).

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

func (*IsAvailableParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the is available params

func (*IsAvailableParams) SetTimeout 

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

SetTimeout adds the timeout to the is available params

func (*IsAvailableParams) WithContext 

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

WithContext adds the context to the is available params

func (*IsAvailableParams) WithDefaults 

func (o *IsAvailableParams) WithDefaults() *IsAvailableParams

WithDefaults hydrates default values in the is available params (not the query body).

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

func (*IsAvailableParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the is available params

func (*IsAvailableParams) WithTimeout 

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

WithTimeout adds the timeout to the is available params

func (*IsAvailableParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type IsAvailableReader 

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

IsAvailableReader is a Reader for the IsAvailable structure.

func (*IsAvailableReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type IsAvailableServiceUnavailable 

type IsAvailableServiceUnavailable struct {
}

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

Unavailable to service requests

func NewIsAvailableServiceUnavailable 

func NewIsAvailableServiceUnavailable() *IsAvailableServiceUnavailable

NewIsAvailableServiceUnavailable creates a IsAvailableServiceUnavailable with default headers values

func (*IsAvailableServiceUnavailable) Code 

func (o *IsAvailableServiceUnavailable) Code() int

Code gets the status code for the is available service unavailable response

func (*IsAvailableServiceUnavailable) Error 

func (o *IsAvailableServiceUnavailable) Error() string

func (*IsAvailableServiceUnavailable) IsClientError 

func (o *IsAvailableServiceUnavailable) IsClientError() bool

IsClientError returns true when this is available service unavailable response has a 4xx status code

func (*IsAvailableServiceUnavailable) IsCode 

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

IsCode returns true when this is available service unavailable response a status code equal to that given

func (*IsAvailableServiceUnavailable) IsRedirect 

func (o *IsAvailableServiceUnavailable) IsRedirect() bool

IsRedirect returns true when this is available service unavailable response has a 3xx status code

func (*IsAvailableServiceUnavailable) IsServerError 

func (o *IsAvailableServiceUnavailable) IsServerError() bool

IsServerError returns true when this is available service unavailable response has a 5xx status code

func (*IsAvailableServiceUnavailable) IsSuccess 

func (o *IsAvailableServiceUnavailable) IsSuccess() bool

IsSuccess returns true when this is available service unavailable response has a 2xx status code

func (*IsAvailableServiceUnavailable) String 

func (o *IsAvailableServiceUnavailable) String() string

type IsWritableOK 

type IsWritableOK struct {
}

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

Available to service requests

func NewIsWritableOK 

func NewIsWritableOK() *IsWritableOK

NewIsWritableOK creates a IsWritableOK with default headers values

func (*IsWritableOK) Code 

func (o *IsWritableOK) Code() int

Code gets the status code for the is writable o k response

func (*IsWritableOK) Error 

func (o *IsWritableOK) Error() string

func (*IsWritableOK) IsClientError 

func (o *IsWritableOK) IsClientError() bool

IsClientError returns true when this is writable o k response has a 4xx status code

func (*IsWritableOK) IsCode 

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

IsCode returns true when this is writable o k response a status code equal to that given

func (*IsWritableOK) IsRedirect 

func (o *IsWritableOK) IsRedirect() bool

IsRedirect returns true when this is writable o k response has a 3xx status code

func (*IsWritableOK) IsServerError 

func (o *IsWritableOK) IsServerError() bool

IsServerError returns true when this is writable o k response has a 5xx status code

func (*IsWritableOK) IsSuccess 

func (o *IsWritableOK) IsSuccess() bool

IsSuccess returns true when this is writable o k response has a 2xx status code

func (*IsWritableOK) String 

func (o *IsWritableOK) String() string

type IsWritableParams 

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

IsWritableParams contains all the parameters to send to the API endpoint 

for the is writable operation.

Typically these are written to a http.Request.

func NewIsWritableParams 

func NewIsWritableParams() *IsWritableParams

NewIsWritableParams creates a new IsWritableParams 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 NewIsWritableParamsWithContext 

func NewIsWritableParamsWithContext(ctx context.Context) *IsWritableParams

NewIsWritableParamsWithContext creates a new IsWritableParams object with the ability to set a context for a request.

func NewIsWritableParamsWithHTTPClient 

func NewIsWritableParamsWithHTTPClient(client *http.Client) *IsWritableParams

NewIsWritableParamsWithHTTPClient creates a new IsWritableParams object with the ability to set a custom HTTPClient for a request.

func NewIsWritableParamsWithTimeout 

func NewIsWritableParamsWithTimeout(timeout time.Duration) *IsWritableParams

NewIsWritableParamsWithTimeout creates a new IsWritableParams object with the ability to set a timeout on a request.

func (*IsWritableParams) SetContext 

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

SetContext adds the context to the is writable params

func (*IsWritableParams) SetDefaults 

func (o *IsWritableParams) SetDefaults()

SetDefaults hydrates default values in the is writable params (not the query body).

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

func (*IsWritableParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the is writable params

func (*IsWritableParams) SetTimeout 

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

SetTimeout adds the timeout to the is writable params

func (*IsWritableParams) WithContext 

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

WithContext adds the context to the is writable params

func (*IsWritableParams) WithDefaults 

func (o *IsWritableParams) WithDefaults() *IsWritableParams

WithDefaults hydrates default values in the is writable params (not the query body).

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

func (*IsWritableParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the is writable params

func (*IsWritableParams) WithTimeout 

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

WithTimeout adds the timeout to the is writable params

func (*IsWritableParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type IsWritableReader 

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

IsWritableReader is a Reader for the IsWritable structure.

func (*IsWritableReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type IsWritableServiceUnavailable 

type IsWritableServiceUnavailable struct {
}

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

Unavailable to service requests

func NewIsWritableServiceUnavailable 

func NewIsWritableServiceUnavailable() *IsWritableServiceUnavailable

NewIsWritableServiceUnavailable creates a IsWritableServiceUnavailable with default headers values

func (*IsWritableServiceUnavailable) Code 

func (o *IsWritableServiceUnavailable) Code() int

Code gets the status code for the is writable service unavailable response

func (*IsWritableServiceUnavailable) Error 

func (o *IsWritableServiceUnavailable) Error() string

func (*IsWritableServiceUnavailable) IsClientError 

func (o *IsWritableServiceUnavailable) IsClientError() bool

IsClientError returns true when this is writable service unavailable response has a 4xx status code

func (*IsWritableServiceUnavailable) IsCode 

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

IsCode returns true when this is writable service unavailable response a status code equal to that given

func (*IsWritableServiceUnavailable) IsRedirect 

func (o *IsWritableServiceUnavailable) IsRedirect() bool

IsRedirect returns true when this is writable service unavailable response has a 3xx status code

func (*IsWritableServiceUnavailable) IsServerError 

func (o *IsWritableServiceUnavailable) IsServerError() bool

IsServerError returns true when this is writable service unavailable response has a 5xx status code

func (*IsWritableServiceUnavailable) IsSuccess 

func (o *IsWritableServiceUnavailable) IsSuccess() bool

IsSuccess returns true when this is writable service unavailable response has a 2xx status code

func (*IsWritableServiceUnavailable) String 

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