Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type GetV1PingOK
- func (o *GetV1PingOK) Error() string
- func (o *GetV1PingOK) GetPayload() *models.PongEntity
- func (o *GetV1PingOK) IsClientError() bool
- func (o *GetV1PingOK) IsCode(code int) bool
- func (o *GetV1PingOK) IsRedirect() bool
- func (o *GetV1PingOK) IsServerError() bool
- func (o *GetV1PingOK) IsSuccess() bool
- func (o *GetV1PingOK) String() string
- type GetV1PingParams
- func (o *GetV1PingParams) SetContext(ctx context.Context)
- func (o *GetV1PingParams) SetDefaults()
- func (o *GetV1PingParams) SetHTTPClient(client *http.Client)
- func (o *GetV1PingParams) SetTimeout(timeout time.Duration)
- func (o *GetV1PingParams) WithContext(ctx context.Context) *GetV1PingParams
- func (o *GetV1PingParams) WithDefaults() *GetV1PingParams
- func (o *GetV1PingParams) WithHTTPClient(client *http.Client) *GetV1PingParams
- func (o *GetV1PingParams) WithTimeout(timeout time.Duration) *GetV1PingParams
- func (o *GetV1PingParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetV1PingReader
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) GetV1Ping ¶
func (a *Client) GetV1Ping(params *GetV1PingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetV1PingOK, error)
GetV1Ping pings
Simple endpoint to verify your API connection is working
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 {
GetV1Ping(params *GetV1PingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetV1PingOK, 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 GetV1PingOK ¶
type GetV1PingOK struct {
Payload *models.PongEntity
}
GetV1PingOK describes a response with status code 200, with default header values.
Simple endpoint to verify your API connection is working
func NewGetV1PingOK ¶
func NewGetV1PingOK() *GetV1PingOK
NewGetV1PingOK creates a GetV1PingOK with default headers values
func (*GetV1PingOK) Error ¶
func (o *GetV1PingOK) Error() string
func (*GetV1PingOK) GetPayload ¶
func (o *GetV1PingOK) GetPayload() *models.PongEntity
func (*GetV1PingOK) IsClientError ¶
func (o *GetV1PingOK) IsClientError() bool
IsClientError returns true when this get v1 ping o k response has a 4xx status code
func (*GetV1PingOK) IsCode ¶
func (o *GetV1PingOK) IsCode(code int) bool
IsCode returns true when this get v1 ping o k response a status code equal to that given
func (*GetV1PingOK) IsRedirect ¶
func (o *GetV1PingOK) IsRedirect() bool
IsRedirect returns true when this get v1 ping o k response has a 3xx status code
func (*GetV1PingOK) IsServerError ¶
func (o *GetV1PingOK) IsServerError() bool
IsServerError returns true when this get v1 ping o k response has a 5xx status code
func (*GetV1PingOK) IsSuccess ¶
func (o *GetV1PingOK) IsSuccess() bool
IsSuccess returns true when this get v1 ping o k response has a 2xx status code
func (*GetV1PingOK) String ¶
func (o *GetV1PingOK) String() string
type GetV1PingParams ¶
type GetV1PingParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetV1PingParams contains all the parameters to send to the API endpoint
for the get v1 ping operation. Typically these are written to a http.Request.
func NewGetV1PingParams ¶
func NewGetV1PingParams() *GetV1PingParams
NewGetV1PingParams creates a new GetV1PingParams 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 NewGetV1PingParamsWithContext ¶
func NewGetV1PingParamsWithContext(ctx context.Context) *GetV1PingParams
NewGetV1PingParamsWithContext creates a new GetV1PingParams object with the ability to set a context for a request.
func NewGetV1PingParamsWithHTTPClient ¶
func NewGetV1PingParamsWithHTTPClient(client *http.Client) *GetV1PingParams
NewGetV1PingParamsWithHTTPClient creates a new GetV1PingParams object with the ability to set a custom HTTPClient for a request.
func NewGetV1PingParamsWithTimeout ¶
func NewGetV1PingParamsWithTimeout(timeout time.Duration) *GetV1PingParams
NewGetV1PingParamsWithTimeout creates a new GetV1PingParams object with the ability to set a timeout on a request.
func (*GetV1PingParams) SetContext ¶
func (o *GetV1PingParams) SetContext(ctx context.Context)
SetContext adds the context to the get v1 ping params
func (*GetV1PingParams) SetDefaults ¶
func (o *GetV1PingParams) SetDefaults()
SetDefaults hydrates default values in the get v1 ping params (not the query body).
All values with no default are reset to their zero value.
func (*GetV1PingParams) SetHTTPClient ¶
func (o *GetV1PingParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get v1 ping params
func (*GetV1PingParams) SetTimeout ¶
func (o *GetV1PingParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get v1 ping params
func (*GetV1PingParams) WithContext ¶
func (o *GetV1PingParams) WithContext(ctx context.Context) *GetV1PingParams
WithContext adds the context to the get v1 ping params
func (*GetV1PingParams) WithDefaults ¶
func (o *GetV1PingParams) WithDefaults() *GetV1PingParams
WithDefaults hydrates default values in the get v1 ping params (not the query body).
All values with no default are reset to their zero value.
func (*GetV1PingParams) WithHTTPClient ¶
func (o *GetV1PingParams) WithHTTPClient(client *http.Client) *GetV1PingParams
WithHTTPClient adds the HTTPClient to the get v1 ping params
func (*GetV1PingParams) WithTimeout ¶
func (o *GetV1PingParams) WithTimeout(timeout time.Duration) *GetV1PingParams
WithTimeout adds the timeout to the get v1 ping params
func (*GetV1PingParams) WriteToRequest ¶
func (o *GetV1PingParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetV1PingReader ¶
type GetV1PingReader struct {
// contains filtered or unexported fields
}
GetV1PingReader is a Reader for the GetV1Ping structure.
func (*GetV1PingReader) ReadResponse ¶
func (o *GetV1PingReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files