Documentation
¶
Index ¶
- type Client
- func (a *Client) GetHealth(params *GetHealthParams, opts ...ClientOption) (*GetHealthOK, error)
- func (a *Client) GetLibraryStats(params *GetLibraryStatsParams, opts ...ClientOption) (*GetLibraryStatsOK, error)
- func (a *Client) GetVersion(params *GetVersionParams, opts ...ClientOption) (*GetVersionOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type ClientOption
- type ClientService
- type GetHealthOK
- type GetHealthOKBody
- type GetHealthParams
- func (o *GetHealthParams) SetContext(ctx context.Context)
- func (o *GetHealthParams) SetDefaults()
- func (o *GetHealthParams) SetHTTPClient(client *http.Client)
- func (o *GetHealthParams) SetTimeout(timeout time.Duration)
- func (o *GetHealthParams) WithContext(ctx context.Context) *GetHealthParams
- func (o *GetHealthParams) WithDefaults() *GetHealthParams
- func (o *GetHealthParams) WithHTTPClient(client *http.Client) *GetHealthParams
- func (o *GetHealthParams) WithTimeout(timeout time.Duration) *GetHealthParams
- func (o *GetHealthParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetHealthReader
- type GetLibraryStatsOK
- type GetLibraryStatsParams
- func NewGetLibraryStatsParams() *GetLibraryStatsParams
- func NewGetLibraryStatsParamsWithContext(ctx context.Context) *GetLibraryStatsParams
- func NewGetLibraryStatsParamsWithHTTPClient(client *http.Client) *GetLibraryStatsParams
- func NewGetLibraryStatsParamsWithTimeout(timeout time.Duration) *GetLibraryStatsParams
- func (o *GetLibraryStatsParams) SetContext(ctx context.Context)
- func (o *GetLibraryStatsParams) SetDefaults()
- func (o *GetLibraryStatsParams) SetHTTPClient(client *http.Client)
- func (o *GetLibraryStatsParams) SetTimeout(timeout time.Duration)
- func (o *GetLibraryStatsParams) WithContext(ctx context.Context) *GetLibraryStatsParams
- func (o *GetLibraryStatsParams) WithDefaults() *GetLibraryStatsParams
- func (o *GetLibraryStatsParams) WithHTTPClient(client *http.Client) *GetLibraryStatsParams
- func (o *GetLibraryStatsParams) WithTimeout(timeout time.Duration) *GetLibraryStatsParams
- func (o *GetLibraryStatsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetLibraryStatsReader
- type GetVersionOK
- type GetVersionParams
- func (o *GetVersionParams) SetContext(ctx context.Context)
- func (o *GetVersionParams) SetDefaults()
- func (o *GetVersionParams) SetHTTPClient(client *http.Client)
- func (o *GetVersionParams) SetTimeout(timeout time.Duration)
- func (o *GetVersionParams) WithContext(ctx context.Context) *GetVersionParams
- func (o *GetVersionParams) WithDefaults() *GetVersionParams
- func (o *GetVersionParams) WithHTTPClient(client *http.Client) *GetVersionParams
- func (o *GetVersionParams) WithTimeout(timeout time.Duration) *GetVersionParams
- func (o *GetVersionParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetVersionReader
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 base API
func (*Client) GetHealth ¶
func (a *Client) GetHealth(params *GetHealthParams, opts ...ClientOption) (*GetHealthOK, error)
GetHealth healths check
func (*Client) GetLibraryStats ¶
func (a *Client) GetLibraryStats(params *GetLibraryStatsParams, opts ...ClientOption) (*GetLibraryStatsOK, error)
GetLibraryStats services statistics
func (*Client) GetVersion ¶
func (a *Client) GetVersion(params *GetVersionParams, opts ...ClientOption) (*GetVersionOK, error)
GetVersion versions check
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 {
GetVersion(params *GetVersionParams, opts ...ClientOption) (*GetVersionOK, error)
GetHealth(params *GetHealthParams, opts ...ClientOption) (*GetHealthOK, error)
GetLibraryStats(params *GetLibraryStatsParams, opts ...ClientOption) (*GetLibraryStatsOK, 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 base API client.
type GetHealthOK ¶
type GetHealthOK struct {
Payload *GetHealthOKBody
}
GetHealthOK describes a response with status code 200, with default header values.
Success. API available
func NewGetHealthOK ¶
func NewGetHealthOK() *GetHealthOK
NewGetHealthOK creates a GetHealthOK with default headers values
func (*GetHealthOK) Error ¶
func (o *GetHealthOK) Error() string
func (*GetHealthOK) GetPayload ¶
func (o *GetHealthOK) GetPayload() *GetHealthOKBody
type GetHealthOKBody ¶
type GetHealthOKBody struct {
// Version of the exposed API
// Example: 1.0.0
APIVersion string `json:"apiVersion,omitempty"`
// The authenticated user, if any
// Example: example@example.com
User string `json:"user,omitempty"`
// Version of the library service
// Example: 1.0.0
Version string `json:"version,omitempty"`
}
GetHealthOKBody get health o k body swagger:model GetHealthOKBody
func (*GetHealthOKBody) ContextValidate ¶
ContextValidate validates this get health o k body based on context it is used
func (*GetHealthOKBody) MarshalBinary ¶
func (o *GetHealthOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetHealthOKBody) UnmarshalBinary ¶
func (o *GetHealthOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetHealthParams ¶
type GetHealthParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetHealthParams contains all the parameters to send to the API endpoint
for the get health operation. Typically these are written to a http.Request.
func NewGetHealthParams ¶
func NewGetHealthParams() *GetHealthParams
NewGetHealthParams creates a new GetHealthParams 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 NewGetHealthParamsWithContext ¶
func NewGetHealthParamsWithContext(ctx context.Context) *GetHealthParams
NewGetHealthParamsWithContext creates a new GetHealthParams object with the ability to set a context for a request.
func NewGetHealthParamsWithHTTPClient ¶
func NewGetHealthParamsWithHTTPClient(client *http.Client) *GetHealthParams
NewGetHealthParamsWithHTTPClient creates a new GetHealthParams object with the ability to set a custom HTTPClient for a request.
func NewGetHealthParamsWithTimeout ¶
func NewGetHealthParamsWithTimeout(timeout time.Duration) *GetHealthParams
NewGetHealthParamsWithTimeout creates a new GetHealthParams object with the ability to set a timeout on a request.
func (*GetHealthParams) SetContext ¶
func (o *GetHealthParams) SetContext(ctx context.Context)
SetContext adds the context to the get health params
func (*GetHealthParams) SetDefaults ¶
func (o *GetHealthParams) SetDefaults()
SetDefaults hydrates default values in the get health params (not the query body).
All values with no default are reset to their zero value.
func (*GetHealthParams) SetHTTPClient ¶
func (o *GetHealthParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get health params
func (*GetHealthParams) SetTimeout ¶
func (o *GetHealthParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get health params
func (*GetHealthParams) WithContext ¶
func (o *GetHealthParams) WithContext(ctx context.Context) *GetHealthParams
WithContext adds the context to the get health params
func (*GetHealthParams) WithDefaults ¶
func (o *GetHealthParams) WithDefaults() *GetHealthParams
WithDefaults hydrates default values in the get health params (not the query body).
All values with no default are reset to their zero value.
func (*GetHealthParams) WithHTTPClient ¶
func (o *GetHealthParams) WithHTTPClient(client *http.Client) *GetHealthParams
WithHTTPClient adds the HTTPClient to the get health params
func (*GetHealthParams) WithTimeout ¶
func (o *GetHealthParams) WithTimeout(timeout time.Duration) *GetHealthParams
WithTimeout adds the timeout to the get health params
func (*GetHealthParams) WriteToRequest ¶
func (o *GetHealthParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetHealthReader ¶
type GetHealthReader struct {
// contains filtered or unexported fields
}
GetHealthReader is a Reader for the GetHealth structure.
func (*GetHealthReader) ReadResponse ¶
func (o *GetHealthReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetLibraryStatsOK ¶
type GetLibraryStatsOK struct {
Payload *models.LibraryStatsResponse
}
GetLibraryStatsOK describes a response with status code 200, with default header values.
Success
func NewGetLibraryStatsOK ¶
func NewGetLibraryStatsOK() *GetLibraryStatsOK
NewGetLibraryStatsOK creates a GetLibraryStatsOK with default headers values
func (*GetLibraryStatsOK) Error ¶
func (o *GetLibraryStatsOK) Error() string
func (*GetLibraryStatsOK) GetPayload ¶
func (o *GetLibraryStatsOK) GetPayload() *models.LibraryStatsResponse
type GetLibraryStatsParams ¶
type GetLibraryStatsParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetLibraryStatsParams contains all the parameters to send to the API endpoint
for the get library stats operation. Typically these are written to a http.Request.
func NewGetLibraryStatsParams ¶
func NewGetLibraryStatsParams() *GetLibraryStatsParams
NewGetLibraryStatsParams creates a new GetLibraryStatsParams 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 NewGetLibraryStatsParamsWithContext ¶
func NewGetLibraryStatsParamsWithContext(ctx context.Context) *GetLibraryStatsParams
NewGetLibraryStatsParamsWithContext creates a new GetLibraryStatsParams object with the ability to set a context for a request.
func NewGetLibraryStatsParamsWithHTTPClient ¶
func NewGetLibraryStatsParamsWithHTTPClient(client *http.Client) *GetLibraryStatsParams
NewGetLibraryStatsParamsWithHTTPClient creates a new GetLibraryStatsParams object with the ability to set a custom HTTPClient for a request.
func NewGetLibraryStatsParamsWithTimeout ¶
func NewGetLibraryStatsParamsWithTimeout(timeout time.Duration) *GetLibraryStatsParams
NewGetLibraryStatsParamsWithTimeout creates a new GetLibraryStatsParams object with the ability to set a timeout on a request.
func (*GetLibraryStatsParams) SetContext ¶
func (o *GetLibraryStatsParams) SetContext(ctx context.Context)
SetContext adds the context to the get library stats params
func (*GetLibraryStatsParams) SetDefaults ¶
func (o *GetLibraryStatsParams) SetDefaults()
SetDefaults hydrates default values in the get library stats params (not the query body).
All values with no default are reset to their zero value.
func (*GetLibraryStatsParams) SetHTTPClient ¶
func (o *GetLibraryStatsParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get library stats params
func (*GetLibraryStatsParams) SetTimeout ¶
func (o *GetLibraryStatsParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get library stats params
func (*GetLibraryStatsParams) WithContext ¶
func (o *GetLibraryStatsParams) WithContext(ctx context.Context) *GetLibraryStatsParams
WithContext adds the context to the get library stats params
func (*GetLibraryStatsParams) WithDefaults ¶
func (o *GetLibraryStatsParams) WithDefaults() *GetLibraryStatsParams
WithDefaults hydrates default values in the get library stats params (not the query body).
All values with no default are reset to their zero value.
func (*GetLibraryStatsParams) WithHTTPClient ¶
func (o *GetLibraryStatsParams) WithHTTPClient(client *http.Client) *GetLibraryStatsParams
WithHTTPClient adds the HTTPClient to the get library stats params
func (*GetLibraryStatsParams) WithTimeout ¶
func (o *GetLibraryStatsParams) WithTimeout(timeout time.Duration) *GetLibraryStatsParams
WithTimeout adds the timeout to the get library stats params
func (*GetLibraryStatsParams) WriteToRequest ¶
func (o *GetLibraryStatsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetLibraryStatsReader ¶
type GetLibraryStatsReader struct {
// contains filtered or unexported fields
}
GetLibraryStatsReader is a Reader for the GetLibraryStats structure.
func (*GetLibraryStatsReader) ReadResponse ¶
func (o *GetLibraryStatsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetVersionOK ¶
type GetVersionOK struct {
Payload *models.VersionResponse
}
GetVersionOK describes a response with status code 200, with default header values.
Success.
func NewGetVersionOK ¶
func NewGetVersionOK() *GetVersionOK
NewGetVersionOK creates a GetVersionOK with default headers values
func (*GetVersionOK) Error ¶
func (o *GetVersionOK) Error() string
func (*GetVersionOK) GetPayload ¶
func (o *GetVersionOK) GetPayload() *models.VersionResponse
type GetVersionParams ¶
type GetVersionParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetVersionParams contains all the parameters to send to the API endpoint
for the get version operation. Typically these are written to a http.Request.
func NewGetVersionParams ¶
func NewGetVersionParams() *GetVersionParams
NewGetVersionParams creates a new GetVersionParams 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 NewGetVersionParamsWithContext ¶
func NewGetVersionParamsWithContext(ctx context.Context) *GetVersionParams
NewGetVersionParamsWithContext creates a new GetVersionParams object with the ability to set a context for a request.
func NewGetVersionParamsWithHTTPClient ¶
func NewGetVersionParamsWithHTTPClient(client *http.Client) *GetVersionParams
NewGetVersionParamsWithHTTPClient creates a new GetVersionParams object with the ability to set a custom HTTPClient for a request.
func NewGetVersionParamsWithTimeout ¶
func NewGetVersionParamsWithTimeout(timeout time.Duration) *GetVersionParams
NewGetVersionParamsWithTimeout creates a new GetVersionParams object with the ability to set a timeout on a request.
func (*GetVersionParams) SetContext ¶
func (o *GetVersionParams) SetContext(ctx context.Context)
SetContext adds the context to the get version params
func (*GetVersionParams) SetDefaults ¶
func (o *GetVersionParams) SetDefaults()
SetDefaults hydrates default values in the get version params (not the query body).
All values with no default are reset to their zero value.
func (*GetVersionParams) SetHTTPClient ¶
func (o *GetVersionParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get version params
func (*GetVersionParams) SetTimeout ¶
func (o *GetVersionParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get version params
func (*GetVersionParams) WithContext ¶
func (o *GetVersionParams) WithContext(ctx context.Context) *GetVersionParams
WithContext adds the context to the get version params
func (*GetVersionParams) WithDefaults ¶
func (o *GetVersionParams) WithDefaults() *GetVersionParams
WithDefaults hydrates default values in the get version params (not the query body).
All values with no default are reset to their zero value.
func (*GetVersionParams) WithHTTPClient ¶
func (o *GetVersionParams) WithHTTPClient(client *http.Client) *GetVersionParams
WithHTTPClient adds the HTTPClient to the get version params
func (*GetVersionParams) WithTimeout ¶
func (o *GetVersionParams) WithTimeout(timeout time.Duration) *GetVersionParams
WithTimeout adds the timeout to the get version params
func (*GetVersionParams) WriteToRequest ¶
func (o *GetVersionParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetVersionReader ¶
type GetVersionReader struct {
// contains filtered or unexported fields
}
GetVersionReader is a Reader for the GetVersion structure.
func (*GetVersionReader) ReadResponse ¶
func (o *GetVersionReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files