ping

package
v4.0.0 Latest Latest
Warning

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

Go to latest
Published: Jul 1, 2021 License: MIT Imports: 9 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 ping API

func (*Client) GetPing

func (a *Client) GetPing(params *GetPingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetPingOK, error)

GetPing pings harbor to check if it s alive

This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components.

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 {
	GetPing(params *GetPingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetPingOK, 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 ping API client.

type GetPingOK

type GetPingOK struct {
	Payload string
}
GetPingOK describes a response with status code 200, with default header values.

The API server is alive

func NewGetPingOK

func NewGetPingOK() *GetPingOK

NewGetPingOK creates a GetPingOK with default headers values

func (*GetPingOK) Error

func (o *GetPingOK) Error() string

func (*GetPingOK) GetPayload

func (o *GetPingOK) GetPayload() string

type GetPingParams

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

GetPingParams contains all the parameters to send to the API endpoint

for the get ping operation.

Typically these are written to a http.Request.

func NewGetPingParams

func NewGetPingParams() *GetPingParams

NewGetPingParams creates a new GetPingParams 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 NewGetPingParamsWithContext

func NewGetPingParamsWithContext(ctx context.Context) *GetPingParams

NewGetPingParamsWithContext creates a new GetPingParams object with the ability to set a context for a request.

func NewGetPingParamsWithHTTPClient

func NewGetPingParamsWithHTTPClient(client *http.Client) *GetPingParams

NewGetPingParamsWithHTTPClient creates a new GetPingParams object with the ability to set a custom HTTPClient for a request.

func NewGetPingParamsWithTimeout

func NewGetPingParamsWithTimeout(timeout time.Duration) *GetPingParams

NewGetPingParamsWithTimeout creates a new GetPingParams object with the ability to set a timeout on a request.

func (*GetPingParams) SetContext

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

SetContext adds the context to the get ping params

func (*GetPingParams) SetDefaults

func (o *GetPingParams) SetDefaults()

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

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

func (*GetPingParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get ping params

func (*GetPingParams) SetTimeout

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

SetTimeout adds the timeout to the get ping params

func (*GetPingParams) WithContext

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

WithContext adds the context to the get ping params

func (*GetPingParams) WithDefaults

func (o *GetPingParams) WithDefaults() *GetPingParams

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

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

func (*GetPingParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get ping params

func (*GetPingParams) WithTimeout

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

WithTimeout adds the timeout to the get ping params

func (*GetPingParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetPingReader

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

GetPingReader is a Reader for the GetPing structure.

func (*GetPingReader) ReadResponse

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

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL