api

package
v0.12.0 Latest Latest
Warning

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

 Go to latest Published: Feb 11, 2023 License: AGPL-3.0 Imports: 11 Imported by: 1

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

func (*Client) GetResult 

func (a *Client) GetResult(params *GetResultParams, opts ...ClientOption) (*GetResultOK, error)

GetResult ACRs cloud result

Use this endpoint to fetch information on an exact entry.

func (*Client) GetResults 

func (a *Client) GetResults(params *GetResultsParams, opts ...ClientOption) (*GetResultsOK, error)

GetResults gets ACR cloud results

This is endpoint is useful for looking into and exporting the dataset.

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption added in v0.11.1 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	GetResult(params *GetResultParams, opts ...ClientOption) (*GetResultOK, error)

	GetResults(params *GetResultsParams, opts ...ClientOption) (*GetResultsOK, 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 api API client.

type GetResultInternalServerError 

type GetResultInternalServerError struct {
}
GetResultInternalServerError describes a response with status code 500, with default header values.

Server Error

func NewGetResultInternalServerError 

func NewGetResultInternalServerError() *GetResultInternalServerError

NewGetResultInternalServerError creates a GetResultInternalServerError with default headers values

func (*GetResultInternalServerError) Error 

func (o *GetResultInternalServerError) Error() string

type GetResultOK 

type GetResultOK struct {
	Payload *models.Result
}
GetResultOK describes a response with status code 200, with default header values.

Returns single result

func NewGetResultOK 

func NewGetResultOK() *GetResultOK

NewGetResultOK creates a GetResultOK with default headers values

func (*GetResultOK) Error 

func (o *GetResultOK) Error() string

func (*GetResultOK) GetPayload 

func (o *GetResultOK) GetPayload() *models.Result

type GetResultParams 

type GetResultParams struct {

	// XRequestID.
	XRequestID *string

	// ResultID.
	ResultID int64

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

GetResultParams contains all the parameters to send to the API endpoint 

for the get result operation.

Typically these are written to a http.Request.

func NewGetResultParams 

func NewGetResultParams() *GetResultParams

NewGetResultParams creates a new GetResultParams 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 NewGetResultParamsWithContext 

func NewGetResultParamsWithContext(ctx context.Context) *GetResultParams

NewGetResultParamsWithContext creates a new GetResultParams object with the ability to set a context for a request.

func NewGetResultParamsWithHTTPClient 

func NewGetResultParamsWithHTTPClient(client *http.Client) *GetResultParams

NewGetResultParamsWithHTTPClient creates a new GetResultParams object with the ability to set a custom HTTPClient for a request.

func NewGetResultParamsWithTimeout 

func NewGetResultParamsWithTimeout(timeout time.Duration) *GetResultParams

NewGetResultParamsWithTimeout creates a new GetResultParams object with the ability to set a timeout on a request.

func (*GetResultParams) SetContext 

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

SetContext adds the context to the get result params

func (*GetResultParams) SetDefaults added in v0.11.1 

func (o *GetResultParams) SetDefaults()

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

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

func (*GetResultParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get result params

func (*GetResultParams) SetResultID 

func (o *GetResultParams) SetResultID(resultID int64)

SetResultID adds the resultId to the get result params

func (*GetResultParams) SetTimeout 

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

SetTimeout adds the timeout to the get result params

func (*GetResultParams) SetXRequestID added in v0.8.0 

func (o *GetResultParams) SetXRequestID(xRequestID *string)

SetXRequestID adds the xRequestId to the get result params

func (*GetResultParams) WithContext 

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

WithContext adds the context to the get result params

func (*GetResultParams) WithDefaults added in v0.11.1 

func (o *GetResultParams) WithDefaults() *GetResultParams

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

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

func (*GetResultParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get result params

func (*GetResultParams) WithResultID 

func (o *GetResultParams) WithResultID(resultID int64) *GetResultParams

WithResultID adds the resultID to the get result params

func (*GetResultParams) WithTimeout 

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

WithTimeout adds the timeout to the get result params

func (*GetResultParams) WithXRequestID added in v0.8.0 

func (o *GetResultParams) WithXRequestID(xRequestID *string) *GetResultParams

WithXRequestID adds the xRequestID to the get result params

func (*GetResultParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetResultReader 

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

GetResultReader is a Reader for the GetResult structure.

func (*GetResultReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetResultsInternalServerError 

type GetResultsInternalServerError struct {
}
GetResultsInternalServerError describes a response with status code 500, with default header values.

Server Error

func NewGetResultsInternalServerError 

func NewGetResultsInternalServerError() *GetResultsInternalServerError

NewGetResultsInternalServerError creates a GetResultsInternalServerError with default headers values

func (*GetResultsInternalServerError) Error 

func (o *GetResultsInternalServerError) Error() string

type GetResultsOK 

type GetResultsOK struct {
	Payload []*models.Result
}
GetResultsOK describes a response with status code 200, with default header values.

Returns array of results

func NewGetResultsOK 

func NewGetResultsOK() *GetResultsOK

NewGetResultsOK creates a GetResultsOK with default headers values

func (*GetResultsOK) Error 

func (o *GetResultsOK) Error() string

func (*GetResultsOK) GetPayload 

func (o *GetResultsOK) GetPayload() []*models.Result

type GetResultsParams 

type GetResultsParams struct {

	// XRequestID.
	XRequestID *string

	// From.
	//
	// Format: date-time
	From *strfmt.DateTime

	/* Limit.

	   The numbers of items to return.

	   Default: 20
	*/
	Limit *int64

	/* Offset.

	   The number of items to skip before starting to collect the result set.
	*/
	Offset *int64

	// To.
	//
	// Format: date-time
	To *strfmt.DateTime

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

GetResultsParams contains all the parameters to send to the API endpoint 

for the get results operation.

Typically these are written to a http.Request.

func NewGetResultsParams 

func NewGetResultsParams() *GetResultsParams

NewGetResultsParams creates a new GetResultsParams 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 NewGetResultsParamsWithContext 

func NewGetResultsParamsWithContext(ctx context.Context) *GetResultsParams

NewGetResultsParamsWithContext creates a new GetResultsParams object with the ability to set a context for a request.

func NewGetResultsParamsWithHTTPClient 

func NewGetResultsParamsWithHTTPClient(client *http.Client) *GetResultsParams

NewGetResultsParamsWithHTTPClient creates a new GetResultsParams object with the ability to set a custom HTTPClient for a request.

func NewGetResultsParamsWithTimeout 

func NewGetResultsParamsWithTimeout(timeout time.Duration) *GetResultsParams

NewGetResultsParamsWithTimeout creates a new GetResultsParams object with the ability to set a timeout on a request.

func (*GetResultsParams) SetContext 

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

SetContext adds the context to the get results params

func (*GetResultsParams) SetDefaults added in v0.11.1 

func (o *GetResultsParams) SetDefaults()

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

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

func (*GetResultsParams) SetFrom 

func (o *GetResultsParams) SetFrom(from *strfmt.DateTime)

SetFrom adds the from to the get results params

func (*GetResultsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get results params

func (*GetResultsParams) SetLimit 

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

SetLimit adds the limit to the get results params

func (*GetResultsParams) SetOffset 

func (o *GetResultsParams) SetOffset(offset *int64)

SetOffset adds the offset to the get results params

func (*GetResultsParams) SetTimeout 

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

SetTimeout adds the timeout to the get results params

func (*GetResultsParams) SetTo 

func (o *GetResultsParams) SetTo(to *strfmt.DateTime)

SetTo adds the to to the get results params

func (*GetResultsParams) SetXRequestID added in v0.8.0 

func (o *GetResultsParams) SetXRequestID(xRequestID *string)

SetXRequestID adds the xRequestId to the get results params

func (*GetResultsParams) WithContext 

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

WithContext adds the context to the get results params

func (*GetResultsParams) WithDefaults added in v0.11.1 

func (o *GetResultsParams) WithDefaults() *GetResultsParams

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

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

func (*GetResultsParams) WithFrom 

func (o *GetResultsParams) WithFrom(from *strfmt.DateTime) *GetResultsParams

WithFrom adds the from to the get results params

func (*GetResultsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get results params

func (*GetResultsParams) WithLimit 

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

WithLimit adds the limit to the get results params

func (*GetResultsParams) WithOffset 

func (o *GetResultsParams) WithOffset(offset *int64) *GetResultsParams

WithOffset adds the offset to the get results params

func (*GetResultsParams) WithTimeout 

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

WithTimeout adds the timeout to the get results params

func (*GetResultsParams) WithTo 

func (o *GetResultsParams) WithTo(to *strfmt.DateTime) *GetResultsParams

WithTo adds the to to the get results params

func (*GetResultsParams) WithXRequestID added in v0.8.0 

func (o *GetResultsParams) WithXRequestID(xRequestID *string) *GetResultsParams

WithXRequestID adds the xRequestID to the get results params

func (*GetResultsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetResultsReader 

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

GetResultsReader is a Reader for the GetResults structure.

func (*GetResultsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

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.