scheduled_reports

package
v0.2.10 Latest Latest
Warning

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

 Go to latest Published: Sep 17, 2021 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 scheduled reports API

func (*Client) ScheduledReportsGet 

func (a *Client) ScheduledReportsGet(params *ScheduledReportsGetParams, opts ...ClientOption) (*ScheduledReportsGetOK, error)

ScheduledReportsGet retrieves scheduled reports for the provided report i ds

func (*Client) ScheduledReportsQuery 

func (a *Client) ScheduledReportsQuery(params *ScheduledReportsQueryParams, opts ...ClientOption) (*ScheduledReportsQueryOK, error)

ScheduledReportsQuery finds all report i ds matching the query with filter

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 {
	ScheduledReportsGet(params *ScheduledReportsGetParams, opts ...ClientOption) (*ScheduledReportsGetOK, error)

	ScheduledReportsQuery(params *ScheduledReportsQueryParams, opts ...ClientOption) (*ScheduledReportsQueryOK, 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 scheduled reports API client.

type ScheduledReportsGetBadRequest 

type ScheduledReportsGetBadRequest 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.MsaReplyMetaOnly
}
ScheduledReportsGetBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewScheduledReportsGetBadRequest 

func NewScheduledReportsGetBadRequest() *ScheduledReportsGetBadRequest

NewScheduledReportsGetBadRequest creates a ScheduledReportsGetBadRequest with default headers values

func (*ScheduledReportsGetBadRequest) Error 

func (o *ScheduledReportsGetBadRequest) Error() string

func (*ScheduledReportsGetBadRequest) GetPayload 

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

type ScheduledReportsGetDefault 

type ScheduledReportsGetDefault struct {
	Payload *models.APIScheduledReportsResultV1
	// contains filtered or unexported fields
}
ScheduledReportsGetDefault describes a response with status code -1, with default header values.

OK

func NewScheduledReportsGetDefault 

func NewScheduledReportsGetDefault(code int) *ScheduledReportsGetDefault

NewScheduledReportsGetDefault creates a ScheduledReportsGetDefault with default headers values

func (*ScheduledReportsGetDefault) Code 

func (o *ScheduledReportsGetDefault) Code() int

Code gets the status code for the scheduled reports get default response

func (*ScheduledReportsGetDefault) Error 

func (o *ScheduledReportsGetDefault) Error() string

func (*ScheduledReportsGetDefault) GetPayload 

func (o *ScheduledReportsGetDefault) GetPayload() *models.APIScheduledReportsResultV1

type ScheduledReportsGetForbidden 

type ScheduledReportsGetForbidden 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.MsaReplyMetaOnly
}
ScheduledReportsGetForbidden describes a response with status code 403, with default header values.

Forbidden

func NewScheduledReportsGetForbidden 

func NewScheduledReportsGetForbidden() *ScheduledReportsGetForbidden

NewScheduledReportsGetForbidden creates a ScheduledReportsGetForbidden with default headers values

func (*ScheduledReportsGetForbidden) Error 

func (o *ScheduledReportsGetForbidden) Error() string

func (*ScheduledReportsGetForbidden) GetPayload 

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

type ScheduledReportsGetOK 

type ScheduledReportsGetOK 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.APIScheduledReportsResultV1
}
ScheduledReportsGetOK describes a response with status code 200, with default header values.

OK

func NewScheduledReportsGetOK 

func NewScheduledReportsGetOK() *ScheduledReportsGetOK

NewScheduledReportsGetOK creates a ScheduledReportsGetOK with default headers values

func (*ScheduledReportsGetOK) Error 

func (o *ScheduledReportsGetOK) Error() string

func (*ScheduledReportsGetOK) GetPayload 

func (o *ScheduledReportsGetOK) GetPayload() *models.APIScheduledReportsResultV1

type ScheduledReportsGetParams 

type ScheduledReportsGetParams struct {

	/* Ids.

	   The scheduled_report id to get details about.
	*/
	Ids []string

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

ScheduledReportsGetParams contains all the parameters to send to the API endpoint 

for the scheduled reports get operation.

Typically these are written to a http.Request.

func NewScheduledReportsGetParams 

func NewScheduledReportsGetParams() *ScheduledReportsGetParams

NewScheduledReportsGetParams creates a new ScheduledReportsGetParams 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 NewScheduledReportsGetParamsWithContext 

func NewScheduledReportsGetParamsWithContext(ctx context.Context) *ScheduledReportsGetParams

NewScheduledReportsGetParamsWithContext creates a new ScheduledReportsGetParams object with the ability to set a context for a request.

func NewScheduledReportsGetParamsWithHTTPClient 

func NewScheduledReportsGetParamsWithHTTPClient(client *http.Client) *ScheduledReportsGetParams

NewScheduledReportsGetParamsWithHTTPClient creates a new ScheduledReportsGetParams object with the ability to set a custom HTTPClient for a request.

func NewScheduledReportsGetParamsWithTimeout 

func NewScheduledReportsGetParamsWithTimeout(timeout time.Duration) *ScheduledReportsGetParams

NewScheduledReportsGetParamsWithTimeout creates a new ScheduledReportsGetParams object with the ability to set a timeout on a request.

func (*ScheduledReportsGetParams) SetContext 

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

SetContext adds the context to the scheduled reports get params

func (*ScheduledReportsGetParams) SetDefaults 

func (o *ScheduledReportsGetParams) SetDefaults()

SetDefaults hydrates default values in the scheduled reports get params (not the query body).

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

func (*ScheduledReportsGetParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the scheduled reports get params

func (*ScheduledReportsGetParams) SetIds 

func (o *ScheduledReportsGetParams) SetIds(ids []string)

SetIds adds the ids to the scheduled reports get params

func (*ScheduledReportsGetParams) SetTimeout 

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

SetTimeout adds the timeout to the scheduled reports get params

func (*ScheduledReportsGetParams) WithContext 

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

WithContext adds the context to the scheduled reports get params

func (*ScheduledReportsGetParams) WithDefaults 

func (o *ScheduledReportsGetParams) WithDefaults() *ScheduledReportsGetParams

WithDefaults hydrates default values in the scheduled reports get params (not the query body).

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

func (*ScheduledReportsGetParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the scheduled reports get params

func (*ScheduledReportsGetParams) WithIds 

func (o *ScheduledReportsGetParams) WithIds(ids []string) *ScheduledReportsGetParams

WithIds adds the ids to the scheduled reports get params

func (*ScheduledReportsGetParams) WithTimeout 

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

WithTimeout adds the timeout to the scheduled reports get params

func (*ScheduledReportsGetParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ScheduledReportsGetReader 

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

ScheduledReportsGetReader is a Reader for the ScheduledReportsGet structure.

func (*ScheduledReportsGetReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ScheduledReportsGetTooManyRequests 

type ScheduledReportsGetTooManyRequests 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
}
ScheduledReportsGetTooManyRequests describes a response with status code 429, with default header values.

Too Many Requests

func NewScheduledReportsGetTooManyRequests 

func NewScheduledReportsGetTooManyRequests() *ScheduledReportsGetTooManyRequests

NewScheduledReportsGetTooManyRequests creates a ScheduledReportsGetTooManyRequests with default headers values

func (*ScheduledReportsGetTooManyRequests) Error 

func (o *ScheduledReportsGetTooManyRequests) Error() string

func (*ScheduledReportsGetTooManyRequests) GetPayload 

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

type ScheduledReportsQueryBadRequest 

type ScheduledReportsQueryBadRequest 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.MsaReplyMetaOnly
}
ScheduledReportsQueryBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewScheduledReportsQueryBadRequest 

func NewScheduledReportsQueryBadRequest() *ScheduledReportsQueryBadRequest

NewScheduledReportsQueryBadRequest creates a ScheduledReportsQueryBadRequest with default headers values

func (*ScheduledReportsQueryBadRequest) Error 

func (o *ScheduledReportsQueryBadRequest) Error() string

func (*ScheduledReportsQueryBadRequest) GetPayload 

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

type ScheduledReportsQueryDefault 

type ScheduledReportsQueryDefault struct {
	Payload *models.MsaQueryResponse
	// contains filtered or unexported fields
}
ScheduledReportsQueryDefault describes a response with status code -1, with default header values.

OK

func NewScheduledReportsQueryDefault 

func NewScheduledReportsQueryDefault(code int) *ScheduledReportsQueryDefault

NewScheduledReportsQueryDefault creates a ScheduledReportsQueryDefault with default headers values

func (*ScheduledReportsQueryDefault) Code 

func (o *ScheduledReportsQueryDefault) Code() int

Code gets the status code for the scheduled reports query default response

func (*ScheduledReportsQueryDefault) Error 

func (o *ScheduledReportsQueryDefault) Error() string

func (*ScheduledReportsQueryDefault) GetPayload 

func (o *ScheduledReportsQueryDefault) GetPayload() *models.MsaQueryResponse

type ScheduledReportsQueryForbidden 

type ScheduledReportsQueryForbidden 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.MsaReplyMetaOnly
}
ScheduledReportsQueryForbidden describes a response with status code 403, with default header values.

Forbidden

func NewScheduledReportsQueryForbidden 

func NewScheduledReportsQueryForbidden() *ScheduledReportsQueryForbidden

NewScheduledReportsQueryForbidden creates a ScheduledReportsQueryForbidden with default headers values

func (*ScheduledReportsQueryForbidden) Error 

func (o *ScheduledReportsQueryForbidden) Error() string

func (*ScheduledReportsQueryForbidden) GetPayload 

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

type ScheduledReportsQueryOK 

type ScheduledReportsQueryOK 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.MsaQueryResponse
}
ScheduledReportsQueryOK describes a response with status code 200, with default header values.

OK

func NewScheduledReportsQueryOK 

func NewScheduledReportsQueryOK() *ScheduledReportsQueryOK

NewScheduledReportsQueryOK creates a ScheduledReportsQueryOK with default headers values

func (*ScheduledReportsQueryOK) Error 

func (o *ScheduledReportsQueryOK) Error() string

func (*ScheduledReportsQueryOK) GetPayload 

func (o *ScheduledReportsQueryOK) GetPayload() *models.MsaQueryResponse

type ScheduledReportsQueryParams 

type ScheduledReportsQueryParams struct {

	/* Filter.

	   FQL query specifying the filter parameters. Filter term criteria: type, trigger_reference, recipients, user_uuid, cid, trigger_params.metadata. Filter range criteria: created_on, modified_on; use any common date format, such as '2010-05-15T14:55:21.892315096Z'.
	*/
	Filter *string

	/* Limit.

	   Number of ids to return.
	*/
	Limit *int64

	/* Offset.

	   Starting index of overall result set from which to return ids.
	*/
	Offset *string

	/* Q.

	   Match query criteria, which includes all the filter string fields
	*/
	Q *string

	/* Sort.

	   Possible order by fields: created_on, last_updated_on, last_execution_on, next_execution_on
	*/
	Sort *string

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

ScheduledReportsQueryParams contains all the parameters to send to the API endpoint 

for the scheduled reports query operation.

Typically these are written to a http.Request.

func NewScheduledReportsQueryParams 

func NewScheduledReportsQueryParams() *ScheduledReportsQueryParams

NewScheduledReportsQueryParams creates a new ScheduledReportsQueryParams 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 NewScheduledReportsQueryParamsWithContext 

func NewScheduledReportsQueryParamsWithContext(ctx context.Context) *ScheduledReportsQueryParams

NewScheduledReportsQueryParamsWithContext creates a new ScheduledReportsQueryParams object with the ability to set a context for a request.

func NewScheduledReportsQueryParamsWithHTTPClient 

func NewScheduledReportsQueryParamsWithHTTPClient(client *http.Client) *ScheduledReportsQueryParams

NewScheduledReportsQueryParamsWithHTTPClient creates a new ScheduledReportsQueryParams object with the ability to set a custom HTTPClient for a request.

func NewScheduledReportsQueryParamsWithTimeout 

func NewScheduledReportsQueryParamsWithTimeout(timeout time.Duration) *ScheduledReportsQueryParams

NewScheduledReportsQueryParamsWithTimeout creates a new ScheduledReportsQueryParams object with the ability to set a timeout on a request.

func (*ScheduledReportsQueryParams) SetContext 

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

SetContext adds the context to the scheduled reports query params

func (*ScheduledReportsQueryParams) SetDefaults 

func (o *ScheduledReportsQueryParams) SetDefaults()

SetDefaults hydrates default values in the scheduled reports query params (not the query body).

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

func (*ScheduledReportsQueryParams) SetFilter 

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

SetFilter adds the filter to the scheduled reports query params

func (*ScheduledReportsQueryParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the scheduled reports query params

func (*ScheduledReportsQueryParams) SetLimit 

func (o *ScheduledReportsQueryParams) SetLimit(limit *int64)

SetLimit adds the limit to the scheduled reports query params

func (*ScheduledReportsQueryParams) SetOffset 

func (o *ScheduledReportsQueryParams) SetOffset(offset *string)

SetOffset adds the offset to the scheduled reports query params

func (*ScheduledReportsQueryParams) SetQ 

func (o *ScheduledReportsQueryParams) SetQ(q *string)

SetQ adds the q to the scheduled reports query params

func (*ScheduledReportsQueryParams) SetSort 

func (o *ScheduledReportsQueryParams) SetSort(sort *string)

SetSort adds the sort to the scheduled reports query params

func (*ScheduledReportsQueryParams) SetTimeout 

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

SetTimeout adds the timeout to the scheduled reports query params

func (*ScheduledReportsQueryParams) WithContext 

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

WithContext adds the context to the scheduled reports query params

func (*ScheduledReportsQueryParams) WithDefaults 

func (o *ScheduledReportsQueryParams) WithDefaults() *ScheduledReportsQueryParams

WithDefaults hydrates default values in the scheduled reports query params (not the query body).

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

func (*ScheduledReportsQueryParams) WithFilter 

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

WithFilter adds the filter to the scheduled reports query params

func (*ScheduledReportsQueryParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the scheduled reports query params

func (*ScheduledReportsQueryParams) WithLimit 

func (o *ScheduledReportsQueryParams) WithLimit(limit *int64) *ScheduledReportsQueryParams

WithLimit adds the limit to the scheduled reports query params

func (*ScheduledReportsQueryParams) WithOffset 

func (o *ScheduledReportsQueryParams) WithOffset(offset *string) *ScheduledReportsQueryParams

WithOffset adds the offset to the scheduled reports query params

func (*ScheduledReportsQueryParams) WithQ 

func (o *ScheduledReportsQueryParams) WithQ(q *string) *ScheduledReportsQueryParams

WithQ adds the q to the scheduled reports query params

func (*ScheduledReportsQueryParams) WithSort 

func (o *ScheduledReportsQueryParams) WithSort(sort *string) *ScheduledReportsQueryParams

WithSort adds the sort to the scheduled reports query params

func (*ScheduledReportsQueryParams) WithTimeout 

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

WithTimeout adds the timeout to the scheduled reports query params

func (*ScheduledReportsQueryParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ScheduledReportsQueryReader 

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

ScheduledReportsQueryReader is a Reader for the ScheduledReportsQuery structure.

func (*ScheduledReportsQueryReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ScheduledReportsQueryTooManyRequests 

type ScheduledReportsQueryTooManyRequests 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
}
ScheduledReportsQueryTooManyRequests describes a response with status code 429, with default header values.

Too Many Requests

func NewScheduledReportsQueryTooManyRequests 

func NewScheduledReportsQueryTooManyRequests() *ScheduledReportsQueryTooManyRequests

NewScheduledReportsQueryTooManyRequests creates a ScheduledReportsQueryTooManyRequests with default headers values

func (*ScheduledReportsQueryTooManyRequests) Error 

func (o *ScheduledReportsQueryTooManyRequests) Error() string

func (*ScheduledReportsQueryTooManyRequests) GetPayload 

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

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.