circuit

package
v1.2.2 Latest Latest
Warning

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

 Go to latest Published: Nov 23, 2024 License: Apache-2.0 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 circuit API

func (*Client) DeleteCircuit 

func (a *Client) DeleteCircuit(params *DeleteCircuitParams, opts ...ClientOption) (*DeleteCircuitOK, error)

DeleteCircuit deletes a circuit

Delete a circuit by id. Requires admin access.

func (*Client) DetailCircuit 

func (a *Client) DetailCircuit(params *DetailCircuitParams, opts ...ClientOption) (*DetailCircuitOK, error)

DetailCircuit retrieves a single circuit

Retrieves a single circuit by id. Requires admin access.

func (*Client) ListCircuits 

func (a *Client) ListCircuits(params *ListCircuitsParams, opts ...ClientOption) (*ListCircuitsOK, error)

ListCircuits lists circuits

Retrieves a list of circuit resources; does not supports filtering, sorting, or pagination. Requires admin access.

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 {
	DeleteCircuit(params *DeleteCircuitParams, opts ...ClientOption) (*DeleteCircuitOK, error)

	DetailCircuit(params *DetailCircuitParams, opts ...ClientOption) (*DetailCircuitOK, error)

	ListCircuits(params *ListCircuitsParams, opts ...ClientOption) (*ListCircuitsOK, 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 circuit API client.

type DeleteCircuitBadRequest 

type DeleteCircuitBadRequest struct {
	Payload *rest_model.APIErrorEnvelope
}
DeleteCircuitBadRequest describes a response with status code 400, with default header values.

The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information

func NewDeleteCircuitBadRequest 

func NewDeleteCircuitBadRequest() *DeleteCircuitBadRequest

NewDeleteCircuitBadRequest creates a DeleteCircuitBadRequest with default headers values

func (*DeleteCircuitBadRequest) Error 

func (o *DeleteCircuitBadRequest) Error() string

func (*DeleteCircuitBadRequest) GetPayload 

func (o *DeleteCircuitBadRequest) GetPayload() *rest_model.APIErrorEnvelope

type DeleteCircuitConflict 

type DeleteCircuitConflict struct {
	Payload *rest_model.APIErrorEnvelope
}
DeleteCircuitConflict describes a response with status code 409, with default header values.

The resource requested to be removed/altered cannot be as it is referenced by another object.

func NewDeleteCircuitConflict 

func NewDeleteCircuitConflict() *DeleteCircuitConflict

NewDeleteCircuitConflict creates a DeleteCircuitConflict with default headers values

func (*DeleteCircuitConflict) Error 

func (o *DeleteCircuitConflict) Error() string

func (*DeleteCircuitConflict) GetPayload 

func (o *DeleteCircuitConflict) GetPayload() *rest_model.APIErrorEnvelope

type DeleteCircuitOK 

type DeleteCircuitOK struct {
	Payload *rest_model.Empty
}
DeleteCircuitOK describes a response with status code 200, with default header values.

The delete request was successful and the resource has been removed

func NewDeleteCircuitOK 

func NewDeleteCircuitOK() *DeleteCircuitOK

NewDeleteCircuitOK creates a DeleteCircuitOK with default headers values

func (*DeleteCircuitOK) Error 

func (o *DeleteCircuitOK) Error() string

func (*DeleteCircuitOK) GetPayload 

func (o *DeleteCircuitOK) GetPayload() *rest_model.Empty

type DeleteCircuitParams 

type DeleteCircuitParams struct {

	/* ID.

	   The id of the requested resource
	*/
	ID string

	/* Options.

	   A circuit delete object
	*/
	Options *rest_model.CircuitDelete

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

DeleteCircuitParams contains all the parameters to send to the API endpoint 

for the delete circuit operation.

Typically these are written to a http.Request.

func NewDeleteCircuitParams 

func NewDeleteCircuitParams() *DeleteCircuitParams

NewDeleteCircuitParams creates a new DeleteCircuitParams 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 NewDeleteCircuitParamsWithContext 

func NewDeleteCircuitParamsWithContext(ctx context.Context) *DeleteCircuitParams

NewDeleteCircuitParamsWithContext creates a new DeleteCircuitParams object with the ability to set a context for a request.

func NewDeleteCircuitParamsWithHTTPClient 

func NewDeleteCircuitParamsWithHTTPClient(client *http.Client) *DeleteCircuitParams

NewDeleteCircuitParamsWithHTTPClient creates a new DeleteCircuitParams object with the ability to set a custom HTTPClient for a request.

func NewDeleteCircuitParamsWithTimeout 

func NewDeleteCircuitParamsWithTimeout(timeout time.Duration) *DeleteCircuitParams

NewDeleteCircuitParamsWithTimeout creates a new DeleteCircuitParams object with the ability to set a timeout on a request.

func (*DeleteCircuitParams) SetContext 

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

SetContext adds the context to the delete circuit params

func (*DeleteCircuitParams) SetDefaults 

func (o *DeleteCircuitParams) SetDefaults()

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

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

func (*DeleteCircuitParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the delete circuit params

func (*DeleteCircuitParams) SetID 

func (o *DeleteCircuitParams) SetID(id string)

SetID adds the id to the delete circuit params

func (*DeleteCircuitParams) SetOptions 

func (o *DeleteCircuitParams) SetOptions(options *rest_model.CircuitDelete)

SetOptions adds the options to the delete circuit params

func (*DeleteCircuitParams) SetTimeout 

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

SetTimeout adds the timeout to the delete circuit params

func (*DeleteCircuitParams) WithContext 

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

WithContext adds the context to the delete circuit params

func (*DeleteCircuitParams) WithDefaults 

func (o *DeleteCircuitParams) WithDefaults() *DeleteCircuitParams

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

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

func (*DeleteCircuitParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the delete circuit params

func (*DeleteCircuitParams) WithID 

func (o *DeleteCircuitParams) WithID(id string) *DeleteCircuitParams

WithID adds the id to the delete circuit params

func (*DeleteCircuitParams) WithOptions 

func (o *DeleteCircuitParams) WithOptions(options *rest_model.CircuitDelete) *DeleteCircuitParams

WithOptions adds the options to the delete circuit params

func (*DeleteCircuitParams) WithTimeout 

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

WithTimeout adds the timeout to the delete circuit params

func (*DeleteCircuitParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DeleteCircuitReader 

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

DeleteCircuitReader is a Reader for the DeleteCircuit structure.

func (*DeleteCircuitReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DeleteCircuitTooManyRequests added in v0.31.0 

type DeleteCircuitTooManyRequests struct {
	Payload *rest_model.APIErrorEnvelope
}
DeleteCircuitTooManyRequests describes a response with status code 429, with default header values.

The resource requested is rate limited and the rate limit has been exceeded

func NewDeleteCircuitTooManyRequests added in v0.31.0 

func NewDeleteCircuitTooManyRequests() *DeleteCircuitTooManyRequests

NewDeleteCircuitTooManyRequests creates a DeleteCircuitTooManyRequests with default headers values

func (*DeleteCircuitTooManyRequests) Error added in v0.31.0 

func (o *DeleteCircuitTooManyRequests) Error() string

func (*DeleteCircuitTooManyRequests) GetPayload added in v0.31.0 

func (o *DeleteCircuitTooManyRequests) GetPayload() *rest_model.APIErrorEnvelope

type DeleteCircuitUnauthorized 

type DeleteCircuitUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}
DeleteCircuitUnauthorized describes a response with status code 401, with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewDeleteCircuitUnauthorized 

func NewDeleteCircuitUnauthorized() *DeleteCircuitUnauthorized

NewDeleteCircuitUnauthorized creates a DeleteCircuitUnauthorized with default headers values

func (*DeleteCircuitUnauthorized) Error 

func (o *DeleteCircuitUnauthorized) Error() string

func (*DeleteCircuitUnauthorized) GetPayload 

func (o *DeleteCircuitUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

type DetailCircuitNotFound 

type DetailCircuitNotFound struct {
	Payload *rest_model.APIErrorEnvelope
}
DetailCircuitNotFound describes a response with status code 404, with default header values.

The requested resource does not exist

func NewDetailCircuitNotFound 

func NewDetailCircuitNotFound() *DetailCircuitNotFound

NewDetailCircuitNotFound creates a DetailCircuitNotFound with default headers values

func (*DetailCircuitNotFound) Error 

func (o *DetailCircuitNotFound) Error() string

func (*DetailCircuitNotFound) GetPayload 

func (o *DetailCircuitNotFound) GetPayload() *rest_model.APIErrorEnvelope

type DetailCircuitOK 

type DetailCircuitOK struct {
	Payload *rest_model.DetailCircuitEnvelope
}
DetailCircuitOK describes a response with status code 200, with default header values.

A single circuit

func NewDetailCircuitOK 

func NewDetailCircuitOK() *DetailCircuitOK

NewDetailCircuitOK creates a DetailCircuitOK with default headers values

func (*DetailCircuitOK) Error 

func (o *DetailCircuitOK) Error() string

func (*DetailCircuitOK) GetPayload 

func (o *DetailCircuitOK) GetPayload() *rest_model.DetailCircuitEnvelope

type DetailCircuitParams 

type DetailCircuitParams struct {

	/* ID.

	   The id of the requested resource
	*/
	ID string

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

DetailCircuitParams contains all the parameters to send to the API endpoint 

for the detail circuit operation.

Typically these are written to a http.Request.

func NewDetailCircuitParams 

func NewDetailCircuitParams() *DetailCircuitParams

NewDetailCircuitParams creates a new DetailCircuitParams 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 NewDetailCircuitParamsWithContext 

func NewDetailCircuitParamsWithContext(ctx context.Context) *DetailCircuitParams

NewDetailCircuitParamsWithContext creates a new DetailCircuitParams object with the ability to set a context for a request.

func NewDetailCircuitParamsWithHTTPClient 

func NewDetailCircuitParamsWithHTTPClient(client *http.Client) *DetailCircuitParams

NewDetailCircuitParamsWithHTTPClient creates a new DetailCircuitParams object with the ability to set a custom HTTPClient for a request.

func NewDetailCircuitParamsWithTimeout 

func NewDetailCircuitParamsWithTimeout(timeout time.Duration) *DetailCircuitParams

NewDetailCircuitParamsWithTimeout creates a new DetailCircuitParams object with the ability to set a timeout on a request.

func (*DetailCircuitParams) SetContext 

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

SetContext adds the context to the detail circuit params

func (*DetailCircuitParams) SetDefaults 

func (o *DetailCircuitParams) SetDefaults()

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

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

func (*DetailCircuitParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the detail circuit params

func (*DetailCircuitParams) SetID 

func (o *DetailCircuitParams) SetID(id string)

SetID adds the id to the detail circuit params

func (*DetailCircuitParams) SetTimeout 

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

SetTimeout adds the timeout to the detail circuit params

func (*DetailCircuitParams) WithContext 

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

WithContext adds the context to the detail circuit params

func (*DetailCircuitParams) WithDefaults 

func (o *DetailCircuitParams) WithDefaults() *DetailCircuitParams

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

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

func (*DetailCircuitParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the detail circuit params

func (*DetailCircuitParams) WithID 

func (o *DetailCircuitParams) WithID(id string) *DetailCircuitParams

WithID adds the id to the detail circuit params

func (*DetailCircuitParams) WithTimeout 

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

WithTimeout adds the timeout to the detail circuit params

func (*DetailCircuitParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DetailCircuitReader 

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

DetailCircuitReader is a Reader for the DetailCircuit structure.

func (*DetailCircuitReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DetailCircuitTooManyRequests added in v0.31.0 

type DetailCircuitTooManyRequests struct {
	Payload *rest_model.APIErrorEnvelope
}
DetailCircuitTooManyRequests describes a response with status code 429, with default header values.

The resource requested is rate limited and the rate limit has been exceeded

func NewDetailCircuitTooManyRequests added in v0.31.0 

func NewDetailCircuitTooManyRequests() *DetailCircuitTooManyRequests

NewDetailCircuitTooManyRequests creates a DetailCircuitTooManyRequests with default headers values

func (*DetailCircuitTooManyRequests) Error added in v0.31.0 

func (o *DetailCircuitTooManyRequests) Error() string

func (*DetailCircuitTooManyRequests) GetPayload added in v0.31.0 

func (o *DetailCircuitTooManyRequests) GetPayload() *rest_model.APIErrorEnvelope

type DetailCircuitUnauthorized 

type DetailCircuitUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}
DetailCircuitUnauthorized describes a response with status code 401, with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewDetailCircuitUnauthorized 

func NewDetailCircuitUnauthorized() *DetailCircuitUnauthorized

NewDetailCircuitUnauthorized creates a DetailCircuitUnauthorized with default headers values

func (*DetailCircuitUnauthorized) Error 

func (o *DetailCircuitUnauthorized) Error() string

func (*DetailCircuitUnauthorized) GetPayload 

func (o *DetailCircuitUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

type ListCircuitsOK 

type ListCircuitsOK struct {
	Payload *rest_model.ListCircuitsEnvelope
}
ListCircuitsOK describes a response with status code 200, with default header values.

A list of circuits

func NewListCircuitsOK 

func NewListCircuitsOK() *ListCircuitsOK

NewListCircuitsOK creates a ListCircuitsOK with default headers values

func (*ListCircuitsOK) Error 

func (o *ListCircuitsOK) Error() string

func (*ListCircuitsOK) GetPayload 

func (o *ListCircuitsOK) GetPayload() *rest_model.ListCircuitsEnvelope

type ListCircuitsParams 

type ListCircuitsParams struct {

	// Filter.
	Filter *string

	// Limit.
	Limit *int64

	// Offset.
	Offset *int64

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

ListCircuitsParams contains all the parameters to send to the API endpoint 

for the list circuits operation.

Typically these are written to a http.Request.

func NewListCircuitsParams 

func NewListCircuitsParams() *ListCircuitsParams

NewListCircuitsParams creates a new ListCircuitsParams 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 NewListCircuitsParamsWithContext 

func NewListCircuitsParamsWithContext(ctx context.Context) *ListCircuitsParams

NewListCircuitsParamsWithContext creates a new ListCircuitsParams object with the ability to set a context for a request.

func NewListCircuitsParamsWithHTTPClient 

func NewListCircuitsParamsWithHTTPClient(client *http.Client) *ListCircuitsParams

NewListCircuitsParamsWithHTTPClient creates a new ListCircuitsParams object with the ability to set a custom HTTPClient for a request.

func NewListCircuitsParamsWithTimeout 

func NewListCircuitsParamsWithTimeout(timeout time.Duration) *ListCircuitsParams

NewListCircuitsParamsWithTimeout creates a new ListCircuitsParams object with the ability to set a timeout on a request.

func (*ListCircuitsParams) SetContext 

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

SetContext adds the context to the list circuits params

func (*ListCircuitsParams) SetDefaults 

func (o *ListCircuitsParams) SetDefaults()

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

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

func (*ListCircuitsParams) SetFilter added in v0.31.1 

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

SetFilter adds the filter to the list circuits params

func (*ListCircuitsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the list circuits params

func (*ListCircuitsParams) SetLimit added in v0.31.1 

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

SetLimit adds the limit to the list circuits params

func (*ListCircuitsParams) SetOffset added in v0.31.1 

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

SetOffset adds the offset to the list circuits params

func (*ListCircuitsParams) SetTimeout 

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

SetTimeout adds the timeout to the list circuits params

func (*ListCircuitsParams) WithContext 

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

WithContext adds the context to the list circuits params

func (*ListCircuitsParams) WithDefaults 

func (o *ListCircuitsParams) WithDefaults() *ListCircuitsParams

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

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

func (*ListCircuitsParams) WithFilter added in v0.31.1 

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

WithFilter adds the filter to the list circuits params

func (*ListCircuitsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the list circuits params

func (*ListCircuitsParams) WithLimit added in v0.31.1 

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

WithLimit adds the limit to the list circuits params

func (*ListCircuitsParams) WithOffset added in v0.31.1 

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

WithOffset adds the offset to the list circuits params

func (*ListCircuitsParams) WithTimeout 

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

WithTimeout adds the timeout to the list circuits params

func (*ListCircuitsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ListCircuitsReader 

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

ListCircuitsReader is a Reader for the ListCircuits structure.

func (*ListCircuitsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ListCircuitsTooManyRequests added in v0.31.0 

type ListCircuitsTooManyRequests struct {
	Payload *rest_model.APIErrorEnvelope
}
ListCircuitsTooManyRequests describes a response with status code 429, with default header values.

The resource requested is rate limited and the rate limit has been exceeded

func NewListCircuitsTooManyRequests added in v0.31.0 

func NewListCircuitsTooManyRequests() *ListCircuitsTooManyRequests

NewListCircuitsTooManyRequests creates a ListCircuitsTooManyRequests with default headers values

func (*ListCircuitsTooManyRequests) Error added in v0.31.0 

func (o *ListCircuitsTooManyRequests) Error() string

func (*ListCircuitsTooManyRequests) GetPayload added in v0.31.0 

func (o *ListCircuitsTooManyRequests) GetPayload() *rest_model.APIErrorEnvelope

type ListCircuitsUnauthorized 

type ListCircuitsUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}
ListCircuitsUnauthorized describes a response with status code 401, with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewListCircuitsUnauthorized 

func NewListCircuitsUnauthorized() *ListCircuitsUnauthorized

NewListCircuitsUnauthorized creates a ListCircuitsUnauthorized with default headers values

func (*ListCircuitsUnauthorized) Error 

func (o *ListCircuitsUnauthorized) Error() string

func (*ListCircuitsUnauthorized) GetPayload 

func (o *ListCircuitsUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

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.