ports

package
v0.0.0-...-8fe3866 Latest Latest
Warning

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

Go to latest
Published: Nov 30, 2023 License: Apache-2.0 Imports: 10 Imported by: 2

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

func (*Client) CreatePort

func (a *Client) CreatePort(params *CreatePortParams, opts ...ClientOption) (*CreatePortCreated, error)

CreatePort creates a port

Create a new port-equivalent, e.g. a bonded port.

func (*Client) DeletePort

func (a *Client) DeletePort(params *DeletePortParams, opts ...ClientOption) (*DeletePortNoContent, error)

DeletePort deletes a port

Deletes an existing port equivalent, e.g. a bonded port. Idempotent.

func (*Client) GetPort

func (a *Client) GetPort(params *GetPortParams, opts ...ClientOption) (*GetPortOK, error)

GetPort gets a port

Returns a port, by id.

func (*Client) ListPorts

func (a *Client) ListPorts(params *ListPortsParams, opts ...ClientOption) (*ListPortsOK, error)

ListPorts lists ports

The `ports` endpoint returns all physical ports and port-equivalents that are available for network interfaces.

func (*Client) SetTransport

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

SetTransport changes the transport on the client

func (*Client) UpdatePort

func (a *Client) UpdatePort(params *UpdatePortParams, opts ...ClientOption) (*UpdatePortOK, error)

UpdatePort updates a port

Updates an existing port's configuration. Idempotent.

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	CreatePort(params *CreatePortParams, opts ...ClientOption) (*CreatePortCreated, error)

	DeletePort(params *DeletePortParams, opts ...ClientOption) (*DeletePortNoContent, error)

	GetPort(params *GetPortParams, opts ...ClientOption) (*GetPortOK, error)

	ListPorts(params *ListPortsParams, opts ...ClientOption) (*ListPortsOK, error)

	UpdatePort(params *UpdatePortParams, opts ...ClientOption) (*UpdatePortOK, 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 ports API client.

type CreatePortCreated

type CreatePortCreated struct {
	Payload *models.Port
}
CreatePortCreated describes a response with status code 201, with default header values.

Success

func NewCreatePortCreated

func NewCreatePortCreated() *CreatePortCreated

NewCreatePortCreated creates a CreatePortCreated with default headers values

func (*CreatePortCreated) Error

func (o *CreatePortCreated) Error() string

func (*CreatePortCreated) GetPayload

func (o *CreatePortCreated) GetPayload() *models.Port

type CreatePortParams

type CreatePortParams struct {

	/* Port.

	   New port
	*/
	Port *models.Port

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

CreatePortParams contains all the parameters to send to the API endpoint

for the create port operation.

Typically these are written to a http.Request.

func NewCreatePortParams

func NewCreatePortParams() *CreatePortParams

NewCreatePortParams creates a new CreatePortParams 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 NewCreatePortParamsWithContext

func NewCreatePortParamsWithContext(ctx context.Context) *CreatePortParams

NewCreatePortParamsWithContext creates a new CreatePortParams object with the ability to set a context for a request.

func NewCreatePortParamsWithHTTPClient

func NewCreatePortParamsWithHTTPClient(client *http.Client) *CreatePortParams

NewCreatePortParamsWithHTTPClient creates a new CreatePortParams object with the ability to set a custom HTTPClient for a request.

func NewCreatePortParamsWithTimeout

func NewCreatePortParamsWithTimeout(timeout time.Duration) *CreatePortParams

NewCreatePortParamsWithTimeout creates a new CreatePortParams object with the ability to set a timeout on a request.

func (*CreatePortParams) SetContext

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

SetContext adds the context to the create port params

func (*CreatePortParams) SetDefaults

func (o *CreatePortParams) SetDefaults()

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

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

func (*CreatePortParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the create port params

func (*CreatePortParams) SetPort

func (o *CreatePortParams) SetPort(port *models.Port)

SetPort adds the port to the create port params

func (*CreatePortParams) SetTimeout

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

SetTimeout adds the timeout to the create port params

func (*CreatePortParams) WithContext

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

WithContext adds the context to the create port params

func (*CreatePortParams) WithDefaults

func (o *CreatePortParams) WithDefaults() *CreatePortParams

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

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

func (*CreatePortParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the create port params

func (*CreatePortParams) WithPort

func (o *CreatePortParams) WithPort(port *models.Port) *CreatePortParams

WithPort adds the port to the create port params

func (*CreatePortParams) WithTimeout

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

WithTimeout adds the timeout to the create port params

func (*CreatePortParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type CreatePortReader

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

CreatePortReader is a Reader for the CreatePort structure.

func (*CreatePortReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type DeletePortNoContent

type DeletePortNoContent struct {
}
DeletePortNoContent describes a response with status code 204, with default header values.

No Content

func NewDeletePortNoContent

func NewDeletePortNoContent() *DeletePortNoContent

NewDeletePortNoContent creates a DeletePortNoContent with default headers values

func (*DeletePortNoContent) Error

func (o *DeletePortNoContent) Error() string

type DeletePortParams

type DeletePortParams struct {

	/* ID.

	   Unique resource identifier

	   Format: string
	*/
	ID string

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

DeletePortParams contains all the parameters to send to the API endpoint

for the delete port operation.

Typically these are written to a http.Request.

func NewDeletePortParams

func NewDeletePortParams() *DeletePortParams

NewDeletePortParams creates a new DeletePortParams 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 NewDeletePortParamsWithContext

func NewDeletePortParamsWithContext(ctx context.Context) *DeletePortParams

NewDeletePortParamsWithContext creates a new DeletePortParams object with the ability to set a context for a request.

func NewDeletePortParamsWithHTTPClient

func NewDeletePortParamsWithHTTPClient(client *http.Client) *DeletePortParams

NewDeletePortParamsWithHTTPClient creates a new DeletePortParams object with the ability to set a custom HTTPClient for a request.

func NewDeletePortParamsWithTimeout

func NewDeletePortParamsWithTimeout(timeout time.Duration) *DeletePortParams

NewDeletePortParamsWithTimeout creates a new DeletePortParams object with the ability to set a timeout on a request.

func (*DeletePortParams) SetContext

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

SetContext adds the context to the delete port params

func (*DeletePortParams) SetDefaults

func (o *DeletePortParams) SetDefaults()

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

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

func (*DeletePortParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the delete port params

func (*DeletePortParams) SetID

func (o *DeletePortParams) SetID(id string)

SetID adds the id to the delete port params

func (*DeletePortParams) SetTimeout

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

SetTimeout adds the timeout to the delete port params

func (*DeletePortParams) WithContext

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

WithContext adds the context to the delete port params

func (*DeletePortParams) WithDefaults

func (o *DeletePortParams) WithDefaults() *DeletePortParams

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

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

func (*DeletePortParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the delete port params

func (*DeletePortParams) WithID

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

WithID adds the id to the delete port params

func (*DeletePortParams) WithTimeout

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

WithTimeout adds the timeout to the delete port params

func (*DeletePortParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type DeletePortReader

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

DeletePortReader is a Reader for the DeletePort structure.

func (*DeletePortReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetPortOK

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

Success

func NewGetPortOK

func NewGetPortOK() *GetPortOK

NewGetPortOK creates a GetPortOK with default headers values

func (*GetPortOK) Error

func (o *GetPortOK) Error() string

func (*GetPortOK) GetPayload

func (o *GetPortOK) GetPayload() *models.Port

type GetPortParams

type GetPortParams struct {

	/* ID.

	   Unique resource identifier

	   Format: string
	*/
	ID string

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

GetPortParams contains all the parameters to send to the API endpoint

for the get port operation.

Typically these are written to a http.Request.

func NewGetPortParams

func NewGetPortParams() *GetPortParams

NewGetPortParams creates a new GetPortParams 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 NewGetPortParamsWithContext

func NewGetPortParamsWithContext(ctx context.Context) *GetPortParams

NewGetPortParamsWithContext creates a new GetPortParams object with the ability to set a context for a request.

func NewGetPortParamsWithHTTPClient

func NewGetPortParamsWithHTTPClient(client *http.Client) *GetPortParams

NewGetPortParamsWithHTTPClient creates a new GetPortParams object with the ability to set a custom HTTPClient for a request.

func NewGetPortParamsWithTimeout

func NewGetPortParamsWithTimeout(timeout time.Duration) *GetPortParams

NewGetPortParamsWithTimeout creates a new GetPortParams object with the ability to set a timeout on a request.

func (*GetPortParams) SetContext

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

SetContext adds the context to the get port params

func (*GetPortParams) SetDefaults

func (o *GetPortParams) SetDefaults()

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

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

func (*GetPortParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get port params

func (*GetPortParams) SetID

func (o *GetPortParams) SetID(id string)

SetID adds the id to the get port params

func (*GetPortParams) SetTimeout

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

SetTimeout adds the timeout to the get port params

func (*GetPortParams) WithContext

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

WithContext adds the context to the get port params

func (*GetPortParams) WithDefaults

func (o *GetPortParams) WithDefaults() *GetPortParams

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

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

func (*GetPortParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get port params

func (*GetPortParams) WithID

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

WithID adds the id to the get port params

func (*GetPortParams) WithTimeout

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

WithTimeout adds the timeout to the get port params

func (*GetPortParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetPortReader

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

GetPortReader is a Reader for the GetPort structure.

func (*GetPortReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type ListPortsOK

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

Success

func NewListPortsOK

func NewListPortsOK() *ListPortsOK

NewListPortsOK creates a ListPortsOK with default headers values

func (*ListPortsOK) Error

func (o *ListPortsOK) Error() string

func (*ListPortsOK) GetPayload

func (o *ListPortsOK) GetPayload() []*models.Port

type ListPortsParams

type ListPortsParams struct {

	/* Kind.

	   Filter by kind
	*/
	Kind *string

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

ListPortsParams contains all the parameters to send to the API endpoint

for the list ports operation.

Typically these are written to a http.Request.

func NewListPortsParams

func NewListPortsParams() *ListPortsParams

NewListPortsParams creates a new ListPortsParams 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 NewListPortsParamsWithContext

func NewListPortsParamsWithContext(ctx context.Context) *ListPortsParams

NewListPortsParamsWithContext creates a new ListPortsParams object with the ability to set a context for a request.

func NewListPortsParamsWithHTTPClient

func NewListPortsParamsWithHTTPClient(client *http.Client) *ListPortsParams

NewListPortsParamsWithHTTPClient creates a new ListPortsParams object with the ability to set a custom HTTPClient for a request.

func NewListPortsParamsWithTimeout

func NewListPortsParamsWithTimeout(timeout time.Duration) *ListPortsParams

NewListPortsParamsWithTimeout creates a new ListPortsParams object with the ability to set a timeout on a request.

func (*ListPortsParams) SetContext

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

SetContext adds the context to the list ports params

func (*ListPortsParams) SetDefaults

func (o *ListPortsParams) SetDefaults()

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

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

func (*ListPortsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the list ports params

func (*ListPortsParams) SetKind

func (o *ListPortsParams) SetKind(kind *string)

SetKind adds the kind to the list ports params

func (*ListPortsParams) SetTimeout

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

SetTimeout adds the timeout to the list ports params

func (*ListPortsParams) WithContext

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

WithContext adds the context to the list ports params

func (*ListPortsParams) WithDefaults

func (o *ListPortsParams) WithDefaults() *ListPortsParams

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

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

func (*ListPortsParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the list ports params

func (*ListPortsParams) WithKind

func (o *ListPortsParams) WithKind(kind *string) *ListPortsParams

WithKind adds the kind to the list ports params

func (*ListPortsParams) WithTimeout

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

WithTimeout adds the timeout to the list ports params

func (*ListPortsParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type ListPortsReader

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

ListPortsReader is a Reader for the ListPorts structure.

func (*ListPortsReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type UpdatePortOK

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

Success

func NewUpdatePortOK

func NewUpdatePortOK() *UpdatePortOK

NewUpdatePortOK creates a UpdatePortOK with default headers values

func (*UpdatePortOK) Error

func (o *UpdatePortOK) Error() string

func (*UpdatePortOK) GetPayload

func (o *UpdatePortOK) GetPayload() *models.Port

type UpdatePortParams

type UpdatePortParams struct {

	/* ID.

	   Unique resource identifier

	   Format: string
	*/
	ID string

	/* Port.

	   Updated port
	*/
	Port *models.Port

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

UpdatePortParams contains all the parameters to send to the API endpoint

for the update port operation.

Typically these are written to a http.Request.

func NewUpdatePortParams

func NewUpdatePortParams() *UpdatePortParams

NewUpdatePortParams creates a new UpdatePortParams 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 NewUpdatePortParamsWithContext

func NewUpdatePortParamsWithContext(ctx context.Context) *UpdatePortParams

NewUpdatePortParamsWithContext creates a new UpdatePortParams object with the ability to set a context for a request.

func NewUpdatePortParamsWithHTTPClient

func NewUpdatePortParamsWithHTTPClient(client *http.Client) *UpdatePortParams

NewUpdatePortParamsWithHTTPClient creates a new UpdatePortParams object with the ability to set a custom HTTPClient for a request.

func NewUpdatePortParamsWithTimeout

func NewUpdatePortParamsWithTimeout(timeout time.Duration) *UpdatePortParams

NewUpdatePortParamsWithTimeout creates a new UpdatePortParams object with the ability to set a timeout on a request.

func (*UpdatePortParams) SetContext

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

SetContext adds the context to the update port params

func (*UpdatePortParams) SetDefaults

func (o *UpdatePortParams) SetDefaults()

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

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

func (*UpdatePortParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the update port params

func (*UpdatePortParams) SetID

func (o *UpdatePortParams) SetID(id string)

SetID adds the id to the update port params

func (*UpdatePortParams) SetPort

func (o *UpdatePortParams) SetPort(port *models.Port)

SetPort adds the port to the update port params

func (*UpdatePortParams) SetTimeout

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

SetTimeout adds the timeout to the update port params

func (*UpdatePortParams) WithContext

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

WithContext adds the context to the update port params

func (*UpdatePortParams) WithDefaults

func (o *UpdatePortParams) WithDefaults() *UpdatePortParams

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

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

func (*UpdatePortParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the update port params

func (*UpdatePortParams) WithID

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

WithID adds the id to the update port params

func (*UpdatePortParams) WithPort

func (o *UpdatePortParams) WithPort(port *models.Port) *UpdatePortParams

WithPort adds the port to the update port params

func (*UpdatePortParams) WithTimeout

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

WithTimeout adds the timeout to the update port params

func (*UpdatePortParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type UpdatePortReader

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

UpdatePortReader is a Reader for the UpdatePort structure.

func (*UpdatePortReader) ReadResponse

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

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

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