Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type GetInfoForbidden
- type GetInfoOK
- type GetInfoParams
- func (o *GetInfoParams) SetContext(ctx context.Context)
- func (o *GetInfoParams) SetDefaults()
- func (o *GetInfoParams) SetHTTPClient(client *http.Client)
- func (o *GetInfoParams) SetTimeout(timeout time.Duration)
- func (o *GetInfoParams) SetValue(value *string)
- func (o *GetInfoParams) WithContext(ctx context.Context) *GetInfoParams
- func (o *GetInfoParams) WithDefaults() *GetInfoParams
- func (o *GetInfoParams) WithHTTPClient(client *http.Client) *GetInfoParams
- func (o *GetInfoParams) WithTimeout(timeout time.Duration) *GetInfoParams
- func (o *GetInfoParams) WithValue(value *string) *GetInfoParams
- func (o *GetInfoParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetInfoReader
- type GetInfoUnauthorized
- type UsageBadRequest
- type UsageForbidden
- type UsageOK
- type UsageParams
- func (o *UsageParams) SetContext(ctx context.Context)
- func (o *UsageParams) SetDefaults()
- func (o *UsageParams) SetGrouping(grouping *string)
- func (o *UsageParams) SetHTTPClient(client *http.Client)
- func (o *UsageParams) SetIncludeActivators(includeActivators *bool)
- func (o *UsageParams) SetLimit(limit *int64)
- func (o *UsageParams) SetTimeout(timeout time.Duration)
- func (o *UsageParams) WithContext(ctx context.Context) *UsageParams
- func (o *UsageParams) WithDefaults() *UsageParams
- func (o *UsageParams) WithGrouping(grouping *string) *UsageParams
- func (o *UsageParams) WithHTTPClient(client *http.Client) *UsageParams
- func (o *UsageParams) WithIncludeActivators(includeActivators *bool) *UsageParams
- func (o *UsageParams) WithLimit(limit *int64) *UsageParams
- func (o *UsageParams) WithTimeout(timeout time.Duration) *UsageParams
- func (o *UsageParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type UsageReader
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 status API
func (*Client) GetInfo ¶
func (a *Client) GetInfo(params *GetInfoParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetInfoOK, error)
GetInfo tests method for developer testing
Helpful for testing JWT operation
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
func (*Client) Usage ¶
func (a *Client) Usage(params *UsageParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UsageOK, error)
Usage reports platform usage statistics
Active users by date range
type ClientOption ¶
type ClientOption func(*runtime.ClientOperation)
ClientOption is the option for Client methods
type ClientService ¶
type ClientService interface {
GetInfo(params *GetInfoParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetInfoOK, error)
Usage(params *UsageParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UsageOK, 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 status API client.
type GetInfoForbidden ¶
type GetInfoForbidden struct {
Payload *mono_models.Message
}
GetInfoForbidden describes a response with status code 403, with default header values.
Unauthorized
func NewGetInfoForbidden ¶
func NewGetInfoForbidden() *GetInfoForbidden
NewGetInfoForbidden creates a GetInfoForbidden with default headers values
func (*GetInfoForbidden) Error ¶
func (o *GetInfoForbidden) Error() string
func (*GetInfoForbidden) GetPayload ¶
func (o *GetInfoForbidden) GetPayload() *mono_models.Message
type GetInfoOK ¶
type GetInfoOK struct {
Payload *mono_models.SysInfo
}
GetInfoOK describes a response with status code 200, with default header values.
Success
func NewGetInfoOK ¶
func NewGetInfoOK() *GetInfoOK
NewGetInfoOK creates a GetInfoOK with default headers values
func (*GetInfoOK) GetPayload ¶
func (o *GetInfoOK) GetPayload() *mono_models.SysInfo
type GetInfoParams ¶
type GetInfoParams struct {
/* Value.
Whatever you like
*/
Value *string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetInfoParams contains all the parameters to send to the API endpoint
for the get info operation. Typically these are written to a http.Request.
func NewGetInfoParams ¶
func NewGetInfoParams() *GetInfoParams
NewGetInfoParams creates a new GetInfoParams 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 NewGetInfoParamsWithContext ¶
func NewGetInfoParamsWithContext(ctx context.Context) *GetInfoParams
NewGetInfoParamsWithContext creates a new GetInfoParams object with the ability to set a context for a request.
func NewGetInfoParamsWithHTTPClient ¶
func NewGetInfoParamsWithHTTPClient(client *http.Client) *GetInfoParams
NewGetInfoParamsWithHTTPClient creates a new GetInfoParams object with the ability to set a custom HTTPClient for a request.
func NewGetInfoParamsWithTimeout ¶
func NewGetInfoParamsWithTimeout(timeout time.Duration) *GetInfoParams
NewGetInfoParamsWithTimeout creates a new GetInfoParams object with the ability to set a timeout on a request.
func (*GetInfoParams) SetContext ¶
func (o *GetInfoParams) SetContext(ctx context.Context)
SetContext adds the context to the get info params
func (*GetInfoParams) SetDefaults ¶
func (o *GetInfoParams) SetDefaults()
SetDefaults hydrates default values in the get info params (not the query body).
All values with no default are reset to their zero value.
func (*GetInfoParams) SetHTTPClient ¶
func (o *GetInfoParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get info params
func (*GetInfoParams) SetTimeout ¶
func (o *GetInfoParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get info params
func (*GetInfoParams) SetValue ¶
func (o *GetInfoParams) SetValue(value *string)
SetValue adds the value to the get info params
func (*GetInfoParams) WithContext ¶
func (o *GetInfoParams) WithContext(ctx context.Context) *GetInfoParams
WithContext adds the context to the get info params
func (*GetInfoParams) WithDefaults ¶
func (o *GetInfoParams) WithDefaults() *GetInfoParams
WithDefaults hydrates default values in the get info params (not the query body).
All values with no default are reset to their zero value.
func (*GetInfoParams) WithHTTPClient ¶
func (o *GetInfoParams) WithHTTPClient(client *http.Client) *GetInfoParams
WithHTTPClient adds the HTTPClient to the get info params
func (*GetInfoParams) WithTimeout ¶
func (o *GetInfoParams) WithTimeout(timeout time.Duration) *GetInfoParams
WithTimeout adds the timeout to the get info params
func (*GetInfoParams) WithValue ¶
func (o *GetInfoParams) WithValue(value *string) *GetInfoParams
WithValue adds the value to the get info params
func (*GetInfoParams) WriteToRequest ¶
func (o *GetInfoParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetInfoReader ¶
type GetInfoReader struct {
// contains filtered or unexported fields
}
GetInfoReader is a Reader for the GetInfo structure.
func (*GetInfoReader) ReadResponse ¶
func (o *GetInfoReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetInfoUnauthorized ¶
type GetInfoUnauthorized struct {
}
GetInfoUnauthorized describes a response with status code 401, with default header values.
Unauthenticated
func NewGetInfoUnauthorized ¶
func NewGetInfoUnauthorized() *GetInfoUnauthorized
NewGetInfoUnauthorized creates a GetInfoUnauthorized with default headers values
func (*GetInfoUnauthorized) Error ¶
func (o *GetInfoUnauthorized) Error() string
func (*GetInfoUnauthorized) GetPayload ¶
func (o *GetInfoUnauthorized) GetPayload() *mono_models.Message
type UsageBadRequest ¶
type UsageBadRequest struct {
Payload *mono_models.Message
}
UsageBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewUsageBadRequest ¶
func NewUsageBadRequest() *UsageBadRequest
NewUsageBadRequest creates a UsageBadRequest with default headers values
func (*UsageBadRequest) Error ¶
func (o *UsageBadRequest) Error() string
func (*UsageBadRequest) GetPayload ¶
func (o *UsageBadRequest) GetPayload() *mono_models.Message
type UsageForbidden ¶
type UsageForbidden struct {
Payload *mono_models.Message
}
UsageForbidden describes a response with status code 403, with default header values.
Unauthorized
func NewUsageForbidden ¶
func NewUsageForbidden() *UsageForbidden
NewUsageForbidden creates a UsageForbidden with default headers values
func (*UsageForbidden) Error ¶
func (o *UsageForbidden) Error() string
func (*UsageForbidden) GetPayload ¶
func (o *UsageForbidden) GetPayload() *mono_models.Message
type UsageOK ¶
type UsageOK struct {
Payload *mono_models.UsageInfo
}
UsageOK describes a response with status code 200, with default header values.
Success
func NewUsageOK ¶
func NewUsageOK() *UsageOK
NewUsageOK creates a UsageOK with default headers values
func (*UsageOK) GetPayload ¶
func (o *UsageOK) GetPayload() *mono_models.UsageInfo
type UsageParams ¶
type UsageParams struct {
/* Grouping.
Desired grouping (day, week, month, year)
*/
Grouping *string
/* IncludeActivators.
Include Activators in user counts
*/
IncludeActivators *bool
/* Limit.
Number of periods to look back
*/
Limit *int64
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
UsageParams contains all the parameters to send to the API endpoint
for the usage operation. Typically these are written to a http.Request.
func NewUsageParams ¶
func NewUsageParams() *UsageParams
NewUsageParams creates a new UsageParams 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 NewUsageParamsWithContext ¶
func NewUsageParamsWithContext(ctx context.Context) *UsageParams
NewUsageParamsWithContext creates a new UsageParams object with the ability to set a context for a request.
func NewUsageParamsWithHTTPClient ¶
func NewUsageParamsWithHTTPClient(client *http.Client) *UsageParams
NewUsageParamsWithHTTPClient creates a new UsageParams object with the ability to set a custom HTTPClient for a request.
func NewUsageParamsWithTimeout ¶
func NewUsageParamsWithTimeout(timeout time.Duration) *UsageParams
NewUsageParamsWithTimeout creates a new UsageParams object with the ability to set a timeout on a request.
func (*UsageParams) SetContext ¶
func (o *UsageParams) SetContext(ctx context.Context)
SetContext adds the context to the usage params
func (*UsageParams) SetDefaults ¶
func (o *UsageParams) SetDefaults()
SetDefaults hydrates default values in the usage params (not the query body).
All values with no default are reset to their zero value.
func (*UsageParams) SetGrouping ¶
func (o *UsageParams) SetGrouping(grouping *string)
SetGrouping adds the grouping to the usage params
func (*UsageParams) SetHTTPClient ¶
func (o *UsageParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the usage params
func (*UsageParams) SetIncludeActivators ¶
func (o *UsageParams) SetIncludeActivators(includeActivators *bool)
SetIncludeActivators adds the includeActivators to the usage params
func (*UsageParams) SetLimit ¶
func (o *UsageParams) SetLimit(limit *int64)
SetLimit adds the limit to the usage params
func (*UsageParams) SetTimeout ¶
func (o *UsageParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the usage params
func (*UsageParams) WithContext ¶
func (o *UsageParams) WithContext(ctx context.Context) *UsageParams
WithContext adds the context to the usage params
func (*UsageParams) WithDefaults ¶
func (o *UsageParams) WithDefaults() *UsageParams
WithDefaults hydrates default values in the usage params (not the query body).
All values with no default are reset to their zero value.
func (*UsageParams) WithGrouping ¶
func (o *UsageParams) WithGrouping(grouping *string) *UsageParams
WithGrouping adds the grouping to the usage params
func (*UsageParams) WithHTTPClient ¶
func (o *UsageParams) WithHTTPClient(client *http.Client) *UsageParams
WithHTTPClient adds the HTTPClient to the usage params
func (*UsageParams) WithIncludeActivators ¶
func (o *UsageParams) WithIncludeActivators(includeActivators *bool) *UsageParams
WithIncludeActivators adds the includeActivators to the usage params
func (*UsageParams) WithLimit ¶
func (o *UsageParams) WithLimit(limit *int64) *UsageParams
WithLimit adds the limit to the usage params
func (*UsageParams) WithTimeout ¶
func (o *UsageParams) WithTimeout(timeout time.Duration) *UsageParams
WithTimeout adds the timeout to the usage params
func (*UsageParams) WriteToRequest ¶
func (o *UsageParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type UsageReader ¶
type UsageReader struct {
// contains filtered or unexported fields
}
UsageReader is a Reader for the Usage structure.
func (*UsageReader) ReadResponse ¶
func (o *UsageReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files