configuration_assessment

package
v0.6.0 Latest Latest
Warning

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

 Go to latest Published: Feb 27, 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 configuration assessment API

func (*Client) GetCombinedAssessmentsQuery 

func (a *Client) GetCombinedAssessmentsQuery(params *GetCombinedAssessmentsQueryParams, opts ...ClientOption) (*GetCombinedAssessmentsQueryOK, error)

GetCombinedAssessmentsQuery searches for assessments in your environment by providing an f q l filter and paging details returns a set of host finding entities which match the filter criteria

func (*Client) GetRuleDetails added in v0.5.0 

func (a *Client) GetRuleDetails(params *GetRuleDetailsParams, opts ...ClientOption) (*GetRuleDetailsOK, error)

GetRuleDetails gets rules details for provided one or more rule 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 {
	GetCombinedAssessmentsQuery(params *GetCombinedAssessmentsQueryParams, opts ...ClientOption) (*GetCombinedAssessmentsQueryOK, error)

	GetRuleDetails(params *GetRuleDetailsParams, opts ...ClientOption) (*GetRuleDetailsOK, 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 configuration assessment API client.

type GetCombinedAssessmentsQueryBadRequest 

type GetCombinedAssessmentsQueryBadRequest 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.DomainAPICombinedFindingsResponseV1
}

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

Bad Request

func NewGetCombinedAssessmentsQueryBadRequest 

func NewGetCombinedAssessmentsQueryBadRequest() *GetCombinedAssessmentsQueryBadRequest

NewGetCombinedAssessmentsQueryBadRequest creates a GetCombinedAssessmentsQueryBadRequest with default headers values

func (*GetCombinedAssessmentsQueryBadRequest) Code 

func (o *GetCombinedAssessmentsQueryBadRequest) Code() int

Code gets the status code for the get combined assessments query bad request response

func (*GetCombinedAssessmentsQueryBadRequest) Error 

func (o *GetCombinedAssessmentsQueryBadRequest) Error() string

func (*GetCombinedAssessmentsQueryBadRequest) GetPayload 

func (o *GetCombinedAssessmentsQueryBadRequest) GetPayload() *models.DomainAPICombinedFindingsResponseV1

func (*GetCombinedAssessmentsQueryBadRequest) IsClientError 

func (o *GetCombinedAssessmentsQueryBadRequest) IsClientError() bool

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

func (*GetCombinedAssessmentsQueryBadRequest) IsCode 

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

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

func (*GetCombinedAssessmentsQueryBadRequest) IsRedirect 

func (o *GetCombinedAssessmentsQueryBadRequest) IsRedirect() bool

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

func (*GetCombinedAssessmentsQueryBadRequest) IsServerError 

func (o *GetCombinedAssessmentsQueryBadRequest) IsServerError() bool

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

func (*GetCombinedAssessmentsQueryBadRequest) IsSuccess 

func (o *GetCombinedAssessmentsQueryBadRequest) IsSuccess() bool

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

func (*GetCombinedAssessmentsQueryBadRequest) String 

func (o *GetCombinedAssessmentsQueryBadRequest) String() string

type GetCombinedAssessmentsQueryForbidden 

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

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

Forbidden

func NewGetCombinedAssessmentsQueryForbidden 

func NewGetCombinedAssessmentsQueryForbidden() *GetCombinedAssessmentsQueryForbidden

NewGetCombinedAssessmentsQueryForbidden creates a GetCombinedAssessmentsQueryForbidden with default headers values

func (*GetCombinedAssessmentsQueryForbidden) Code 

func (o *GetCombinedAssessmentsQueryForbidden) Code() int

Code gets the status code for the get combined assessments query forbidden response

func (*GetCombinedAssessmentsQueryForbidden) Error 

func (o *GetCombinedAssessmentsQueryForbidden) Error() string

func (*GetCombinedAssessmentsQueryForbidden) GetPayload 

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

func (*GetCombinedAssessmentsQueryForbidden) IsClientError 

func (o *GetCombinedAssessmentsQueryForbidden) IsClientError() bool

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

func (*GetCombinedAssessmentsQueryForbidden) IsCode 

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

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

func (*GetCombinedAssessmentsQueryForbidden) IsRedirect 

func (o *GetCombinedAssessmentsQueryForbidden) IsRedirect() bool

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

func (*GetCombinedAssessmentsQueryForbidden) IsServerError 

func (o *GetCombinedAssessmentsQueryForbidden) IsServerError() bool

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

func (*GetCombinedAssessmentsQueryForbidden) IsSuccess 

func (o *GetCombinedAssessmentsQueryForbidden) IsSuccess() bool

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

func (*GetCombinedAssessmentsQueryForbidden) String 

func (o *GetCombinedAssessmentsQueryForbidden) String() string

type GetCombinedAssessmentsQueryInternalServerError 

type GetCombinedAssessmentsQueryInternalServerError 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.DomainAPICombinedFindingsResponseV1
}

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

Internal Server Error

func NewGetCombinedAssessmentsQueryInternalServerError 

func NewGetCombinedAssessmentsQueryInternalServerError() *GetCombinedAssessmentsQueryInternalServerError

NewGetCombinedAssessmentsQueryInternalServerError creates a GetCombinedAssessmentsQueryInternalServerError with default headers values

func (*GetCombinedAssessmentsQueryInternalServerError) Code 

func (o *GetCombinedAssessmentsQueryInternalServerError) Code() int

Code gets the status code for the get combined assessments query internal server error response

func (*GetCombinedAssessmentsQueryInternalServerError) Error 

func (o *GetCombinedAssessmentsQueryInternalServerError) Error() string

func (*GetCombinedAssessmentsQueryInternalServerError) GetPayload 

func (o *GetCombinedAssessmentsQueryInternalServerError) GetPayload() *models.DomainAPICombinedFindingsResponseV1

func (*GetCombinedAssessmentsQueryInternalServerError) IsClientError 

func (o *GetCombinedAssessmentsQueryInternalServerError) IsClientError() bool

IsClientError returns true when this get combined assessments query internal server error response has a 4xx status code

func (*GetCombinedAssessmentsQueryInternalServerError) IsCode 

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

IsCode returns true when this get combined assessments query internal server error response a status code equal to that given

func (*GetCombinedAssessmentsQueryInternalServerError) IsRedirect 

func (o *GetCombinedAssessmentsQueryInternalServerError) IsRedirect() bool

IsRedirect returns true when this get combined assessments query internal server error response has a 3xx status code

func (*GetCombinedAssessmentsQueryInternalServerError) IsServerError 

func (o *GetCombinedAssessmentsQueryInternalServerError) IsServerError() bool

IsServerError returns true when this get combined assessments query internal server error response has a 5xx status code

func (*GetCombinedAssessmentsQueryInternalServerError) IsSuccess 

func (o *GetCombinedAssessmentsQueryInternalServerError) IsSuccess() bool

IsSuccess returns true when this get combined assessments query internal server error response has a 2xx status code

func (*GetCombinedAssessmentsQueryInternalServerError) String 

func (o *GetCombinedAssessmentsQueryInternalServerError) String() string

type GetCombinedAssessmentsQueryOK 

type GetCombinedAssessmentsQueryOK 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.DomainAPICombinedFindingsResponseV1
}

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

OK

func NewGetCombinedAssessmentsQueryOK 

func NewGetCombinedAssessmentsQueryOK() *GetCombinedAssessmentsQueryOK

NewGetCombinedAssessmentsQueryOK creates a GetCombinedAssessmentsQueryOK with default headers values

func (*GetCombinedAssessmentsQueryOK) Code 

func (o *GetCombinedAssessmentsQueryOK) Code() int

Code gets the status code for the get combined assessments query o k response

func (*GetCombinedAssessmentsQueryOK) Error 

func (o *GetCombinedAssessmentsQueryOK) Error() string

func (*GetCombinedAssessmentsQueryOK) GetPayload 

func (o *GetCombinedAssessmentsQueryOK) GetPayload() *models.DomainAPICombinedFindingsResponseV1

func (*GetCombinedAssessmentsQueryOK) IsClientError 

func (o *GetCombinedAssessmentsQueryOK) IsClientError() bool

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

func (*GetCombinedAssessmentsQueryOK) IsCode 

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

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

func (*GetCombinedAssessmentsQueryOK) IsRedirect 

func (o *GetCombinedAssessmentsQueryOK) IsRedirect() bool

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

func (*GetCombinedAssessmentsQueryOK) IsServerError 

func (o *GetCombinedAssessmentsQueryOK) IsServerError() bool

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

func (*GetCombinedAssessmentsQueryOK) IsSuccess 

func (o *GetCombinedAssessmentsQueryOK) IsSuccess() bool

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

func (*GetCombinedAssessmentsQueryOK) String 

func (o *GetCombinedAssessmentsQueryOK) String() string

type GetCombinedAssessmentsQueryParams 

type GetCombinedAssessmentsQueryParams struct {

	/* After.

	   A pagination token used with the `limit` parameter to manage pagination of results. On your first request, don't provide an `after` token. On subsequent requests, provide the `after` token from the previous response to continue from that place in the results.
	*/
	After *string

	/* Facet.

	     Select various details blocks to be returned for each assessment entity. Supported values:

	<ul><li>host</li><li>finding.rule</li><li>finding.evaluation_logic</li></ul>
	*/
	Facet []string

	/* Filter.

	     Filter items using a query in Falcon Query Language (FQL). Wildcards * are unsupported.

	Common filter options include:

	<ul><li>created_timestamp:>'2019-11-25T22:36:12Z'</li><li>updated_timestamp:>'2019-11-25T22:36:12Z'</li><li>aid:'8e7656b27d8c49a34a1af416424d6231'</li></ul>
	*/
	Filter string

	/* Limit.

	   The number of items to return in this response (default: 100, max: 5000). Use with the after parameter to manage pagination of results.
	*/
	Limit *int64

	/* Sort.

	     Sort assessment by their properties. Common sort options include:

	<ul><li>created_timestamp|desc</li><li>updated_timestamp|asc</li></ul>
	*/
	Sort *string

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

GetCombinedAssessmentsQueryParams contains all the parameters to send to the API endpoint 

for the get combined assessments query operation.

Typically these are written to a http.Request.

func NewGetCombinedAssessmentsQueryParams 

func NewGetCombinedAssessmentsQueryParams() *GetCombinedAssessmentsQueryParams

NewGetCombinedAssessmentsQueryParams creates a new GetCombinedAssessmentsQueryParams 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 NewGetCombinedAssessmentsQueryParamsWithContext 

func NewGetCombinedAssessmentsQueryParamsWithContext(ctx context.Context) *GetCombinedAssessmentsQueryParams

NewGetCombinedAssessmentsQueryParamsWithContext creates a new GetCombinedAssessmentsQueryParams object with the ability to set a context for a request.

func NewGetCombinedAssessmentsQueryParamsWithHTTPClient 

func NewGetCombinedAssessmentsQueryParamsWithHTTPClient(client *http.Client) *GetCombinedAssessmentsQueryParams

NewGetCombinedAssessmentsQueryParamsWithHTTPClient creates a new GetCombinedAssessmentsQueryParams object with the ability to set a custom HTTPClient for a request.

func NewGetCombinedAssessmentsQueryParamsWithTimeout 

func NewGetCombinedAssessmentsQueryParamsWithTimeout(timeout time.Duration) *GetCombinedAssessmentsQueryParams

NewGetCombinedAssessmentsQueryParamsWithTimeout creates a new GetCombinedAssessmentsQueryParams object with the ability to set a timeout on a request.

func (*GetCombinedAssessmentsQueryParams) SetAfter 

func (o *GetCombinedAssessmentsQueryParams) SetAfter(after *string)

SetAfter adds the after to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) SetContext 

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

SetContext adds the context to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) SetDefaults 

func (o *GetCombinedAssessmentsQueryParams) SetDefaults()

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

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

func (*GetCombinedAssessmentsQueryParams) SetFacet 

func (o *GetCombinedAssessmentsQueryParams) SetFacet(facet []string)

SetFacet adds the facet to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) SetFilter 

func (o *GetCombinedAssessmentsQueryParams) SetFilter(filter string)

SetFilter adds the filter to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) SetLimit 

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

SetLimit adds the limit to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) SetSort 

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

SetSort adds the sort to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) SetTimeout 

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

SetTimeout adds the timeout to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) WithAfter 

func (o *GetCombinedAssessmentsQueryParams) WithAfter(after *string) *GetCombinedAssessmentsQueryParams

WithAfter adds the after to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) WithContext 

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

WithContext adds the context to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) WithDefaults 

func (o *GetCombinedAssessmentsQueryParams) WithDefaults() *GetCombinedAssessmentsQueryParams

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

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

func (*GetCombinedAssessmentsQueryParams) WithFacet 

func (o *GetCombinedAssessmentsQueryParams) WithFacet(facet []string) *GetCombinedAssessmentsQueryParams

WithFacet adds the facet to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) WithFilter 

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

WithFilter adds the filter to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) WithLimit 

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

WithLimit adds the limit to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) WithSort 

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

WithSort adds the sort to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) WithTimeout 

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

WithTimeout adds the timeout to the get combined assessments query params

func (*GetCombinedAssessmentsQueryParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetCombinedAssessmentsQueryReader 

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

GetCombinedAssessmentsQueryReader is a Reader for the GetCombinedAssessmentsQuery structure.

func (*GetCombinedAssessmentsQueryReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetCombinedAssessmentsQueryTooManyRequests 

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

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

Too Many Requests

func NewGetCombinedAssessmentsQueryTooManyRequests 

func NewGetCombinedAssessmentsQueryTooManyRequests() *GetCombinedAssessmentsQueryTooManyRequests

NewGetCombinedAssessmentsQueryTooManyRequests creates a GetCombinedAssessmentsQueryTooManyRequests with default headers values

func (*GetCombinedAssessmentsQueryTooManyRequests) Code 

func (o *GetCombinedAssessmentsQueryTooManyRequests) Code() int

Code gets the status code for the get combined assessments query too many requests response

func (*GetCombinedAssessmentsQueryTooManyRequests) Error 

func (o *GetCombinedAssessmentsQueryTooManyRequests) Error() string

func (*GetCombinedAssessmentsQueryTooManyRequests) GetPayload 

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

func (*GetCombinedAssessmentsQueryTooManyRequests) IsClientError 

func (o *GetCombinedAssessmentsQueryTooManyRequests) IsClientError() bool

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

func (*GetCombinedAssessmentsQueryTooManyRequests) IsCode 

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

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

func (*GetCombinedAssessmentsQueryTooManyRequests) IsRedirect 

func (o *GetCombinedAssessmentsQueryTooManyRequests) IsRedirect() bool

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

func (*GetCombinedAssessmentsQueryTooManyRequests) IsServerError 

func (o *GetCombinedAssessmentsQueryTooManyRequests) IsServerError() bool

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

func (*GetCombinedAssessmentsQueryTooManyRequests) IsSuccess 

func (o *GetCombinedAssessmentsQueryTooManyRequests) IsSuccess() bool

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

func (*GetCombinedAssessmentsQueryTooManyRequests) String 

func (o *GetCombinedAssessmentsQueryTooManyRequests) String() string

type GetRuleDetailsForbidden added in v0.5.0 

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

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

Forbidden

func NewGetRuleDetailsForbidden added in v0.5.0 

func NewGetRuleDetailsForbidden() *GetRuleDetailsForbidden

NewGetRuleDetailsForbidden creates a GetRuleDetailsForbidden with default headers values

func (*GetRuleDetailsForbidden) Code added in v0.5.0 

func (o *GetRuleDetailsForbidden) Code() int

Code gets the status code for the get rule details forbidden response

func (*GetRuleDetailsForbidden) Error added in v0.5.0 

func (o *GetRuleDetailsForbidden) Error() string

func (*GetRuleDetailsForbidden) GetPayload added in v0.5.0 

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

func (*GetRuleDetailsForbidden) IsClientError added in v0.5.0 

func (o *GetRuleDetailsForbidden) IsClientError() bool

IsClientError returns true when this get rule details forbidden response has a 4xx status code

func (*GetRuleDetailsForbidden) IsCode added in v0.5.0 

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

IsCode returns true when this get rule details forbidden response a status code equal to that given

func (*GetRuleDetailsForbidden) IsRedirect added in v0.5.0 

func (o *GetRuleDetailsForbidden) IsRedirect() bool

IsRedirect returns true when this get rule details forbidden response has a 3xx status code

func (*GetRuleDetailsForbidden) IsServerError added in v0.5.0 

func (o *GetRuleDetailsForbidden) IsServerError() bool

IsServerError returns true when this get rule details forbidden response has a 5xx status code

func (*GetRuleDetailsForbidden) IsSuccess added in v0.5.0 

func (o *GetRuleDetailsForbidden) IsSuccess() bool

IsSuccess returns true when this get rule details forbidden response has a 2xx status code

func (*GetRuleDetailsForbidden) String added in v0.5.0 

func (o *GetRuleDetailsForbidden) String() string

type GetRuleDetailsOK added in v0.5.0 

type GetRuleDetailsOK 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.DomainAPIRuleDetailsResponseV1
}

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

OK

func NewGetRuleDetailsOK added in v0.5.0 

func NewGetRuleDetailsOK() *GetRuleDetailsOK

NewGetRuleDetailsOK creates a GetRuleDetailsOK with default headers values

func (*GetRuleDetailsOK) Code added in v0.5.0 

func (o *GetRuleDetailsOK) Code() int

Code gets the status code for the get rule details o k response

func (*GetRuleDetailsOK) Error added in v0.5.0 

func (o *GetRuleDetailsOK) Error() string

func (*GetRuleDetailsOK) GetPayload added in v0.5.0 

func (o *GetRuleDetailsOK) GetPayload() *models.DomainAPIRuleDetailsResponseV1

func (*GetRuleDetailsOK) IsClientError added in v0.5.0 

func (o *GetRuleDetailsOK) IsClientError() bool

IsClientError returns true when this get rule details o k response has a 4xx status code

func (*GetRuleDetailsOK) IsCode added in v0.5.0 

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

IsCode returns true when this get rule details o k response a status code equal to that given

func (*GetRuleDetailsOK) IsRedirect added in v0.5.0 

func (o *GetRuleDetailsOK) IsRedirect() bool

IsRedirect returns true when this get rule details o k response has a 3xx status code

func (*GetRuleDetailsOK) IsServerError added in v0.5.0 

func (o *GetRuleDetailsOK) IsServerError() bool

IsServerError returns true when this get rule details o k response has a 5xx status code

func (*GetRuleDetailsOK) IsSuccess added in v0.5.0 

func (o *GetRuleDetailsOK) IsSuccess() bool

IsSuccess returns true when this get rule details o k response has a 2xx status code

func (*GetRuleDetailsOK) String added in v0.5.0 

func (o *GetRuleDetailsOK) String() string

type GetRuleDetailsParams added in v0.5.0 

type GetRuleDetailsParams struct {

	/* Ids.

	   One or more rules IDs (max: 400)
	*/
	Ids []string

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

GetRuleDetailsParams contains all the parameters to send to the API endpoint 

for the get rule details operation.

Typically these are written to a http.Request.

func NewGetRuleDetailsParams added in v0.5.0 

func NewGetRuleDetailsParams() *GetRuleDetailsParams

NewGetRuleDetailsParams creates a new GetRuleDetailsParams 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 NewGetRuleDetailsParamsWithContext added in v0.5.0 

func NewGetRuleDetailsParamsWithContext(ctx context.Context) *GetRuleDetailsParams

NewGetRuleDetailsParamsWithContext creates a new GetRuleDetailsParams object with the ability to set a context for a request.

func NewGetRuleDetailsParamsWithHTTPClient added in v0.5.0 

func NewGetRuleDetailsParamsWithHTTPClient(client *http.Client) *GetRuleDetailsParams

NewGetRuleDetailsParamsWithHTTPClient creates a new GetRuleDetailsParams object with the ability to set a custom HTTPClient for a request.

func NewGetRuleDetailsParamsWithTimeout added in v0.5.0 

func NewGetRuleDetailsParamsWithTimeout(timeout time.Duration) *GetRuleDetailsParams

NewGetRuleDetailsParamsWithTimeout creates a new GetRuleDetailsParams object with the ability to set a timeout on a request.

func (*GetRuleDetailsParams) SetContext added in v0.5.0 

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

SetContext adds the context to the get rule details params

func (*GetRuleDetailsParams) SetDefaults added in v0.5.0 

func (o *GetRuleDetailsParams) SetDefaults()

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

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

func (*GetRuleDetailsParams) SetHTTPClient added in v0.5.0 

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

SetHTTPClient adds the HTTPClient to the get rule details params

func (*GetRuleDetailsParams) SetIds added in v0.5.0 

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

SetIds adds the ids to the get rule details params

func (*GetRuleDetailsParams) SetTimeout added in v0.5.0 

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

SetTimeout adds the timeout to the get rule details params

func (*GetRuleDetailsParams) WithContext added in v0.5.0 

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

WithContext adds the context to the get rule details params

func (*GetRuleDetailsParams) WithDefaults added in v0.5.0 

func (o *GetRuleDetailsParams) WithDefaults() *GetRuleDetailsParams

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

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

func (*GetRuleDetailsParams) WithHTTPClient added in v0.5.0 

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

WithHTTPClient adds the HTTPClient to the get rule details params

func (*GetRuleDetailsParams) WithIds added in v0.5.0 

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

WithIds adds the ids to the get rule details params

func (*GetRuleDetailsParams) WithTimeout added in v0.5.0 

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

WithTimeout adds the timeout to the get rule details params

func (*GetRuleDetailsParams) WriteToRequest added in v0.5.0 

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

WriteToRequest writes these params to a swagger request

type GetRuleDetailsReader added in v0.5.0 

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

GetRuleDetailsReader is a Reader for the GetRuleDetails structure.

func (*GetRuleDetailsReader) ReadResponse added in v0.5.0 

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

ReadResponse reads a server response into the received o.

type GetRuleDetailsTooManyRequests added in v0.5.0 

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

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

Too Many Requests

func NewGetRuleDetailsTooManyRequests added in v0.5.0 

func NewGetRuleDetailsTooManyRequests() *GetRuleDetailsTooManyRequests

NewGetRuleDetailsTooManyRequests creates a GetRuleDetailsTooManyRequests with default headers values

func (*GetRuleDetailsTooManyRequests) Code added in v0.5.0 

func (o *GetRuleDetailsTooManyRequests) Code() int

Code gets the status code for the get rule details too many requests response

func (*GetRuleDetailsTooManyRequests) Error added in v0.5.0 

func (o *GetRuleDetailsTooManyRequests) Error() string

func (*GetRuleDetailsTooManyRequests) GetPayload added in v0.5.0 

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

func (*GetRuleDetailsTooManyRequests) IsClientError added in v0.5.0 

func (o *GetRuleDetailsTooManyRequests) IsClientError() bool

IsClientError returns true when this get rule details too many requests response has a 4xx status code

func (*GetRuleDetailsTooManyRequests) IsCode added in v0.5.0 

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

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

func (*GetRuleDetailsTooManyRequests) IsRedirect added in v0.5.0 

func (o *GetRuleDetailsTooManyRequests) IsRedirect() bool

IsRedirect returns true when this get rule details too many requests response has a 3xx status code

func (*GetRuleDetailsTooManyRequests) IsServerError added in v0.5.0 

func (o *GetRuleDetailsTooManyRequests) IsServerError() bool

IsServerError returns true when this get rule details too many requests response has a 5xx status code

func (*GetRuleDetailsTooManyRequests) IsSuccess added in v0.5.0 

func (o *GetRuleDetailsTooManyRequests) IsSuccess() bool

IsSuccess returns true when this get rule details too many requests response has a 2xx status code

func (*GetRuleDetailsTooManyRequests) String added in v0.5.0 

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