Documentation
¶
Index ¶
- type Client
- type ClientService
- type GetPingOK
- type GetPingParams
- func (o *GetPingParams) SetContext(ctx context.Context)
- 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) 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
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) (*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.
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶
type ClientService interface {
GetPing(params *GetPingParams, authInfo runtime.ClientAuthInfoWriter) (*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 handles this case with default header values.
The API server is alive
func NewGetPingOK ¶
func NewGetPingOK() *GetPingOK
NewGetPingOK creates a GetPingOK with default headers values
func (*GetPingOK) GetPayload ¶
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 values initialized.
func NewGetPingParamsWithContext ¶
func NewGetPingParamsWithContext(ctx context.Context) *GetPingParams
NewGetPingParamsWithContext creates a new GetPingParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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) 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.
Source Files