scheduled_reports

package
v0.5.0-rc1 Latest Latest
Warning

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

 Go to latest Published: Oct 16, 2023 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) Execute added in v0.5.0 

func (a *Client) Execute(params *ExecuteParams, opts ...ClientOption) (*ExecuteOK, error)

Execute launches scheduled reports executions for the provided report i ds

func (*Client) Query added in v0.5.0 

func (a *Client) Query(params *QueryParams, opts ...ClientOption) (*QueryOK, error)

Query finds all report i ds matching the query with filter

func (*Client) QueryByID added in v0.5.0 

func (a *Client) QueryByID(params *QueryByIDParams, opts ...ClientOption) (*QueryByIDOK, error)

QueryByID retrieves scheduled reports for the provided report i ds

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 {
	Execute(params *ExecuteParams, opts ...ClientOption) (*ExecuteOK, error)

	Query(params *QueryParams, opts ...ClientOption) (*QueryOK, error)

	QueryByID(params *QueryByIDParams, opts ...ClientOption) (*QueryByIDOK, 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 ExecuteBadRequest added in v0.5.0 

type ExecuteBadRequest 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
}

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

Bad Request

func NewExecuteBadRequest added in v0.5.0 

func NewExecuteBadRequest() *ExecuteBadRequest

NewExecuteBadRequest creates a ExecuteBadRequest with default headers values

func (*ExecuteBadRequest) Code added in v0.5.0 

func (o *ExecuteBadRequest) Code() int

Code gets the status code for the execute bad request response

func (*ExecuteBadRequest) Error added in v0.5.0 

func (o *ExecuteBadRequest) Error() string

func (*ExecuteBadRequest) GetPayload added in v0.5.0 

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

func (*ExecuteBadRequest) IsClientError added in v0.5.0 

func (o *ExecuteBadRequest) IsClientError() bool

IsClientError returns true when this execute bad request response has a 4xx status code

func (*ExecuteBadRequest) IsCode added in v0.5.0 

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

IsCode returns true when this execute bad request response a status code equal to that given

func (*ExecuteBadRequest) IsRedirect added in v0.5.0 

func (o *ExecuteBadRequest) IsRedirect() bool

IsRedirect returns true when this execute bad request response has a 3xx status code

func (*ExecuteBadRequest) IsServerError added in v0.5.0 

func (o *ExecuteBadRequest) IsServerError() bool

IsServerError returns true when this execute bad request response has a 5xx status code

func (*ExecuteBadRequest) IsSuccess added in v0.5.0 

func (o *ExecuteBadRequest) IsSuccess() bool

IsSuccess returns true when this execute bad request response has a 2xx status code

func (*ExecuteBadRequest) String added in v0.5.0 

func (o *ExecuteBadRequest) String() string

type ExecuteForbidden added in v0.5.0 

type ExecuteForbidden 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
}

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

Forbidden

func NewExecuteForbidden added in v0.5.0 

func NewExecuteForbidden() *ExecuteForbidden

NewExecuteForbidden creates a ExecuteForbidden with default headers values

func (*ExecuteForbidden) Code added in v0.5.0 

func (o *ExecuteForbidden) Code() int

Code gets the status code for the execute forbidden response

func (*ExecuteForbidden) Error added in v0.5.0 

func (o *ExecuteForbidden) Error() string

func (*ExecuteForbidden) GetPayload added in v0.5.0 

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

func (*ExecuteForbidden) IsClientError added in v0.5.0 

func (o *ExecuteForbidden) IsClientError() bool

IsClientError returns true when this execute forbidden response has a 4xx status code

func (*ExecuteForbidden) IsCode added in v0.5.0 

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

IsCode returns true when this execute forbidden response a status code equal to that given

func (*ExecuteForbidden) IsRedirect added in v0.5.0 

func (o *ExecuteForbidden) IsRedirect() bool

IsRedirect returns true when this execute forbidden response has a 3xx status code

func (*ExecuteForbidden) IsServerError added in v0.5.0 

func (o *ExecuteForbidden) IsServerError() bool

IsServerError returns true when this execute forbidden response has a 5xx status code

func (*ExecuteForbidden) IsSuccess added in v0.5.0 

func (o *ExecuteForbidden) IsSuccess() bool

IsSuccess returns true when this execute forbidden response has a 2xx status code

func (*ExecuteForbidden) String added in v0.5.0 

func (o *ExecuteForbidden) String() string

type ExecuteOK added in v0.5.0 

type ExecuteOK 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.DomainReportExecutionsResponseV1
}

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

OK

func NewExecuteOK added in v0.5.0 

func NewExecuteOK() *ExecuteOK

NewExecuteOK creates a ExecuteOK with default headers values

func (*ExecuteOK) Code added in v0.5.0 

func (o *ExecuteOK) Code() int

Code gets the status code for the execute o k response

func (*ExecuteOK) Error added in v0.5.0 

func (o *ExecuteOK) Error() string

func (*ExecuteOK) GetPayload added in v0.5.0 

func (o *ExecuteOK) GetPayload() *models.DomainReportExecutionsResponseV1

func (*ExecuteOK) IsClientError added in v0.5.0 

func (o *ExecuteOK) IsClientError() bool

IsClientError returns true when this execute o k response has a 4xx status code

func (*ExecuteOK) IsCode added in v0.5.0 

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

IsCode returns true when this execute o k response a status code equal to that given

func (*ExecuteOK) IsRedirect added in v0.5.0 

func (o *ExecuteOK) IsRedirect() bool

IsRedirect returns true when this execute o k response has a 3xx status code

func (*ExecuteOK) IsServerError added in v0.5.0 

func (o *ExecuteOK) IsServerError() bool

IsServerError returns true when this execute o k response has a 5xx status code

func (*ExecuteOK) IsSuccess added in v0.5.0 

func (o *ExecuteOK) IsSuccess() bool

IsSuccess returns true when this execute o k response has a 2xx status code

func (*ExecuteOK) String added in v0.5.0 

func (o *ExecuteOK) String() string

type ExecuteParams added in v0.5.0 

type ExecuteParams struct {

	// Body.
	Body []*models.DomainReportExecutionLaunchRequestV1

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

ExecuteParams contains all the parameters to send to the API endpoint 

for the execute operation.

Typically these are written to a http.Request.

func NewExecuteParams added in v0.5.0 

func NewExecuteParams() *ExecuteParams

NewExecuteParams creates a new ExecuteParams 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 NewExecuteParamsWithContext added in v0.5.0 

func NewExecuteParamsWithContext(ctx context.Context) *ExecuteParams

NewExecuteParamsWithContext creates a new ExecuteParams object with the ability to set a context for a request.

func NewExecuteParamsWithHTTPClient added in v0.5.0 

func NewExecuteParamsWithHTTPClient(client *http.Client) *ExecuteParams

NewExecuteParamsWithHTTPClient creates a new ExecuteParams object with the ability to set a custom HTTPClient for a request.

func NewExecuteParamsWithTimeout added in v0.5.0 

func NewExecuteParamsWithTimeout(timeout time.Duration) *ExecuteParams

NewExecuteParamsWithTimeout creates a new ExecuteParams object with the ability to set a timeout on a request.

func (*ExecuteParams) SetBody added in v0.5.0 

func (o *ExecuteParams) SetBody(body []*models.DomainReportExecutionLaunchRequestV1)

SetBody adds the body to the execute params

func (*ExecuteParams) SetContext added in v0.5.0 

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

SetContext adds the context to the execute params

func (*ExecuteParams) SetDefaults added in v0.5.0 

func (o *ExecuteParams) SetDefaults()

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

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

func (*ExecuteParams) SetHTTPClient added in v0.5.0 

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

SetHTTPClient adds the HTTPClient to the execute params

func (*ExecuteParams) SetTimeout added in v0.5.0 

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

SetTimeout adds the timeout to the execute params

func (*ExecuteParams) WithBody added in v0.5.0 

func (o *ExecuteParams) WithBody(body []*models.DomainReportExecutionLaunchRequestV1) *ExecuteParams

WithBody adds the body to the execute params

func (*ExecuteParams) WithContext added in v0.5.0 

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

WithContext adds the context to the execute params

func (*ExecuteParams) WithDefaults added in v0.5.0 

func (o *ExecuteParams) WithDefaults() *ExecuteParams

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

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

func (*ExecuteParams) WithHTTPClient added in v0.5.0 

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

WithHTTPClient adds the HTTPClient to the execute params

func (*ExecuteParams) WithTimeout added in v0.5.0 

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

WithTimeout adds the timeout to the execute params

func (*ExecuteParams) WriteToRequest added in v0.5.0 

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

WriteToRequest writes these params to a swagger request

type ExecuteReader added in v0.5.0 

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

ExecuteReader is a Reader for the Execute structure.

func (*ExecuteReader) ReadResponse added in v0.5.0 

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

ReadResponse reads a server response into the received o.

type ExecuteTooManyRequests added in v0.5.0 

type ExecuteTooManyRequests 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
}

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

Too Many Requests

func NewExecuteTooManyRequests added in v0.5.0 

func NewExecuteTooManyRequests() *ExecuteTooManyRequests

NewExecuteTooManyRequests creates a ExecuteTooManyRequests with default headers values

func (*ExecuteTooManyRequests) Code added in v0.5.0 

func (o *ExecuteTooManyRequests) Code() int

Code gets the status code for the execute too many requests response

func (*ExecuteTooManyRequests) Error added in v0.5.0 

func (o *ExecuteTooManyRequests) Error() string

func (*ExecuteTooManyRequests) GetPayload added in v0.5.0 

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

func (*ExecuteTooManyRequests) IsClientError added in v0.5.0 

func (o *ExecuteTooManyRequests) IsClientError() bool

IsClientError returns true when this execute too many requests response has a 4xx status code

func (*ExecuteTooManyRequests) IsCode added in v0.5.0 

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

IsCode returns true when this execute too many requests response a status code equal to that given

func (*ExecuteTooManyRequests) IsRedirect added in v0.5.0 

func (o *ExecuteTooManyRequests) IsRedirect() bool

IsRedirect returns true when this execute too many requests response has a 3xx status code

func (*ExecuteTooManyRequests) IsServerError added in v0.5.0 

func (o *ExecuteTooManyRequests) IsServerError() bool

IsServerError returns true when this execute too many requests response has a 5xx status code

func (*ExecuteTooManyRequests) IsSuccess added in v0.5.0 

func (o *ExecuteTooManyRequests) IsSuccess() bool

IsSuccess returns true when this execute too many requests response has a 2xx status code

func (*ExecuteTooManyRequests) String added in v0.5.0 

func (o *ExecuteTooManyRequests) String() string

type QueryBadRequest added in v0.5.0 

type QueryBadRequest 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
}

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

Bad Request

func NewQueryBadRequest added in v0.5.0 

func NewQueryBadRequest() *QueryBadRequest

NewQueryBadRequest creates a QueryBadRequest with default headers values

func (*QueryBadRequest) Code added in v0.5.0 

func (o *QueryBadRequest) Code() int

Code gets the status code for the query bad request response

func (*QueryBadRequest) Error added in v0.5.0 

func (o *QueryBadRequest) Error() string

func (*QueryBadRequest) GetPayload added in v0.5.0 

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

func (*QueryBadRequest) IsClientError added in v0.5.0 

func (o *QueryBadRequest) IsClientError() bool

IsClientError returns true when this query bad request response has a 4xx status code

func (*QueryBadRequest) IsCode added in v0.5.0 

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

IsCode returns true when this query bad request response a status code equal to that given

func (*QueryBadRequest) IsRedirect added in v0.5.0 

func (o *QueryBadRequest) IsRedirect() bool

IsRedirect returns true when this query bad request response has a 3xx status code

func (*QueryBadRequest) IsServerError added in v0.5.0 

func (o *QueryBadRequest) IsServerError() bool

IsServerError returns true when this query bad request response has a 5xx status code

func (*QueryBadRequest) IsSuccess added in v0.5.0 

func (o *QueryBadRequest) IsSuccess() bool

IsSuccess returns true when this query bad request response has a 2xx status code

func (*QueryBadRequest) String added in v0.5.0 

func (o *QueryBadRequest) String() string

type QueryByIDBadRequest added in v0.5.0 

type QueryByIDBadRequest 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
}

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

Bad Request

func NewQueryByIDBadRequest added in v0.5.0 

func NewQueryByIDBadRequest() *QueryByIDBadRequest

NewQueryByIDBadRequest creates a QueryByIDBadRequest with default headers values

func (*QueryByIDBadRequest) Code added in v0.5.0 

func (o *QueryByIDBadRequest) Code() int

Code gets the status code for the query by Id bad request response

func (*QueryByIDBadRequest) Error added in v0.5.0 

func (o *QueryByIDBadRequest) Error() string

func (*QueryByIDBadRequest) GetPayload added in v0.5.0 

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

func (*QueryByIDBadRequest) IsClientError added in v0.5.0 

func (o *QueryByIDBadRequest) IsClientError() bool

IsClientError returns true when this query by Id bad request response has a 4xx status code

func (*QueryByIDBadRequest) IsCode added in v0.5.0 

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

IsCode returns true when this query by Id bad request response a status code equal to that given

func (*QueryByIDBadRequest) IsRedirect added in v0.5.0 

func (o *QueryByIDBadRequest) IsRedirect() bool

IsRedirect returns true when this query by Id bad request response has a 3xx status code

func (*QueryByIDBadRequest) IsServerError added in v0.5.0 

func (o *QueryByIDBadRequest) IsServerError() bool

IsServerError returns true when this query by Id bad request response has a 5xx status code

func (*QueryByIDBadRequest) IsSuccess added in v0.5.0 

func (o *QueryByIDBadRequest) IsSuccess() bool

IsSuccess returns true when this query by Id bad request response has a 2xx status code

func (*QueryByIDBadRequest) String added in v0.5.0 

func (o *QueryByIDBadRequest) String() string

type QueryByIDForbidden added in v0.5.0 

type QueryByIDForbidden 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
}

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

Forbidden

func NewQueryByIDForbidden added in v0.5.0 

func NewQueryByIDForbidden() *QueryByIDForbidden

NewQueryByIDForbidden creates a QueryByIDForbidden with default headers values

func (*QueryByIDForbidden) Code added in v0.5.0 

func (o *QueryByIDForbidden) Code() int

Code gets the status code for the query by Id forbidden response

func (*QueryByIDForbidden) Error added in v0.5.0 

func (o *QueryByIDForbidden) Error() string

func (*QueryByIDForbidden) GetPayload added in v0.5.0 

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

func (*QueryByIDForbidden) IsClientError added in v0.5.0 

func (o *QueryByIDForbidden) IsClientError() bool

IsClientError returns true when this query by Id forbidden response has a 4xx status code

func (*QueryByIDForbidden) IsCode added in v0.5.0 

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

IsCode returns true when this query by Id forbidden response a status code equal to that given

func (*QueryByIDForbidden) IsRedirect added in v0.5.0 

func (o *QueryByIDForbidden) IsRedirect() bool

IsRedirect returns true when this query by Id forbidden response has a 3xx status code

func (*QueryByIDForbidden) IsServerError added in v0.5.0 

func (o *QueryByIDForbidden) IsServerError() bool

IsServerError returns true when this query by Id forbidden response has a 5xx status code

func (*QueryByIDForbidden) IsSuccess added in v0.5.0 

func (o *QueryByIDForbidden) IsSuccess() bool

IsSuccess returns true when this query by Id forbidden response has a 2xx status code

func (*QueryByIDForbidden) String added in v0.5.0 

func (o *QueryByIDForbidden) String() string

type QueryByIDOK added in v0.5.0 

type QueryByIDOK 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.DomainScheduledReportsResultV1
}

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

OK

func NewQueryByIDOK added in v0.5.0 

func NewQueryByIDOK() *QueryByIDOK

NewQueryByIDOK creates a QueryByIDOK with default headers values

func (*QueryByIDOK) Code added in v0.5.0 

func (o *QueryByIDOK) Code() int

Code gets the status code for the query by Id o k response

func (*QueryByIDOK) Error added in v0.5.0 

func (o *QueryByIDOK) Error() string

func (*QueryByIDOK) GetPayload added in v0.5.0 

func (o *QueryByIDOK) GetPayload() *models.DomainScheduledReportsResultV1

func (*QueryByIDOK) IsClientError added in v0.5.0 

func (o *QueryByIDOK) IsClientError() bool

IsClientError returns true when this query by Id o k response has a 4xx status code

func (*QueryByIDOK) IsCode added in v0.5.0 

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

IsCode returns true when this query by Id o k response a status code equal to that given

func (*QueryByIDOK) IsRedirect added in v0.5.0 

func (o *QueryByIDOK) IsRedirect() bool

IsRedirect returns true when this query by Id o k response has a 3xx status code

func (*QueryByIDOK) IsServerError added in v0.5.0 

func (o *QueryByIDOK) IsServerError() bool

IsServerError returns true when this query by Id o k response has a 5xx status code

func (*QueryByIDOK) IsSuccess added in v0.5.0 

func (o *QueryByIDOK) IsSuccess() bool

IsSuccess returns true when this query by Id o k response has a 2xx status code

func (*QueryByIDOK) String added in v0.5.0 

func (o *QueryByIDOK) String() string

type QueryByIDParams added in v0.5.0 

type QueryByIDParams struct {

	/* Ids.

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

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

QueryByIDParams contains all the parameters to send to the API endpoint 

for the query by Id operation.

Typically these are written to a http.Request.

func NewQueryByIDParams added in v0.5.0 

func NewQueryByIDParams() *QueryByIDParams

NewQueryByIDParams creates a new QueryByIDParams 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 NewQueryByIDParamsWithContext added in v0.5.0 

func NewQueryByIDParamsWithContext(ctx context.Context) *QueryByIDParams

NewQueryByIDParamsWithContext creates a new QueryByIDParams object with the ability to set a context for a request.

func NewQueryByIDParamsWithHTTPClient added in v0.5.0 

func NewQueryByIDParamsWithHTTPClient(client *http.Client) *QueryByIDParams

NewQueryByIDParamsWithHTTPClient creates a new QueryByIDParams object with the ability to set a custom HTTPClient for a request.

func NewQueryByIDParamsWithTimeout added in v0.5.0 

func NewQueryByIDParamsWithTimeout(timeout time.Duration) *QueryByIDParams

NewQueryByIDParamsWithTimeout creates a new QueryByIDParams object with the ability to set a timeout on a request.

func (*QueryByIDParams) SetContext added in v0.5.0 

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

SetContext adds the context to the query by Id params

func (*QueryByIDParams) SetDefaults added in v0.5.0 

func (o *QueryByIDParams) SetDefaults()

SetDefaults hydrates default values in the query by Id params (not the query body).

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

func (*QueryByIDParams) SetHTTPClient added in v0.5.0 

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

SetHTTPClient adds the HTTPClient to the query by Id params

func (*QueryByIDParams) SetIds added in v0.5.0 

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

SetIds adds the ids to the query by Id params

func (*QueryByIDParams) SetTimeout added in v0.5.0 

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

SetTimeout adds the timeout to the query by Id params

func (*QueryByIDParams) WithContext added in v0.5.0 

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

WithContext adds the context to the query by Id params

func (*QueryByIDParams) WithDefaults added in v0.5.0 

func (o *QueryByIDParams) WithDefaults() *QueryByIDParams

WithDefaults hydrates default values in the query by Id params (not the query body).

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

func (*QueryByIDParams) WithHTTPClient added in v0.5.0 

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

WithHTTPClient adds the HTTPClient to the query by Id params

func (*QueryByIDParams) WithIds added in v0.5.0 

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

WithIds adds the ids to the query by Id params

func (*QueryByIDParams) WithTimeout added in v0.5.0 

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

WithTimeout adds the timeout to the query by Id params

func (*QueryByIDParams) WriteToRequest added in v0.5.0 

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

WriteToRequest writes these params to a swagger request

type QueryByIDReader added in v0.5.0 

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

QueryByIDReader is a Reader for the QueryByID structure.

func (*QueryByIDReader) ReadResponse added in v0.5.0 

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

ReadResponse reads a server response into the received o.

type QueryByIDTooManyRequests added in v0.5.0 

type QueryByIDTooManyRequests 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
}

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

Too Many Requests

func NewQueryByIDTooManyRequests added in v0.5.0 

func NewQueryByIDTooManyRequests() *QueryByIDTooManyRequests

NewQueryByIDTooManyRequests creates a QueryByIDTooManyRequests with default headers values

func (*QueryByIDTooManyRequests) Code added in v0.5.0 

func (o *QueryByIDTooManyRequests) Code() int

Code gets the status code for the query by Id too many requests response

func (*QueryByIDTooManyRequests) Error added in v0.5.0 

func (o *QueryByIDTooManyRequests) Error() string

func (*QueryByIDTooManyRequests) GetPayload added in v0.5.0 

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

func (*QueryByIDTooManyRequests) IsClientError added in v0.5.0 

func (o *QueryByIDTooManyRequests) IsClientError() bool

IsClientError returns true when this query by Id too many requests response has a 4xx status code

func (*QueryByIDTooManyRequests) IsCode added in v0.5.0 

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

IsCode returns true when this query by Id too many requests response a status code equal to that given

func (*QueryByIDTooManyRequests) IsRedirect added in v0.5.0 

func (o *QueryByIDTooManyRequests) IsRedirect() bool

IsRedirect returns true when this query by Id too many requests response has a 3xx status code

func (*QueryByIDTooManyRequests) IsServerError added in v0.5.0 

func (o *QueryByIDTooManyRequests) IsServerError() bool

IsServerError returns true when this query by Id too many requests response has a 5xx status code

func (*QueryByIDTooManyRequests) IsSuccess added in v0.5.0 

func (o *QueryByIDTooManyRequests) IsSuccess() bool

IsSuccess returns true when this query by Id too many requests response has a 2xx status code

func (*QueryByIDTooManyRequests) String added in v0.5.0 

func (o *QueryByIDTooManyRequests) String() string

type QueryForbidden added in v0.5.0 

type QueryForbidden 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
}

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

Forbidden

func NewQueryForbidden added in v0.5.0 

func NewQueryForbidden() *QueryForbidden

NewQueryForbidden creates a QueryForbidden with default headers values

func (*QueryForbidden) Code added in v0.5.0 

func (o *QueryForbidden) Code() int

Code gets the status code for the query forbidden response

func (*QueryForbidden) Error added in v0.5.0 

func (o *QueryForbidden) Error() string

func (*QueryForbidden) GetPayload added in v0.5.0 

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

func (*QueryForbidden) IsClientError added in v0.5.0 

func (o *QueryForbidden) IsClientError() bool

IsClientError returns true when this query forbidden response has a 4xx status code

func (*QueryForbidden) IsCode added in v0.5.0 

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

IsCode returns true when this query forbidden response a status code equal to that given

func (*QueryForbidden) IsRedirect added in v0.5.0 

func (o *QueryForbidden) IsRedirect() bool

IsRedirect returns true when this query forbidden response has a 3xx status code

func (*QueryForbidden) IsServerError added in v0.5.0 

func (o *QueryForbidden) IsServerError() bool

IsServerError returns true when this query forbidden response has a 5xx status code

func (*QueryForbidden) IsSuccess added in v0.5.0 

func (o *QueryForbidden) IsSuccess() bool

IsSuccess returns true when this query forbidden response has a 2xx status code

func (*QueryForbidden) String added in v0.5.0 

func (o *QueryForbidden) String() string

type QueryOK added in v0.5.0 

type QueryOK 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
}

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

OK

func NewQueryOK added in v0.5.0 

func NewQueryOK() *QueryOK

NewQueryOK creates a QueryOK with default headers values

func (*QueryOK) Code added in v0.5.0 

func (o *QueryOK) Code() int

Code gets the status code for the query o k response

func (*QueryOK) Error added in v0.5.0 

func (o *QueryOK) Error() string

func (*QueryOK) GetPayload added in v0.5.0 

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

func (*QueryOK) IsClientError added in v0.5.0 

func (o *QueryOK) IsClientError() bool

IsClientError returns true when this query o k response has a 4xx status code

func (*QueryOK) IsCode added in v0.5.0 

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

IsCode returns true when this query o k response a status code equal to that given

func (*QueryOK) IsRedirect added in v0.5.0 

func (o *QueryOK) IsRedirect() bool

IsRedirect returns true when this query o k response has a 3xx status code

func (*QueryOK) IsServerError added in v0.5.0 

func (o *QueryOK) IsServerError() bool

IsServerError returns true when this query o k response has a 5xx status code

func (*QueryOK) IsSuccess added in v0.5.0 

func (o *QueryOK) IsSuccess() bool

IsSuccess returns true when this query o k response has a 2xx status code

func (*QueryOK) String added in v0.5.0 

func (o *QueryOK) String() string

type QueryParams added in v0.5.0 

type QueryParams 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
}

QueryParams contains all the parameters to send to the API endpoint 

for the query operation.

Typically these are written to a http.Request.

func NewQueryParams added in v0.5.0 

func NewQueryParams() *QueryParams

NewQueryParams creates a new QueryParams 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 NewQueryParamsWithContext added in v0.5.0 

func NewQueryParamsWithContext(ctx context.Context) *QueryParams

NewQueryParamsWithContext creates a new QueryParams object with the ability to set a context for a request.

func NewQueryParamsWithHTTPClient added in v0.5.0 

func NewQueryParamsWithHTTPClient(client *http.Client) *QueryParams

NewQueryParamsWithHTTPClient creates a new QueryParams object with the ability to set a custom HTTPClient for a request.

func NewQueryParamsWithTimeout added in v0.5.0 

func NewQueryParamsWithTimeout(timeout time.Duration) *QueryParams

NewQueryParamsWithTimeout creates a new QueryParams object with the ability to set a timeout on a request.

func (*QueryParams) SetContext added in v0.5.0 

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

SetContext adds the context to the query params

func (*QueryParams) SetDefaults added in v0.5.0 

func (o *QueryParams) SetDefaults()

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

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

func (*QueryParams) SetFilter added in v0.5.0 

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

SetFilter adds the filter to the query params

func (*QueryParams) SetHTTPClient added in v0.5.0 

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

SetHTTPClient adds the HTTPClient to the query params

func (*QueryParams) SetLimit added in v0.5.0 

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

SetLimit adds the limit to the query params

func (*QueryParams) SetOffset added in v0.5.0 

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

SetOffset adds the offset to the query params

func (*QueryParams) SetQ added in v0.5.0 

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

SetQ adds the q to the query params

func (*QueryParams) SetSort added in v0.5.0 

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

SetSort adds the sort to the query params

func (*QueryParams) SetTimeout added in v0.5.0 

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

SetTimeout adds the timeout to the query params

func (*QueryParams) WithContext added in v0.5.0 

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

WithContext adds the context to the query params

func (*QueryParams) WithDefaults added in v0.5.0 

func (o *QueryParams) WithDefaults() *QueryParams

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

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

func (*QueryParams) WithFilter added in v0.5.0 

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

WithFilter adds the filter to the query params

func (*QueryParams) WithHTTPClient added in v0.5.0 

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

WithHTTPClient adds the HTTPClient to the query params

func (*QueryParams) WithLimit added in v0.5.0 

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

WithLimit adds the limit to the query params

func (*QueryParams) WithOffset added in v0.5.0 

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

WithOffset adds the offset to the query params

func (*QueryParams) WithQ added in v0.5.0 

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

WithQ adds the q to the query params

func (*QueryParams) WithSort added in v0.5.0 

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

WithSort adds the sort to the query params

func (*QueryParams) WithTimeout added in v0.5.0 

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

WithTimeout adds the timeout to the query params

func (*QueryParams) WriteToRequest added in v0.5.0 

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

WriteToRequest writes these params to a swagger request

type QueryReader added in v0.5.0 

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

QueryReader is a Reader for the Query structure.

func (*QueryReader) ReadResponse added in v0.5.0 

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

ReadResponse reads a server response into the received o.

type QueryTooManyRequests added in v0.5.0 

type QueryTooManyRequests 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
}

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

Too Many Requests

func NewQueryTooManyRequests added in v0.5.0 

func NewQueryTooManyRequests() *QueryTooManyRequests

NewQueryTooManyRequests creates a QueryTooManyRequests with default headers values

func (*QueryTooManyRequests) Code added in v0.5.0 

func (o *QueryTooManyRequests) Code() int

Code gets the status code for the query too many requests response

func (*QueryTooManyRequests) Error added in v0.5.0 

func (o *QueryTooManyRequests) Error() string

func (*QueryTooManyRequests) GetPayload added in v0.5.0 

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

func (*QueryTooManyRequests) IsClientError added in v0.5.0 

func (o *QueryTooManyRequests) IsClientError() bool

IsClientError returns true when this query too many requests response has a 4xx status code

func (*QueryTooManyRequests) IsCode added in v0.5.0 

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

IsCode returns true when this query too many requests response a status code equal to that given

func (*QueryTooManyRequests) IsRedirect added in v0.5.0 

func (o *QueryTooManyRequests) IsRedirect() bool

IsRedirect returns true when this query too many requests response has a 3xx status code

func (*QueryTooManyRequests) IsServerError added in v0.5.0 

func (o *QueryTooManyRequests) IsServerError() bool

IsServerError returns true when this query too many requests response has a 5xx status code

func (*QueryTooManyRequests) IsSuccess added in v0.5.0 

func (o *QueryTooManyRequests) IsSuccess() bool

IsSuccess returns true when this query too many requests response has a 2xx status code

func (*QueryTooManyRequests) String added in v0.5.0 

func (o *QueryTooManyRequests) 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.