usage_management

package
v0.0.0-...-33e56a9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 24, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API interface {
	/*
	   GetSystemUsage detaileds report covering all accounts within the specified time window*/
	GetSystemUsage(ctx context.Context, params *GetSystemUsageParams) (*GetSystemUsageOK, error)
	/*
	   GetUsage detaileds report covering of the account associated with the id within the specified time window*/
	GetUsage(ctx context.Context, params *GetUsageParams) (*GetUsageOK, error)
	/*
	   GetUsageSummary summaries report meant for the UI for the resources linked to the reseller ID provided within the specified time window*/
	GetUsageSummary(ctx context.Context, params *GetUsageSummaryParams) (*GetUsageSummaryOK, error)
}

API is the interface of the usage management client

type Client 

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

Client for usage management API

func New 

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

New creates a new usage management API client.

func (*Client) GetSystemUsage 

func (a *Client) GetSystemUsage(ctx context.Context, params *GetSystemUsageParams) (*GetSystemUsageOK, error)

GetSystemUsage detaileds report covering all accounts within the specified time window

func (*Client) GetUsage 

func (a *Client) GetUsage(ctx context.Context, params *GetUsageParams) (*GetUsageOK, error)

GetUsage detaileds report covering of the account associated with the id within the specified time window

func (*Client) GetUsageSummary 

func (a *Client) GetUsageSummary(ctx context.Context, params *GetUsageSummaryParams) (*GetUsageSummaryOK, error)

GetUsageSummary summaries report meant for the UI for the resources linked to the reseller ID provided within the specified time window

type GetSystemUsageInternalServerError 

type GetSystemUsageInternalServerError struct {
	Payload *models.ErrorResponse
}

GetSystemUsageInternalServerError handles this case with default header values.

Something unexpected happend, error raised

func NewGetSystemUsageInternalServerError 

func NewGetSystemUsageInternalServerError() *GetSystemUsageInternalServerError

NewGetSystemUsageInternalServerError creates a GetSystemUsageInternalServerError with default headers values

func (*GetSystemUsageInternalServerError) Error 

func (o *GetSystemUsageInternalServerError) Error() string

func (*GetSystemUsageInternalServerError) GetPayload 

func (o *GetSystemUsageInternalServerError) GetPayload() *models.ErrorResponse

type GetSystemUsageOK 

type GetSystemUsageOK struct {
	Payload []*models.CReport
}

GetSystemUsageOK handles this case with default header values.

Description of a successfully operation

func NewGetSystemUsageOK 

func NewGetSystemUsageOK() *GetSystemUsageOK

NewGetSystemUsageOK creates a GetSystemUsageOK with default headers values

func (*GetSystemUsageOK) Error 

func (o *GetSystemUsageOK) Error() string

func (*GetSystemUsageOK) GetPayload 

func (o *GetSystemUsageOK) GetPayload() []*models.CReport

type GetSystemUsageParams 

type GetSystemUsageParams struct {

	/*From
	  Datetime from which to get the usage report

	*/
	From *strfmt.DateTime
	/*Idlist
	  List of ids to be queried

	*/
	Idlist *string
	/*Metric
	  Metric(s) to get the usage report

	*/
	Metric *string
	/*To
	  Datetime until which to get the usage report

	*/
	To *strfmt.DateTime

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetSystemUsageParams contains all the parameters to send to the API endpoint for the get system usage operation typically these are written to a http.Request

func NewGetSystemUsageParams 

func NewGetSystemUsageParams() *GetSystemUsageParams

NewGetSystemUsageParams creates a new GetSystemUsageParams object with the default values initialized.

func NewGetSystemUsageParamsWithContext 

func NewGetSystemUsageParamsWithContext(ctx context.Context) *GetSystemUsageParams

NewGetSystemUsageParamsWithContext creates a new GetSystemUsageParams object with the default values initialized, and the ability to set a context for a request

func NewGetSystemUsageParamsWithHTTPClient 

func NewGetSystemUsageParamsWithHTTPClient(client *http.Client) *GetSystemUsageParams

NewGetSystemUsageParamsWithHTTPClient creates a new GetSystemUsageParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetSystemUsageParamsWithTimeout 

func NewGetSystemUsageParamsWithTimeout(timeout time.Duration) *GetSystemUsageParams

NewGetSystemUsageParamsWithTimeout creates a new GetSystemUsageParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetSystemUsageParams) SetContext 

func (o *GetSystemUsageParams) SetContext(ctx context.Context)

SetContext adds the context to the get system usage params

func (*GetSystemUsageParams) SetFrom 

func (o *GetSystemUsageParams) SetFrom(from *strfmt.DateTime)

SetFrom adds the from to the get system usage params

func (*GetSystemUsageParams) SetHTTPClient 

func (o *GetSystemUsageParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get system usage params

func (*GetSystemUsageParams) SetIdlist 

func (o *GetSystemUsageParams) SetIdlist(idlist *string)

SetIdlist adds the idlist to the get system usage params

func (*GetSystemUsageParams) SetMetric 

func (o *GetSystemUsageParams) SetMetric(metric *string)

SetMetric adds the metric to the get system usage params

func (*GetSystemUsageParams) SetTimeout 

func (o *GetSystemUsageParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get system usage params

func (*GetSystemUsageParams) SetTo 

func (o *GetSystemUsageParams) SetTo(to *strfmt.DateTime)

SetTo adds the to to the get system usage params

func (*GetSystemUsageParams) WithContext 

func (o *GetSystemUsageParams) WithContext(ctx context.Context) *GetSystemUsageParams

WithContext adds the context to the get system usage params

func (*GetSystemUsageParams) WithFrom 

func (o *GetSystemUsageParams) WithFrom(from *strfmt.DateTime) *GetSystemUsageParams

WithFrom adds the from to the get system usage params

func (*GetSystemUsageParams) WithHTTPClient 

func (o *GetSystemUsageParams) WithHTTPClient(client *http.Client) *GetSystemUsageParams

WithHTTPClient adds the HTTPClient to the get system usage params

func (*GetSystemUsageParams) WithIdlist 

func (o *GetSystemUsageParams) WithIdlist(idlist *string) *GetSystemUsageParams

WithIdlist adds the idlist to the get system usage params

func (*GetSystemUsageParams) WithMetric 

func (o *GetSystemUsageParams) WithMetric(metric *string) *GetSystemUsageParams

WithMetric adds the metric to the get system usage params

func (*GetSystemUsageParams) WithTimeout 

func (o *GetSystemUsageParams) WithTimeout(timeout time.Duration) *GetSystemUsageParams

WithTimeout adds the timeout to the get system usage params

func (*GetSystemUsageParams) WithTo 

func (o *GetSystemUsageParams) WithTo(to *strfmt.DateTime) *GetSystemUsageParams

WithTo adds the to to the get system usage params

func (*GetSystemUsageParams) WriteToRequest 

func (o *GetSystemUsageParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetSystemUsageReader 

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

GetSystemUsageReader is a Reader for the GetSystemUsage structure.

func (*GetSystemUsageReader) ReadResponse 

func (o *GetSystemUsageReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetUsageInternalServerError 

type GetUsageInternalServerError struct {
	Payload *models.ErrorResponse
}

GetUsageInternalServerError handles this case with default header values.

Something unexpected happend, error raised

func NewGetUsageInternalServerError 

func NewGetUsageInternalServerError() *GetUsageInternalServerError

NewGetUsageInternalServerError creates a GetUsageInternalServerError with default headers values

func (*GetUsageInternalServerError) Error 

func (o *GetUsageInternalServerError) Error() string

func (*GetUsageInternalServerError) GetPayload 

func (o *GetUsageInternalServerError) GetPayload() *models.ErrorResponse

type GetUsageOK 

type GetUsageOK struct {
	Payload []*models.CReport
}

GetUsageOK handles this case with default header values.

Description of a successfully operation

func NewGetUsageOK 

func NewGetUsageOK() *GetUsageOK

NewGetUsageOK creates a GetUsageOK with default headers values

func (*GetUsageOK) Error 

func (o *GetUsageOK) Error() string

func (*GetUsageOK) GetPayload 

func (o *GetUsageOK) GetPayload() []*models.CReport

type GetUsageParams 

type GetUsageParams struct {

	/*From
	  Datetime from which to get the usage report

	*/
	From *strfmt.DateTime
	/*ID
	  Id of the account to be checked

	*/
	ID string
	/*Metric
	  Metric(s) to get the usage report

	*/
	Metric *string
	/*To
	  Datetime until which to get the usage report

	*/
	To *strfmt.DateTime

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetUsageParams contains all the parameters to send to the API endpoint for the get usage operation typically these are written to a http.Request

func NewGetUsageParams 

func NewGetUsageParams() *GetUsageParams

NewGetUsageParams creates a new GetUsageParams object with the default values initialized.

func NewGetUsageParamsWithContext 

func NewGetUsageParamsWithContext(ctx context.Context) *GetUsageParams

NewGetUsageParamsWithContext creates a new GetUsageParams object with the default values initialized, and the ability to set a context for a request

func NewGetUsageParamsWithHTTPClient 

func NewGetUsageParamsWithHTTPClient(client *http.Client) *GetUsageParams

NewGetUsageParamsWithHTTPClient creates a new GetUsageParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetUsageParamsWithTimeout 

func NewGetUsageParamsWithTimeout(timeout time.Duration) *GetUsageParams

NewGetUsageParamsWithTimeout creates a new GetUsageParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetUsageParams) SetContext 

func (o *GetUsageParams) SetContext(ctx context.Context)

SetContext adds the context to the get usage params

func (*GetUsageParams) SetFrom 

func (o *GetUsageParams) SetFrom(from *strfmt.DateTime)

SetFrom adds the from to the get usage params

func (*GetUsageParams) SetHTTPClient 

func (o *GetUsageParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get usage params

func (*GetUsageParams) SetID 

func (o *GetUsageParams) SetID(id string)

SetID adds the id to the get usage params

func (*GetUsageParams) SetMetric 

func (o *GetUsageParams) SetMetric(metric *string)

SetMetric adds the metric to the get usage params

func (*GetUsageParams) SetTimeout 

func (o *GetUsageParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get usage params

func (*GetUsageParams) SetTo 

func (o *GetUsageParams) SetTo(to *strfmt.DateTime)

SetTo adds the to to the get usage params

func (*GetUsageParams) WithContext 

func (o *GetUsageParams) WithContext(ctx context.Context) *GetUsageParams

WithContext adds the context to the get usage params

func (*GetUsageParams) WithFrom 

func (o *GetUsageParams) WithFrom(from *strfmt.DateTime) *GetUsageParams

WithFrom adds the from to the get usage params

func (*GetUsageParams) WithHTTPClient 

func (o *GetUsageParams) WithHTTPClient(client *http.Client) *GetUsageParams

WithHTTPClient adds the HTTPClient to the get usage params

func (*GetUsageParams) WithID 

func (o *GetUsageParams) WithID(id string) *GetUsageParams

WithID adds the id to the get usage params

func (*GetUsageParams) WithMetric 

func (o *GetUsageParams) WithMetric(metric *string) *GetUsageParams

WithMetric adds the metric to the get usage params

func (*GetUsageParams) WithTimeout 

func (o *GetUsageParams) WithTimeout(timeout time.Duration) *GetUsageParams

WithTimeout adds the timeout to the get usage params

func (*GetUsageParams) WithTo 

func (o *GetUsageParams) WithTo(to *strfmt.DateTime) *GetUsageParams

WithTo adds the to to the get usage params

func (*GetUsageParams) WriteToRequest 

func (o *GetUsageParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetUsageReader 

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

GetUsageReader is a Reader for the GetUsage structure.

func (*GetUsageReader) ReadResponse 

func (o *GetUsageReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetUsageSummaryInternalServerError 

type GetUsageSummaryInternalServerError struct {
	Payload *models.ErrorResponse
}

GetUsageSummaryInternalServerError handles this case with default header values.

Something unexpected happend, error raised

func NewGetUsageSummaryInternalServerError 

func NewGetUsageSummaryInternalServerError() *GetUsageSummaryInternalServerError

NewGetUsageSummaryInternalServerError creates a GetUsageSummaryInternalServerError with default headers values

func (*GetUsageSummaryInternalServerError) Error 

func (o *GetUsageSummaryInternalServerError) Error() string

func (*GetUsageSummaryInternalServerError) GetPayload 

func (o *GetUsageSummaryInternalServerError) GetPayload() *models.ErrorResponse

type GetUsageSummaryOK 

type GetUsageSummaryOK struct {
	Payload *models.UISummary
}

GetUsageSummaryOK handles this case with default header values.

Description of a successfully operation

func NewGetUsageSummaryOK 

func NewGetUsageSummaryOK() *GetUsageSummaryOK

NewGetUsageSummaryOK creates a GetUsageSummaryOK with default headers values

func (*GetUsageSummaryOK) Error 

func (o *GetUsageSummaryOK) Error() string

func (*GetUsageSummaryOK) GetPayload 

func (o *GetUsageSummaryOK) GetPayload() *models.UISummary

type GetUsageSummaryParams 

type GetUsageSummaryParams struct {

	/*From
	  Datetime from which to get the usage report

	*/
	From *strfmt.DateTime
	/*ID
	  Id of the reseller to be checked

	*/
	ID string
	/*To
	  Datetime until which to get the usage report

	*/
	To *strfmt.DateTime

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetUsageSummaryParams contains all the parameters to send to the API endpoint for the get usage summary operation typically these are written to a http.Request

func NewGetUsageSummaryParams 

func NewGetUsageSummaryParams() *GetUsageSummaryParams

NewGetUsageSummaryParams creates a new GetUsageSummaryParams object with the default values initialized.

func NewGetUsageSummaryParamsWithContext 

func NewGetUsageSummaryParamsWithContext(ctx context.Context) *GetUsageSummaryParams

NewGetUsageSummaryParamsWithContext creates a new GetUsageSummaryParams object with the default values initialized, and the ability to set a context for a request

func NewGetUsageSummaryParamsWithHTTPClient 

func NewGetUsageSummaryParamsWithHTTPClient(client *http.Client) *GetUsageSummaryParams

NewGetUsageSummaryParamsWithHTTPClient creates a new GetUsageSummaryParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetUsageSummaryParamsWithTimeout 

func NewGetUsageSummaryParamsWithTimeout(timeout time.Duration) *GetUsageSummaryParams

NewGetUsageSummaryParamsWithTimeout creates a new GetUsageSummaryParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetUsageSummaryParams) SetContext 

func (o *GetUsageSummaryParams) SetContext(ctx context.Context)

SetContext adds the context to the get usage summary params

func (*GetUsageSummaryParams) SetFrom 

func (o *GetUsageSummaryParams) SetFrom(from *strfmt.DateTime)

SetFrom adds the from to the get usage summary params

func (*GetUsageSummaryParams) SetHTTPClient 

func (o *GetUsageSummaryParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get usage summary params

func (*GetUsageSummaryParams) SetID 

func (o *GetUsageSummaryParams) SetID(id string)

SetID adds the id to the get usage summary params

func (*GetUsageSummaryParams) SetTimeout 

func (o *GetUsageSummaryParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get usage summary params

func (*GetUsageSummaryParams) SetTo 

func (o *GetUsageSummaryParams) SetTo(to *strfmt.DateTime)

SetTo adds the to to the get usage summary params

func (*GetUsageSummaryParams) WithContext 

func (o *GetUsageSummaryParams) WithContext(ctx context.Context) *GetUsageSummaryParams

WithContext adds the context to the get usage summary params

func (*GetUsageSummaryParams) WithFrom 

func (o *GetUsageSummaryParams) WithFrom(from *strfmt.DateTime) *GetUsageSummaryParams

WithFrom adds the from to the get usage summary params

func (*GetUsageSummaryParams) WithHTTPClient 

func (o *GetUsageSummaryParams) WithHTTPClient(client *http.Client) *GetUsageSummaryParams

WithHTTPClient adds the HTTPClient to the get usage summary params

func (*GetUsageSummaryParams) WithID 

func (o *GetUsageSummaryParams) WithID(id string) *GetUsageSummaryParams

WithID adds the id to the get usage summary params

func (*GetUsageSummaryParams) WithTimeout 

func (o *GetUsageSummaryParams) WithTimeout(timeout time.Duration) *GetUsageSummaryParams

WithTimeout adds the timeout to the get usage summary params

func (*GetUsageSummaryParams) WithTo 

func (o *GetUsageSummaryParams) WithTo(to *strfmt.DateTime) *GetUsageSummaryParams

WithTo adds the to to the get usage summary params

func (*GetUsageSummaryParams) WriteToRequest 

func (o *GetUsageSummaryParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetUsageSummaryReader 

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

GetUsageSummaryReader is a Reader for the GetUsageSummary structure.

func (*GetUsageSummaryReader) ReadResponse 

func (o *GetUsageSummaryReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.