ping

Documentation

Index

• type API
• type Client
  • func New(transport runtime.ClientTransport, formats strfmt.Registry, ...) *Client
  • func (a *Client) GetPing(ctx context.Context, params *GetPingParams) (*GetPingOK, error)
• type GetPingOK
  • func NewGetPingOK() *GetPingOK
  • func (o *GetPingOK) Error() string
  • func (o *GetPingOK) GetPayload() string
  • func (o *GetPingOK) IsClientError() bool
  • func (o *GetPingOK) IsCode(code int) bool
  • func (o *GetPingOK) IsRedirect() bool
  • func (o *GetPingOK) IsServerError() bool
  • func (o *GetPingOK) IsSuccess() bool
  • func (o *GetPingOK) String() string
• type GetPingParams
  • func NewGetPingParams() *GetPingParams
  • func NewGetPingParamsWithContext(ctx context.Context) *GetPingParams
  • func NewGetPingParamsWithHTTPClient(client *http.Client) *GetPingParams
  • func NewGetPingParamsWithTimeout(timeout time.Duration) *GetPingParams
  • func (o *GetPingParams) SetContext(ctx context.Context)
  • func (o *GetPingParams) SetDefaults()
  • func (o *GetPingParams) SetHTTPClient(client *http.Client)
  • func (o *GetPingParams) SetTimeout(timeout time.Duration)
  • func (o *GetPingParams) SetXRequestID(xRequestID *string)
  • func (o *GetPingParams) WithContext(ctx context.Context) *GetPingParams
  • func (o *GetPingParams) WithDefaults() *GetPingParams
  • func (o *GetPingParams) WithHTTPClient(client *http.Client) *GetPingParams
  • func (o *GetPingParams) WithTimeout(timeout time.Duration) *GetPingParams
  • func (o *GetPingParams) WithXRequestID(xRequestID *string) *GetPingParams
  • func (o *GetPingParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type GetPingReader
  • func (o *GetPingReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type API

type API interface {
	/*
	   GetPing pings harbor to check if the API server is alive

	   This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components. This path does not require any authentication.*/
	GetPing(ctx context.Context, params *GetPingParams) (*GetPingOK, error)
}

API is the interface of the ping client

type Client

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

Client for ping API

func New

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

New creates a new ping API client.

func (*Client) GetPing

func (a *Client) GetPing(ctx context.Context, params *GetPingParams) (*GetPingOK, error)

GetPing pings harbor to check if the API server is alive

This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components. This path does not require any authentication.

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

func (*GetPingOK) IsClientError

func (o *GetPingOK) IsClientError() bool

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

func (*GetPingOK) IsCode

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

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

func (*GetPingOK) IsRedirect

func (o *GetPingOK) IsRedirect() bool

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

func (*GetPingOK) IsServerError

func (o *GetPingOK) IsServerError() bool

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

func (*GetPingOK) IsSuccess

func (o *GetPingOK) IsSuccess() bool

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

func (*GetPingOK) String

func (o *GetPingOK) String() string

type GetPingParams

type GetPingParams struct {

	/* XRequestID.

	   An unique ID for the request
	*/
	XRequestID *string

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

func (o *GetPingParams) SetXRequestID(xRequestID *string)

SetXRequestID adds the xRequestId 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) WithXRequestID

func (o *GetPingParams) WithXRequestID(xRequestID *string) *GetPingParams

WithXRequestID adds the xRequestID 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.