sensor_usage_api

package
v0.9.0 Latest Latest
Warning

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

 Go to latest Published: Nov 13, 2024 License: MIT Imports: 11 Imported by: 0

Documentation

Index

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 sensor usage api API

func (*Client) GetSensorUsageWeekly 

func (a *Client) GetSensorUsageWeekly(params *GetSensorUsageWeeklyParams, opts ...ClientOption) (*GetSensorUsageWeeklyOK, error)

GetSensorUsageWeekly fetches weekly average each data point represents the average of how many unique a i ds were seen per week for the previous 28 days

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 {
	GetSensorUsageWeekly(params *GetSensorUsageWeeklyParams, opts ...ClientOption) (*GetSensorUsageWeeklyOK, 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 sensor usage api API client.

type GetSensorUsageWeeklyBadRequest 

type GetSensorUsageWeeklyBadRequest struct {

	/* Trace-ID: submit to support if resolving an issue
	 */
	XCSTRACEID string

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.APIHourlyAverageResponse
}

GetSensorUsageWeeklyBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewGetSensorUsageWeeklyBadRequest 

func NewGetSensorUsageWeeklyBadRequest() *GetSensorUsageWeeklyBadRequest

NewGetSensorUsageWeeklyBadRequest creates a GetSensorUsageWeeklyBadRequest with default headers values

func (*GetSensorUsageWeeklyBadRequest) Code 

func (o *GetSensorUsageWeeklyBadRequest) Code() int

Code gets the status code for the get sensor usage weekly bad request response

func (*GetSensorUsageWeeklyBadRequest) Error 

func (o *GetSensorUsageWeeklyBadRequest) Error() string

func (*GetSensorUsageWeeklyBadRequest) GetPayload 

func (o *GetSensorUsageWeeklyBadRequest) GetPayload() *models.APIHourlyAverageResponse

func (*GetSensorUsageWeeklyBadRequest) IsClientError 

func (o *GetSensorUsageWeeklyBadRequest) IsClientError() bool

IsClientError returns true when this get sensor usage weekly bad request response has a 4xx status code

func (*GetSensorUsageWeeklyBadRequest) IsCode 

func (o *GetSensorUsageWeeklyBadRequest) IsCode(code int) bool

IsCode returns true when this get sensor usage weekly bad request response a status code equal to that given

func (*GetSensorUsageWeeklyBadRequest) IsRedirect 

func (o *GetSensorUsageWeeklyBadRequest) IsRedirect() bool

IsRedirect returns true when this get sensor usage weekly bad request response has a 3xx status code

func (*GetSensorUsageWeeklyBadRequest) IsServerError 

func (o *GetSensorUsageWeeklyBadRequest) IsServerError() bool

IsServerError returns true when this get sensor usage weekly bad request response has a 5xx status code

func (*GetSensorUsageWeeklyBadRequest) IsSuccess 

func (o *GetSensorUsageWeeklyBadRequest) IsSuccess() bool

IsSuccess returns true when this get sensor usage weekly bad request response has a 2xx status code

func (*GetSensorUsageWeeklyBadRequest) String 

func (o *GetSensorUsageWeeklyBadRequest) String() string

type GetSensorUsageWeeklyForbidden 

type GetSensorUsageWeeklyForbidden struct {

	/* Trace-ID: submit to support if resolving an issue
	 */
	XCSTRACEID string

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.APIHourlyAverageResponse
}

GetSensorUsageWeeklyForbidden describes a response with status code 403, with default header values.

Forbidden

func NewGetSensorUsageWeeklyForbidden 

func NewGetSensorUsageWeeklyForbidden() *GetSensorUsageWeeklyForbidden

NewGetSensorUsageWeeklyForbidden creates a GetSensorUsageWeeklyForbidden with default headers values

func (*GetSensorUsageWeeklyForbidden) Code 

func (o *GetSensorUsageWeeklyForbidden) Code() int

Code gets the status code for the get sensor usage weekly forbidden response

func (*GetSensorUsageWeeklyForbidden) Error 

func (o *GetSensorUsageWeeklyForbidden) Error() string

func (*GetSensorUsageWeeklyForbidden) GetPayload 

func (o *GetSensorUsageWeeklyForbidden) GetPayload() *models.APIHourlyAverageResponse

func (*GetSensorUsageWeeklyForbidden) IsClientError 

func (o *GetSensorUsageWeeklyForbidden) IsClientError() bool

IsClientError returns true when this get sensor usage weekly forbidden response has a 4xx status code

func (*GetSensorUsageWeeklyForbidden) IsCode 

func (o *GetSensorUsageWeeklyForbidden) IsCode(code int) bool

IsCode returns true when this get sensor usage weekly forbidden response a status code equal to that given

func (*GetSensorUsageWeeklyForbidden) IsRedirect 

func (o *GetSensorUsageWeeklyForbidden) IsRedirect() bool

IsRedirect returns true when this get sensor usage weekly forbidden response has a 3xx status code

func (*GetSensorUsageWeeklyForbidden) IsServerError 

func (o *GetSensorUsageWeeklyForbidden) IsServerError() bool

IsServerError returns true when this get sensor usage weekly forbidden response has a 5xx status code

func (*GetSensorUsageWeeklyForbidden) IsSuccess 

func (o *GetSensorUsageWeeklyForbidden) IsSuccess() bool

IsSuccess returns true when this get sensor usage weekly forbidden response has a 2xx status code

func (*GetSensorUsageWeeklyForbidden) String 

func (o *GetSensorUsageWeeklyForbidden) String() string

type GetSensorUsageWeeklyInternalServerError 

type GetSensorUsageWeeklyInternalServerError struct {

	/* Trace-ID: submit to support if resolving an issue
	 */
	XCSTRACEID string

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.APIHourlyAverageResponse
}

GetSensorUsageWeeklyInternalServerError describes a response with status code 500, with default header values.

Internal Server Error

func NewGetSensorUsageWeeklyInternalServerError 

func NewGetSensorUsageWeeklyInternalServerError() *GetSensorUsageWeeklyInternalServerError

NewGetSensorUsageWeeklyInternalServerError creates a GetSensorUsageWeeklyInternalServerError with default headers values

func (*GetSensorUsageWeeklyInternalServerError) Code 

func (o *GetSensorUsageWeeklyInternalServerError) Code() int

Code gets the status code for the get sensor usage weekly internal server error response

func (*GetSensorUsageWeeklyInternalServerError) Error 

func (o *GetSensorUsageWeeklyInternalServerError) Error() string

func (*GetSensorUsageWeeklyInternalServerError) GetPayload 

func (o *GetSensorUsageWeeklyInternalServerError) GetPayload() *models.APIHourlyAverageResponse

func (*GetSensorUsageWeeklyInternalServerError) IsClientError 

func (o *GetSensorUsageWeeklyInternalServerError) IsClientError() bool

IsClientError returns true when this get sensor usage weekly internal server error response has a 4xx status code

func (*GetSensorUsageWeeklyInternalServerError) IsCode 

func (o *GetSensorUsageWeeklyInternalServerError) IsCode(code int) bool

IsCode returns true when this get sensor usage weekly internal server error response a status code equal to that given

func (*GetSensorUsageWeeklyInternalServerError) IsRedirect 

func (o *GetSensorUsageWeeklyInternalServerError) IsRedirect() bool

IsRedirect returns true when this get sensor usage weekly internal server error response has a 3xx status code

func (*GetSensorUsageWeeklyInternalServerError) IsServerError 

func (o *GetSensorUsageWeeklyInternalServerError) IsServerError() bool

IsServerError returns true when this get sensor usage weekly internal server error response has a 5xx status code

func (*GetSensorUsageWeeklyInternalServerError) IsSuccess 

func (o *GetSensorUsageWeeklyInternalServerError) IsSuccess() bool

IsSuccess returns true when this get sensor usage weekly internal server error response has a 2xx status code

func (*GetSensorUsageWeeklyInternalServerError) String 

func (o *GetSensorUsageWeeklyInternalServerError) String() string

type GetSensorUsageWeeklyOK 

type GetSensorUsageWeeklyOK struct {

	/* Trace-ID: submit to support if resolving an issue
	 */
	XCSTRACEID string

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	Payload *models.APIWeeklyAverageResponse
}

GetSensorUsageWeeklyOK describes a response with status code 200, with default header values.

OK

func NewGetSensorUsageWeeklyOK 

func NewGetSensorUsageWeeklyOK() *GetSensorUsageWeeklyOK

NewGetSensorUsageWeeklyOK creates a GetSensorUsageWeeklyOK with default headers values

func (*GetSensorUsageWeeklyOK) Code 

func (o *GetSensorUsageWeeklyOK) Code() int

Code gets the status code for the get sensor usage weekly o k response

func (*GetSensorUsageWeeklyOK) Error 

func (o *GetSensorUsageWeeklyOK) Error() string

func (*GetSensorUsageWeeklyOK) GetPayload 

func (o *GetSensorUsageWeeklyOK) GetPayload() *models.APIWeeklyAverageResponse

func (*GetSensorUsageWeeklyOK) IsClientError 

func (o *GetSensorUsageWeeklyOK) IsClientError() bool

IsClientError returns true when this get sensor usage weekly o k response has a 4xx status code

func (*GetSensorUsageWeeklyOK) IsCode 

func (o *GetSensorUsageWeeklyOK) IsCode(code int) bool

IsCode returns true when this get sensor usage weekly o k response a status code equal to that given

func (*GetSensorUsageWeeklyOK) IsRedirect 

func (o *GetSensorUsageWeeklyOK) IsRedirect() bool

IsRedirect returns true when this get sensor usage weekly o k response has a 3xx status code

func (*GetSensorUsageWeeklyOK) IsServerError 

func (o *GetSensorUsageWeeklyOK) IsServerError() bool

IsServerError returns true when this get sensor usage weekly o k response has a 5xx status code

func (*GetSensorUsageWeeklyOK) IsSuccess 

func (o *GetSensorUsageWeeklyOK) IsSuccess() bool

IsSuccess returns true when this get sensor usage weekly o k response has a 2xx status code

func (*GetSensorUsageWeeklyOK) String 

func (o *GetSensorUsageWeeklyOK) String() string

type GetSensorUsageWeeklyParams 

type GetSensorUsageWeeklyParams struct {

	/* Filter.

	     The FQL search filter. Allowed fields:
	"event_date" : A specified date that will be final date of the results returned. Specified date cannot be after the default.
		Format: '2024-06-11'
		Default: the current date, minus 2 days, in UTC
	"period" : An integer surrounded by single quotes representing the number of days to return.
		Format: '30'
		Default: '28'
		Minimum: '1'
		Maximum: '395'
	"selected_cids" : A comma separated list of CIDs to return data for. Caller must be a parent CID or have special access enabled.
		Format: 'cid_1,cid_2,cid_3'
		Default: for parent CIDs the default is the parent and all children, otherwise the current CID
	*/
	Filter *string

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

GetSensorUsageWeeklyParams contains all the parameters to send to the API endpoint 

for the get sensor usage weekly operation.

Typically these are written to a http.Request.

func NewGetSensorUsageWeeklyParams 

func NewGetSensorUsageWeeklyParams() *GetSensorUsageWeeklyParams

NewGetSensorUsageWeeklyParams creates a new GetSensorUsageWeeklyParams 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 NewGetSensorUsageWeeklyParamsWithContext 

func NewGetSensorUsageWeeklyParamsWithContext(ctx context.Context) *GetSensorUsageWeeklyParams

NewGetSensorUsageWeeklyParamsWithContext creates a new GetSensorUsageWeeklyParams object with the ability to set a context for a request.

func NewGetSensorUsageWeeklyParamsWithHTTPClient 

func NewGetSensorUsageWeeklyParamsWithHTTPClient(client *http.Client) *GetSensorUsageWeeklyParams

NewGetSensorUsageWeeklyParamsWithHTTPClient creates a new GetSensorUsageWeeklyParams object with the ability to set a custom HTTPClient for a request.

func NewGetSensorUsageWeeklyParamsWithTimeout 

func NewGetSensorUsageWeeklyParamsWithTimeout(timeout time.Duration) *GetSensorUsageWeeklyParams

NewGetSensorUsageWeeklyParamsWithTimeout creates a new GetSensorUsageWeeklyParams object with the ability to set a timeout on a request.

func (*GetSensorUsageWeeklyParams) SetContext 

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

SetContext adds the context to the get sensor usage weekly params

func (*GetSensorUsageWeeklyParams) SetDefaults 

func (o *GetSensorUsageWeeklyParams) SetDefaults()

SetDefaults hydrates default values in the get sensor usage weekly params (not the query body).

All values with no default are reset to their zero value.

func (*GetSensorUsageWeeklyParams) SetFilter 

func (o *GetSensorUsageWeeklyParams) SetFilter(filter *string)

SetFilter adds the filter to the get sensor usage weekly params

func (*GetSensorUsageWeeklyParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get sensor usage weekly params

func (*GetSensorUsageWeeklyParams) SetTimeout 

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

SetTimeout adds the timeout to the get sensor usage weekly params

func (*GetSensorUsageWeeklyParams) WithContext 

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

WithContext adds the context to the get sensor usage weekly params

func (*GetSensorUsageWeeklyParams) WithDefaults 

func (o *GetSensorUsageWeeklyParams) WithDefaults() *GetSensorUsageWeeklyParams

WithDefaults hydrates default values in the get sensor usage weekly params (not the query body).

All values with no default are reset to their zero value.

func (*GetSensorUsageWeeklyParams) WithFilter 

func (o *GetSensorUsageWeeklyParams) WithFilter(filter *string) *GetSensorUsageWeeklyParams

WithFilter adds the filter to the get sensor usage weekly params

func (*GetSensorUsageWeeklyParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get sensor usage weekly params

func (*GetSensorUsageWeeklyParams) WithTimeout 

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

WithTimeout adds the timeout to the get sensor usage weekly params

func (*GetSensorUsageWeeklyParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetSensorUsageWeeklyReader 

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

GetSensorUsageWeeklyReader is a Reader for the GetSensorUsageWeekly structure.

func (*GetSensorUsageWeeklyReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetSensorUsageWeeklyTooManyRequests 

type GetSensorUsageWeeklyTooManyRequests struct {

	/* Trace-ID: submit to support if resolving an issue
	 */
	XCSTRACEID string

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

	/* The number of requests remaining for the sliding one minute window.
	 */
	XRateLimitRemaining int64

	/* Too many requests, retry after this time (as milliseconds since epoch)
	 */
	XRateLimitRetryAfter int64

	Payload *models.MsaReplyMetaOnly
}

GetSensorUsageWeeklyTooManyRequests describes a response with status code 429, with default header values.

Too Many Requests

func NewGetSensorUsageWeeklyTooManyRequests 

func NewGetSensorUsageWeeklyTooManyRequests() *GetSensorUsageWeeklyTooManyRequests

NewGetSensorUsageWeeklyTooManyRequests creates a GetSensorUsageWeeklyTooManyRequests with default headers values

func (*GetSensorUsageWeeklyTooManyRequests) Code 

func (o *GetSensorUsageWeeklyTooManyRequests) Code() int

Code gets the status code for the get sensor usage weekly too many requests response

func (*GetSensorUsageWeeklyTooManyRequests) Error 

func (o *GetSensorUsageWeeklyTooManyRequests) Error() string

func (*GetSensorUsageWeeklyTooManyRequests) GetPayload 

func (o *GetSensorUsageWeeklyTooManyRequests) GetPayload() *models.MsaReplyMetaOnly

func (*GetSensorUsageWeeklyTooManyRequests) IsClientError 

func (o *GetSensorUsageWeeklyTooManyRequests) IsClientError() bool

IsClientError returns true when this get sensor usage weekly too many requests response has a 4xx status code

func (*GetSensorUsageWeeklyTooManyRequests) IsCode 

func (o *GetSensorUsageWeeklyTooManyRequests) IsCode(code int) bool

IsCode returns true when this get sensor usage weekly too many requests response a status code equal to that given

func (*GetSensorUsageWeeklyTooManyRequests) IsRedirect 

func (o *GetSensorUsageWeeklyTooManyRequests) IsRedirect() bool

IsRedirect returns true when this get sensor usage weekly too many requests response has a 3xx status code

func (*GetSensorUsageWeeklyTooManyRequests) IsServerError 

func (o *GetSensorUsageWeeklyTooManyRequests) IsServerError() bool

IsServerError returns true when this get sensor usage weekly too many requests response has a 5xx status code

func (*GetSensorUsageWeeklyTooManyRequests) IsSuccess 

func (o *GetSensorUsageWeeklyTooManyRequests) IsSuccess() bool

IsSuccess returns true when this get sensor usage weekly too many requests response has a 2xx status code

func (*GetSensorUsageWeeklyTooManyRequests) String 

func (o *GetSensorUsageWeeklyTooManyRequests) String() string

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.