spotlight_vulnerabilities

package
v0.2.5 Latest Latest
Warning

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

Go to latest
Published: Jun 17, 2021 License: MIT Imports: 11 Imported by: 3

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 spotlight vulnerabilities API

func (*Client) GetVulnerabilities

func (a *Client) GetVulnerabilities(params *GetVulnerabilitiesParams, opts ...ClientOption) (*GetVulnerabilitiesOK, error)

GetVulnerabilities gets details on vulnerabilities by providing one or more i ds

func (*Client) QueryVulnerabilities

func (a *Client) QueryVulnerabilities(params *QueryVulnerabilitiesParams, opts ...ClientOption) (*QueryVulnerabilitiesOK, error)

QueryVulnerabilities searches for vulnerabilities in your environment by providing an f q l filter and paging details returns a set of vulnerability i ds which match the filter criteria

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 {
	GetVulnerabilities(params *GetVulnerabilitiesParams, opts ...ClientOption) (*GetVulnerabilitiesOK, error)

	QueryVulnerabilities(params *QueryVulnerabilitiesParams, opts ...ClientOption) (*QueryVulnerabilitiesOK, 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 spotlight vulnerabilities API client.

type GetVulnerabilitiesDefault

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

OK

func NewGetVulnerabilitiesDefault

func NewGetVulnerabilitiesDefault(code int) *GetVulnerabilitiesDefault

NewGetVulnerabilitiesDefault creates a GetVulnerabilitiesDefault with default headers values

func (*GetVulnerabilitiesDefault) Code

func (o *GetVulnerabilitiesDefault) Code() int

Code gets the status code for the get vulnerabilities default response

func (*GetVulnerabilitiesDefault) Error

func (o *GetVulnerabilitiesDefault) Error() string

func (*GetVulnerabilitiesDefault) GetPayload

type GetVulnerabilitiesForbidden

type GetVulnerabilitiesForbidden struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

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

	Payload *models.MsaReplyMetaOnly
}
GetVulnerabilitiesForbidden describes a response with status code 403, with default header values.

Forbidden

func NewGetVulnerabilitiesForbidden

func NewGetVulnerabilitiesForbidden() *GetVulnerabilitiesForbidden

NewGetVulnerabilitiesForbidden creates a GetVulnerabilitiesForbidden with default headers values

func (*GetVulnerabilitiesForbidden) Error

func (*GetVulnerabilitiesForbidden) GetPayload

type GetVulnerabilitiesOK

type GetVulnerabilitiesOK struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

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

	Payload *models.DomainSPAPIVulnerabilitiesEntitiesResponseV2
}
GetVulnerabilitiesOK describes a response with status code 200, with default header values.

OK

func NewGetVulnerabilitiesOK

func NewGetVulnerabilitiesOK() *GetVulnerabilitiesOK

NewGetVulnerabilitiesOK creates a GetVulnerabilitiesOK with default headers values

func (*GetVulnerabilitiesOK) Error

func (o *GetVulnerabilitiesOK) Error() string

func (*GetVulnerabilitiesOK) GetPayload

type GetVulnerabilitiesParams

type GetVulnerabilitiesParams struct {

	/* Ids.

	   One or more vulnerability IDs (max: 400). Find vulnerability IDs with GET /spotlight/queries/vulnerabilities/v1
	*/
	Ids []string

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

GetVulnerabilitiesParams contains all the parameters to send to the API endpoint

for the get vulnerabilities operation.

Typically these are written to a http.Request.

func NewGetVulnerabilitiesParams

func NewGetVulnerabilitiesParams() *GetVulnerabilitiesParams

NewGetVulnerabilitiesParams creates a new GetVulnerabilitiesParams 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 NewGetVulnerabilitiesParamsWithContext

func NewGetVulnerabilitiesParamsWithContext(ctx context.Context) *GetVulnerabilitiesParams

NewGetVulnerabilitiesParamsWithContext creates a new GetVulnerabilitiesParams object with the ability to set a context for a request.

func NewGetVulnerabilitiesParamsWithHTTPClient

func NewGetVulnerabilitiesParamsWithHTTPClient(client *http.Client) *GetVulnerabilitiesParams

NewGetVulnerabilitiesParamsWithHTTPClient creates a new GetVulnerabilitiesParams object with the ability to set a custom HTTPClient for a request.

func NewGetVulnerabilitiesParamsWithTimeout

func NewGetVulnerabilitiesParamsWithTimeout(timeout time.Duration) *GetVulnerabilitiesParams

NewGetVulnerabilitiesParamsWithTimeout creates a new GetVulnerabilitiesParams object with the ability to set a timeout on a request.

func (*GetVulnerabilitiesParams) SetContext

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

SetContext adds the context to the get vulnerabilities params

func (*GetVulnerabilitiesParams) SetDefaults

func (o *GetVulnerabilitiesParams) SetDefaults()

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

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

func (*GetVulnerabilitiesParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get vulnerabilities params

func (*GetVulnerabilitiesParams) SetIds

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

SetIds adds the ids to the get vulnerabilities params

func (*GetVulnerabilitiesParams) SetTimeout

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

SetTimeout adds the timeout to the get vulnerabilities params

func (*GetVulnerabilitiesParams) WithContext

WithContext adds the context to the get vulnerabilities params

func (*GetVulnerabilitiesParams) WithDefaults

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

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

func (*GetVulnerabilitiesParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get vulnerabilities params

func (*GetVulnerabilitiesParams) WithIds

WithIds adds the ids to the get vulnerabilities params

func (*GetVulnerabilitiesParams) WithTimeout

WithTimeout adds the timeout to the get vulnerabilities params

func (*GetVulnerabilitiesParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetVulnerabilitiesReader

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

GetVulnerabilitiesReader is a Reader for the GetVulnerabilities structure.

func (*GetVulnerabilitiesReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetVulnerabilitiesTooManyRequests

type GetVulnerabilitiesTooManyRequests struct {

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

Too Many Requests

func NewGetVulnerabilitiesTooManyRequests

func NewGetVulnerabilitiesTooManyRequests() *GetVulnerabilitiesTooManyRequests

NewGetVulnerabilitiesTooManyRequests creates a GetVulnerabilitiesTooManyRequests with default headers values

func (*GetVulnerabilitiesTooManyRequests) Error

func (*GetVulnerabilitiesTooManyRequests) GetPayload

type QueryVulnerabilitiesBadRequest

type QueryVulnerabilitiesBadRequest struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

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

	Payload *models.DomainSPAPIQueryVulnerabilitiesResponse
}
QueryVulnerabilitiesBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewQueryVulnerabilitiesBadRequest

func NewQueryVulnerabilitiesBadRequest() *QueryVulnerabilitiesBadRequest

NewQueryVulnerabilitiesBadRequest creates a QueryVulnerabilitiesBadRequest with default headers values

func (*QueryVulnerabilitiesBadRequest) Error

func (*QueryVulnerabilitiesBadRequest) GetPayload

type QueryVulnerabilitiesDefault

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

OK

func NewQueryVulnerabilitiesDefault

func NewQueryVulnerabilitiesDefault(code int) *QueryVulnerabilitiesDefault

NewQueryVulnerabilitiesDefault creates a QueryVulnerabilitiesDefault with default headers values

func (*QueryVulnerabilitiesDefault) Code

func (o *QueryVulnerabilitiesDefault) Code() int

Code gets the status code for the query vulnerabilities default response

func (*QueryVulnerabilitiesDefault) Error

func (*QueryVulnerabilitiesDefault) GetPayload

type QueryVulnerabilitiesForbidden

type QueryVulnerabilitiesForbidden struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

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

	Payload *models.MsaReplyMetaOnly
}
QueryVulnerabilitiesForbidden describes a response with status code 403, with default header values.

Forbidden

func NewQueryVulnerabilitiesForbidden

func NewQueryVulnerabilitiesForbidden() *QueryVulnerabilitiesForbidden

NewQueryVulnerabilitiesForbidden creates a QueryVulnerabilitiesForbidden with default headers values

func (*QueryVulnerabilitiesForbidden) Error

func (*QueryVulnerabilitiesForbidden) GetPayload

type QueryVulnerabilitiesInternalServerError

type QueryVulnerabilitiesInternalServerError struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

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

	Payload *models.DomainSPAPIQueryVulnerabilitiesResponse
}
QueryVulnerabilitiesInternalServerError describes a response with status code 500, with default header values.

Internal Server Error

func NewQueryVulnerabilitiesInternalServerError

func NewQueryVulnerabilitiesInternalServerError() *QueryVulnerabilitiesInternalServerError

NewQueryVulnerabilitiesInternalServerError creates a QueryVulnerabilitiesInternalServerError with default headers values

func (*QueryVulnerabilitiesInternalServerError) Error

func (*QueryVulnerabilitiesInternalServerError) GetPayload

type QueryVulnerabilitiesOK

type QueryVulnerabilitiesOK struct {

	/* Request limit per minute.
	 */
	XRateLimitLimit int64

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

	Payload *models.DomainSPAPIQueryVulnerabilitiesResponse
}
QueryVulnerabilitiesOK describes a response with status code 200, with default header values.

OK

func NewQueryVulnerabilitiesOK

func NewQueryVulnerabilitiesOK() *QueryVulnerabilitiesOK

NewQueryVulnerabilitiesOK creates a QueryVulnerabilitiesOK with default headers values

func (*QueryVulnerabilitiesOK) Error

func (o *QueryVulnerabilitiesOK) Error() string

func (*QueryVulnerabilitiesOK) GetPayload

type QueryVulnerabilitiesParams

type QueryVulnerabilitiesParams 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

	/* 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>closed_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: 400). Use with the after parameter to manage pagination of results.
	*/
	Limit *int64

	/* Sort.

	     Sort vulnerabilities by their properties. Common sort options include:

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

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

QueryVulnerabilitiesParams contains all the parameters to send to the API endpoint

for the query vulnerabilities operation.

Typically these are written to a http.Request.

func NewQueryVulnerabilitiesParams

func NewQueryVulnerabilitiesParams() *QueryVulnerabilitiesParams

NewQueryVulnerabilitiesParams creates a new QueryVulnerabilitiesParams 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 NewQueryVulnerabilitiesParamsWithContext

func NewQueryVulnerabilitiesParamsWithContext(ctx context.Context) *QueryVulnerabilitiesParams

NewQueryVulnerabilitiesParamsWithContext creates a new QueryVulnerabilitiesParams object with the ability to set a context for a request.

func NewQueryVulnerabilitiesParamsWithHTTPClient

func NewQueryVulnerabilitiesParamsWithHTTPClient(client *http.Client) *QueryVulnerabilitiesParams

NewQueryVulnerabilitiesParamsWithHTTPClient creates a new QueryVulnerabilitiesParams object with the ability to set a custom HTTPClient for a request.

func NewQueryVulnerabilitiesParamsWithTimeout

func NewQueryVulnerabilitiesParamsWithTimeout(timeout time.Duration) *QueryVulnerabilitiesParams

NewQueryVulnerabilitiesParamsWithTimeout creates a new QueryVulnerabilitiesParams object with the ability to set a timeout on a request.

func (*QueryVulnerabilitiesParams) SetAfter

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

SetAfter adds the after to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) SetContext

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

SetContext adds the context to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) SetDefaults

func (o *QueryVulnerabilitiesParams) SetDefaults()

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

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

func (*QueryVulnerabilitiesParams) SetFilter

func (o *QueryVulnerabilitiesParams) SetFilter(filter string)

SetFilter adds the filter to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) SetLimit

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

SetLimit adds the limit to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) SetSort

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

SetSort adds the sort to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) SetTimeout

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

SetTimeout adds the timeout to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) WithAfter

WithAfter adds the after to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) WithContext

WithContext adds the context to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) WithDefaults

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

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

func (*QueryVulnerabilitiesParams) WithFilter

WithFilter adds the filter to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) WithLimit

WithLimit adds the limit to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) WithSort

WithSort adds the sort to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) WithTimeout

WithTimeout adds the timeout to the query vulnerabilities params

func (*QueryVulnerabilitiesParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type QueryVulnerabilitiesReader

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

QueryVulnerabilitiesReader is a Reader for the QueryVulnerabilities structure.

func (*QueryVulnerabilitiesReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type QueryVulnerabilitiesTooManyRequests

type QueryVulnerabilitiesTooManyRequests struct {

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

Too Many Requests

func NewQueryVulnerabilitiesTooManyRequests

func NewQueryVulnerabilitiesTooManyRequests() *QueryVulnerabilitiesTooManyRequests

NewQueryVulnerabilitiesTooManyRequests creates a QueryVulnerabilitiesTooManyRequests with default headers values

func (*QueryVulnerabilitiesTooManyRequests) Error

func (*QueryVulnerabilitiesTooManyRequests) GetPayload

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL