bgp

package
v1.20.0 Latest Latest
Warning

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

 Go to latest Published: Jul 29, 2026 License: Apache-2.0 Imports: 13 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 bgp API.

func (*Client) GetBgpPeers 

func (a *Client) GetBgpPeers(params *GetBgpPeersParams, opts ...ClientOption) (*GetBgpPeersOK, error)
GetBgpPeerslists operational state of b g p peers.

Retrieves current operational state of BGP peers created by

Cilium BGP virtual router. This includes session state, uptime, information per address family, etc. Deprecated: This will be removed in the future. . 

This method does not support injected context.
However, timeout and opentracing contexts are honored whenever enabled.

If you need to pass a specific context, use [Client.GetBgpPeersContext] instead.

func (*Client) GetBgpPeersContext added in v1.20.0 

func (a *Client) GetBgpPeersContext(ctx context.Context, params *GetBgpPeersParams, opts ...ClientOption) (*GetBgpPeersOK, error)
GetBgpPeersContextlists operational state of b g p peers.

Retrieves current operational state of BGP peers created by

Cilium BGP virtual router. This includes session state, uptime, information per address family, etc. Deprecated: This will be removed in the future. . 

Do not use the deprecated [GetBgpPeersParams.Context] with this method: it would be ignored.

func (*Client) GetBgpRoutePolicies deprecated added in v1.15.0 

func (a *Client) GetBgpRoutePolicies(params *GetBgpRoutePoliciesParams, opts ...ClientOption) (*GetBgpRoutePoliciesOK, error)
GetBgpRoutePolicieslists b g p route policies configured in b g p control plane.

Retrieves route policies from BGP Control Plane.

Deprecated: This will be removed in the future. . 

This method does not support injected context.
However, timeout and opentracing contexts are honored whenever enabled.

If you need to pass a specific context, use [Client.GetBgpRoutePoliciesContext] instead.

func (*Client) GetBgpRoutePoliciesContext deprecated added in v1.20.0 

func (a *Client) GetBgpRoutePoliciesContext(ctx context.Context, params *GetBgpRoutePoliciesParams, opts ...ClientOption) (*GetBgpRoutePoliciesOK, error)
GetBgpRoutePoliciesContextlists b g p route policies configured in b g p control plane.

Retrieves route policies from BGP Control Plane.

Deprecated: This will be removed in the future. . 

Do not use the deprecated [GetBgpRoutePoliciesParams.Context] with this method: it would be ignored.

func (*Client) GetBgpRoutes deprecated 

func (a *Client) GetBgpRoutes(params *GetBgpRoutesParams, opts ...ClientOption) (*GetBgpRoutesOK, error)
GetBgpRouteslists b g p routes from b g p control plane r i b.

Retrieves routes from BGP Control Plane RIB filtered by parameters you specify.

Deprecated: This will be removed in the future. . 

This method does not support injected context.
However, timeout and opentracing contexts are honored whenever enabled.

If you need to pass a specific context, use [Client.GetBgpRoutesContext] instead.

func (*Client) GetBgpRoutesContext deprecated added in v1.20.0 

func (a *Client) GetBgpRoutesContext(ctx context.Context, params *GetBgpRoutesParams, opts ...ClientOption) (*GetBgpRoutesOK, error)
GetBgpRoutesContextlists b g p routes from b g p control plane r i b.

Retrieves routes from BGP Control Plane RIB filtered by parameters you specify.

Deprecated: This will be removed in the future. . 

Do not use the deprecated [GetBgpRoutesParams.Context] with this method: it would be ignored.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService 

type ClientService interface {

	// GetBgpPeers lists operational state of b g p peers.
	GetBgpPeers(params *GetBgpPeersParams, opts ...ClientOption) (*GetBgpPeersOK, error)

	// GetBgpPeersContext lists operational state of b g p peers.
	GetBgpPeersContext(ctx context.Context, params *GetBgpPeersParams, opts ...ClientOption) (*GetBgpPeersOK, error)

	// GetBgpRoutePolicies lists b g p route policies configured in b g p control plane.
	GetBgpRoutePolicies(params *GetBgpRoutePoliciesParams, opts ...ClientOption) (*GetBgpRoutePoliciesOK, error)

	// GetBgpRoutePoliciesContext lists b g p route policies configured in b g p control plane.
	GetBgpRoutePoliciesContext(ctx context.Context, params *GetBgpRoutePoliciesParams, opts ...ClientOption) (*GetBgpRoutePoliciesOK, error)

	// GetBgpRoutes lists b g p routes from b g p control plane r i b.
	GetBgpRoutes(params *GetBgpRoutesParams, opts ...ClientOption) (*GetBgpRoutesOK, error)

	// GetBgpRoutesContext lists b g p routes from b g p control plane r i b.
	GetBgpRoutesContext(ctx context.Context, params *GetBgpRoutesParams, opts ...ClientOption) (*GetBgpRoutesOK, error)

	SetTransport(transport runtime.ContextualTransport)
}

ClientService is the interface for Client methods.

func New 

func New(transport runtime.ContextualTransport, formats strfmt.Registry) ClientService

New creates a new bgp API client.

func NewClientWithBasicAuth added in v1.16.5 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new bgp API client with basic auth credentials.

It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken added in v1.16.5 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new bgp API client with a bearer token for authentication.

It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type GetBgpPeersDisabled 

type GetBgpPeersDisabled struct {
	Payload models.Error
}

GetBgpPeersDisabled describes a response with status code 501, with default header values.

BGP Control Plane disabled

func NewGetBgpPeersDisabled 

func NewGetBgpPeersDisabled() *GetBgpPeersDisabled

NewGetBgpPeersDisabled creates a GetBgpPeersDisabled with default headers values

func (*GetBgpPeersDisabled) Code added in v1.16.0 

func (o *GetBgpPeersDisabled) Code() int

Code gets the status code for the get bgp peers disabled response

func (*GetBgpPeersDisabled) Error 

func (o *GetBgpPeersDisabled) Error() string

func (*GetBgpPeersDisabled) GetPayload 

func (o *GetBgpPeersDisabled) GetPayload() models.Error

func (*GetBgpPeersDisabled) IsClientError 

func (o *GetBgpPeersDisabled) IsClientError() bool

IsClientError returns true when this get bgp peers disabled response has a 4xx status code

func (*GetBgpPeersDisabled) IsCode 

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

IsCode returns true when this get bgp peers disabled response a status code equal to that given

func (*GetBgpPeersDisabled) IsRedirect 

func (o *GetBgpPeersDisabled) IsRedirect() bool

IsRedirect returns true when this get bgp peers disabled response has a 3xx status code

func (*GetBgpPeersDisabled) IsServerError 

func (o *GetBgpPeersDisabled) IsServerError() bool

IsServerError returns true when this get bgp peers disabled response has a 5xx status code

func (*GetBgpPeersDisabled) IsSuccess 

func (o *GetBgpPeersDisabled) IsSuccess() bool

IsSuccess returns true when this get bgp peers disabled response has a 2xx status code

func (*GetBgpPeersDisabled) String 

func (o *GetBgpPeersDisabled) String() string

type GetBgpPeersInternalServerError 

type GetBgpPeersInternalServerError struct {
	Payload models.Error
}

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

Internal Server Error

func NewGetBgpPeersInternalServerError 

func NewGetBgpPeersInternalServerError() *GetBgpPeersInternalServerError

NewGetBgpPeersInternalServerError creates a GetBgpPeersInternalServerError with default headers values

func (*GetBgpPeersInternalServerError) Code added in v1.16.0 

func (o *GetBgpPeersInternalServerError) Code() int

Code gets the status code for the get bgp peers internal server error response

func (*GetBgpPeersInternalServerError) Error 

func (o *GetBgpPeersInternalServerError) Error() string

func (*GetBgpPeersInternalServerError) GetPayload 

func (o *GetBgpPeersInternalServerError) GetPayload() models.Error

func (*GetBgpPeersInternalServerError) IsClientError 

func (o *GetBgpPeersInternalServerError) IsClientError() bool

IsClientError returns true when this get bgp peers internal server error response has a 4xx status code

func (*GetBgpPeersInternalServerError) IsCode 

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

IsCode returns true when this get bgp peers internal server error response a status code equal to that given

func (*GetBgpPeersInternalServerError) IsRedirect 

func (o *GetBgpPeersInternalServerError) IsRedirect() bool

IsRedirect returns true when this get bgp peers internal server error response has a 3xx status code

func (*GetBgpPeersInternalServerError) IsServerError 

func (o *GetBgpPeersInternalServerError) IsServerError() bool

IsServerError returns true when this get bgp peers internal server error response has a 5xx status code

func (*GetBgpPeersInternalServerError) IsSuccess 

func (o *GetBgpPeersInternalServerError) IsSuccess() bool

IsSuccess returns true when this get bgp peers internal server error response has a 2xx status code

func (*GetBgpPeersInternalServerError) String 

func (o *GetBgpPeersInternalServerError) String() string

type GetBgpPeersOK 

type GetBgpPeersOK struct {
	Payload []*models.BgpPeer
}

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

Success

func NewGetBgpPeersOK 

func NewGetBgpPeersOK() *GetBgpPeersOK

NewGetBgpPeersOK creates a GetBgpPeersOK with default headers values

func (*GetBgpPeersOK) Code added in v1.16.0 

func (o *GetBgpPeersOK) Code() int

Code gets the status code for the get bgp peers o k response

func (*GetBgpPeersOK) Error 

func (o *GetBgpPeersOK) Error() string

func (*GetBgpPeersOK) GetPayload 

func (o *GetBgpPeersOK) GetPayload() []*models.BgpPeer

func (*GetBgpPeersOK) IsClientError 

func (o *GetBgpPeersOK) IsClientError() bool

IsClientError returns true when this get bgp peers o k response has a 4xx status code

func (*GetBgpPeersOK) IsCode 

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

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

func (*GetBgpPeersOK) IsRedirect 

func (o *GetBgpPeersOK) IsRedirect() bool

IsRedirect returns true when this get bgp peers o k response has a 3xx status code

func (*GetBgpPeersOK) IsServerError 

func (o *GetBgpPeersOK) IsServerError() bool

IsServerError returns true when this get bgp peers o k response has a 5xx status code

func (*GetBgpPeersOK) IsSuccess 

func (o *GetBgpPeersOK) IsSuccess() bool

IsSuccess returns true when this get bgp peers o k response has a 2xx status code

func (*GetBgpPeersOK) String 

func (o *GetBgpPeersOK) String() string

type GetBgpPeersParams 

type GetBgpPeersParams struct {
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetBgpPeersParams contains all the parameters to send to the API endpoint 

for the get bgp peers operation.

Typically these are written to a http.Request.

func NewGetBgpPeersParams 

func NewGetBgpPeersParams() *GetBgpPeersParams

NewGetBgpPeersParams creates a new GetBgpPeersParams 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 NewGetBgpPeersParamsWithContext deprecated 

func NewGetBgpPeersParamsWithContext(ctx context.Context) *GetBgpPeersParams

NewGetBgpPeersParamsWithContext creates a new GetBgpPeersParams object with the ability to set a context for a request.

Deprecated: use the operation call with context to pass the context instead of GetBgpPeersParams.

func NewGetBgpPeersParamsWithHTTPClient 

func NewGetBgpPeersParamsWithHTTPClient(client *http.Client) *GetBgpPeersParams

NewGetBgpPeersParamsWithHTTPClient creates a new GetBgpPeersParams object with the ability to set a custom HTTPClient for a request.

func NewGetBgpPeersParamsWithTimeout 

func NewGetBgpPeersParamsWithTimeout(timeout time.Duration) *GetBgpPeersParams

NewGetBgpPeersParamsWithTimeout creates a new GetBgpPeersParams object with the ability to set a timeout on a request.

func (*GetBgpPeersParams) SetContext deprecated 

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

SetContext adds the context to the get bgp peers params.

Deprecated: use the operation call with context to pass the context instead of GetBgpPeersParams.

func (*GetBgpPeersParams) SetDefaults 

func (o *GetBgpPeersParams) SetDefaults()

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

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

func (*GetBgpPeersParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get bgp peers params.

func (*GetBgpPeersParams) SetTimeout 

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

SetTimeout adds the timeout to the get bgp peers params.

func (*GetBgpPeersParams) WithContext deprecated 

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

WithContext adds the context to the get bgp peers params.

Deprecated: use the operation call with context to pass the context instead of GetBgpPeersParams.

func (*GetBgpPeersParams) WithDefaults 

func (o *GetBgpPeersParams) WithDefaults() *GetBgpPeersParams

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

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

func (*GetBgpPeersParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get bgp peers params.

func (*GetBgpPeersParams) WithTimeout 

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

WithTimeout adds the timeout to the get bgp peers params.

func (*GetBgpPeersParams) WriteToRequest 

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

WriteToRequest writes these params to a runtime.ClientRequest.

type GetBgpPeersReader 

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

GetBgpPeersReader is a Reader for the GetBgpPeers structure.

func (*GetBgpPeersReader) ReadResponse 

func (o *GetBgpPeersReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

type GetBgpRoutePoliciesDisabled added in v1.15.0 

type GetBgpRoutePoliciesDisabled struct {
	Payload models.Error
}

GetBgpRoutePoliciesDisabled describes a response with status code 501, with default header values.

BGP Control Plane disabled

func NewGetBgpRoutePoliciesDisabled added in v1.15.0 

func NewGetBgpRoutePoliciesDisabled() *GetBgpRoutePoliciesDisabled

NewGetBgpRoutePoliciesDisabled creates a GetBgpRoutePoliciesDisabled with default headers values

func (*GetBgpRoutePoliciesDisabled) Code added in v1.16.0 

func (o *GetBgpRoutePoliciesDisabled) Code() int

Code gets the status code for the get bgp route policies disabled response

func (*GetBgpRoutePoliciesDisabled) Error added in v1.15.0 

func (o *GetBgpRoutePoliciesDisabled) Error() string

func (*GetBgpRoutePoliciesDisabled) GetPayload added in v1.15.0 

func (o *GetBgpRoutePoliciesDisabled) GetPayload() models.Error

func (*GetBgpRoutePoliciesDisabled) IsClientError added in v1.15.0 

func (o *GetBgpRoutePoliciesDisabled) IsClientError() bool

IsClientError returns true when this get bgp route policies disabled response has a 4xx status code

func (*GetBgpRoutePoliciesDisabled) IsCode added in v1.15.0 

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

IsCode returns true when this get bgp route policies disabled response a status code equal to that given

func (*GetBgpRoutePoliciesDisabled) IsRedirect added in v1.15.0 

func (o *GetBgpRoutePoliciesDisabled) IsRedirect() bool

IsRedirect returns true when this get bgp route policies disabled response has a 3xx status code

func (*GetBgpRoutePoliciesDisabled) IsServerError added in v1.15.0 

func (o *GetBgpRoutePoliciesDisabled) IsServerError() bool

IsServerError returns true when this get bgp route policies disabled response has a 5xx status code

func (*GetBgpRoutePoliciesDisabled) IsSuccess added in v1.15.0 

func (o *GetBgpRoutePoliciesDisabled) IsSuccess() bool

IsSuccess returns true when this get bgp route policies disabled response has a 2xx status code

func (*GetBgpRoutePoliciesDisabled) String added in v1.15.0 

func (o *GetBgpRoutePoliciesDisabled) String() string

type GetBgpRoutePoliciesInternalServerError added in v1.15.0 

type GetBgpRoutePoliciesInternalServerError struct {
	Payload models.Error
}

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

Internal Server Error

func NewGetBgpRoutePoliciesInternalServerError added in v1.15.0 

func NewGetBgpRoutePoliciesInternalServerError() *GetBgpRoutePoliciesInternalServerError

NewGetBgpRoutePoliciesInternalServerError creates a GetBgpRoutePoliciesInternalServerError with default headers values

func (*GetBgpRoutePoliciesInternalServerError) Code added in v1.16.0 

func (o *GetBgpRoutePoliciesInternalServerError) Code() int

Code gets the status code for the get bgp route policies internal server error response

func (*GetBgpRoutePoliciesInternalServerError) Error added in v1.15.0 

func (o *GetBgpRoutePoliciesInternalServerError) Error() string

func (*GetBgpRoutePoliciesInternalServerError) GetPayload added in v1.15.0 

func (o *GetBgpRoutePoliciesInternalServerError) GetPayload() models.Error

func (*GetBgpRoutePoliciesInternalServerError) IsClientError added in v1.15.0 

func (o *GetBgpRoutePoliciesInternalServerError) IsClientError() bool

IsClientError returns true when this get bgp route policies internal server error response has a 4xx status code

func (*GetBgpRoutePoliciesInternalServerError) IsCode added in v1.15.0 

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

IsCode returns true when this get bgp route policies internal server error response a status code equal to that given

func (*GetBgpRoutePoliciesInternalServerError) IsRedirect added in v1.15.0 

func (o *GetBgpRoutePoliciesInternalServerError) IsRedirect() bool

IsRedirect returns true when this get bgp route policies internal server error response has a 3xx status code

func (*GetBgpRoutePoliciesInternalServerError) IsServerError added in v1.15.0 

func (o *GetBgpRoutePoliciesInternalServerError) IsServerError() bool

IsServerError returns true when this get bgp route policies internal server error response has a 5xx status code

func (*GetBgpRoutePoliciesInternalServerError) IsSuccess added in v1.15.0 

func (o *GetBgpRoutePoliciesInternalServerError) IsSuccess() bool

IsSuccess returns true when this get bgp route policies internal server error response has a 2xx status code

func (*GetBgpRoutePoliciesInternalServerError) String added in v1.15.0 

func (o *GetBgpRoutePoliciesInternalServerError) String() string

type GetBgpRoutePoliciesOK added in v1.15.0 

type GetBgpRoutePoliciesOK struct {
	Payload []*models.BgpRoutePolicy
}

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

Success

func NewGetBgpRoutePoliciesOK added in v1.15.0 

func NewGetBgpRoutePoliciesOK() *GetBgpRoutePoliciesOK

NewGetBgpRoutePoliciesOK creates a GetBgpRoutePoliciesOK with default headers values

func (*GetBgpRoutePoliciesOK) Code added in v1.16.0 

func (o *GetBgpRoutePoliciesOK) Code() int

Code gets the status code for the get bgp route policies o k response

func (*GetBgpRoutePoliciesOK) Error added in v1.15.0 

func (o *GetBgpRoutePoliciesOK) Error() string

func (*GetBgpRoutePoliciesOK) GetPayload added in v1.15.0 

func (o *GetBgpRoutePoliciesOK) GetPayload() []*models.BgpRoutePolicy

func (*GetBgpRoutePoliciesOK) IsClientError added in v1.15.0 

func (o *GetBgpRoutePoliciesOK) IsClientError() bool

IsClientError returns true when this get bgp route policies o k response has a 4xx status code

func (*GetBgpRoutePoliciesOK) IsCode added in v1.15.0 

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

IsCode returns true when this get bgp route policies o k response a status code equal to that given

func (*GetBgpRoutePoliciesOK) IsRedirect added in v1.15.0 

func (o *GetBgpRoutePoliciesOK) IsRedirect() bool

IsRedirect returns true when this get bgp route policies o k response has a 3xx status code

func (*GetBgpRoutePoliciesOK) IsServerError added in v1.15.0 

func (o *GetBgpRoutePoliciesOK) IsServerError() bool

IsServerError returns true when this get bgp route policies o k response has a 5xx status code

func (*GetBgpRoutePoliciesOK) IsSuccess added in v1.15.0 

func (o *GetBgpRoutePoliciesOK) IsSuccess() bool

IsSuccess returns true when this get bgp route policies o k response has a 2xx status code

func (*GetBgpRoutePoliciesOK) String added in v1.15.0 

func (o *GetBgpRoutePoliciesOK) String() string

type GetBgpRoutePoliciesParams added in v1.15.0 

type GetBgpRoutePoliciesParams struct {

	/* RouterAsn.

	     Autonomous System Number (ASN) identifying a BGP virtual router instance.
	If not specified, all virtual router instances are selected.

	*/
	RouterAsn *int64

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

GetBgpRoutePoliciesParams contains all the parameters to send to the API endpoint 

for the get bgp route policies operation.

Typically these are written to a http.Request.

func NewGetBgpRoutePoliciesParams added in v1.15.0 

func NewGetBgpRoutePoliciesParams() *GetBgpRoutePoliciesParams

NewGetBgpRoutePoliciesParams creates a new GetBgpRoutePoliciesParams 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 NewGetBgpRoutePoliciesParamsWithContext deprecated added in v1.15.0 

func NewGetBgpRoutePoliciesParamsWithContext(ctx context.Context) *GetBgpRoutePoliciesParams

NewGetBgpRoutePoliciesParamsWithContext creates a new GetBgpRoutePoliciesParams object with the ability to set a context for a request.

Deprecated: use the operation call with context to pass the context instead of GetBgpRoutePoliciesParams.

func NewGetBgpRoutePoliciesParamsWithHTTPClient added in v1.15.0 

func NewGetBgpRoutePoliciesParamsWithHTTPClient(client *http.Client) *GetBgpRoutePoliciesParams

NewGetBgpRoutePoliciesParamsWithHTTPClient creates a new GetBgpRoutePoliciesParams object with the ability to set a custom HTTPClient for a request.

func NewGetBgpRoutePoliciesParamsWithTimeout added in v1.15.0 

func NewGetBgpRoutePoliciesParamsWithTimeout(timeout time.Duration) *GetBgpRoutePoliciesParams

NewGetBgpRoutePoliciesParamsWithTimeout creates a new GetBgpRoutePoliciesParams object with the ability to set a timeout on a request.

func (*GetBgpRoutePoliciesParams) SetContext deprecated added in v1.15.0 

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

SetContext adds the context to the get bgp route policies params.

Deprecated: use the operation call with context to pass the context instead of GetBgpRoutePoliciesParams.

func (*GetBgpRoutePoliciesParams) SetDefaults added in v1.15.0 

func (o *GetBgpRoutePoliciesParams) SetDefaults()

SetDefaults hydrates default values in the get bgp route policies params (not the query body).

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

func (*GetBgpRoutePoliciesParams) SetHTTPClient added in v1.15.0 

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

SetHTTPClient adds the HTTPClient to the get bgp route policies params.

func (*GetBgpRoutePoliciesParams) SetRouterAsn added in v1.15.0 

func (o *GetBgpRoutePoliciesParams) SetRouterAsn(routerAsn *int64)

SetRouterAsn adds the routerAsn to the get bgp route policies params.

func (*GetBgpRoutePoliciesParams) SetTimeout added in v1.15.0 

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

SetTimeout adds the timeout to the get bgp route policies params.

func (*GetBgpRoutePoliciesParams) WithContext deprecated added in v1.15.0 

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

WithContext adds the context to the get bgp route policies params.

Deprecated: use the operation call with context to pass the context instead of GetBgpRoutePoliciesParams.

func (*GetBgpRoutePoliciesParams) WithDefaults added in v1.15.0 

func (o *GetBgpRoutePoliciesParams) WithDefaults() *GetBgpRoutePoliciesParams

WithDefaults hydrates default values in the get bgp route policies params (not the query body).

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

func (*GetBgpRoutePoliciesParams) WithHTTPClient added in v1.15.0 

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

WithHTTPClient adds the HTTPClient to the get bgp route policies params.

func (*GetBgpRoutePoliciesParams) WithRouterAsn added in v1.15.0 

func (o *GetBgpRoutePoliciesParams) WithRouterAsn(routerAsn *int64) *GetBgpRoutePoliciesParams

WithRouterAsn adds the routerAsn to the get bgp route policies params.

func (*GetBgpRoutePoliciesParams) WithTimeout added in v1.15.0 

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

WithTimeout adds the timeout to the get bgp route policies params.

func (*GetBgpRoutePoliciesParams) WriteToRequest added in v1.15.0 

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

WriteToRequest writes these params to a runtime.ClientRequest.

type GetBgpRoutePoliciesReader added in v1.15.0 

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

GetBgpRoutePoliciesReader is a Reader for the GetBgpRoutePolicies structure.

func (*GetBgpRoutePoliciesReader) ReadResponse added in v1.15.0 

func (o *GetBgpRoutePoliciesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

type GetBgpRoutesDisabled 

type GetBgpRoutesDisabled struct {
	Payload models.Error
}

GetBgpRoutesDisabled describes a response with status code 501, with default header values.

BGP Control Plane disabled

func NewGetBgpRoutesDisabled 

func NewGetBgpRoutesDisabled() *GetBgpRoutesDisabled

NewGetBgpRoutesDisabled creates a GetBgpRoutesDisabled with default headers values

func (*GetBgpRoutesDisabled) Code added in v1.16.0 

func (o *GetBgpRoutesDisabled) Code() int

Code gets the status code for the get bgp routes disabled response

func (*GetBgpRoutesDisabled) Error 

func (o *GetBgpRoutesDisabled) Error() string

func (*GetBgpRoutesDisabled) GetPayload 

func (o *GetBgpRoutesDisabled) GetPayload() models.Error

func (*GetBgpRoutesDisabled) IsClientError 

func (o *GetBgpRoutesDisabled) IsClientError() bool

IsClientError returns true when this get bgp routes disabled response has a 4xx status code

func (*GetBgpRoutesDisabled) IsCode 

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

IsCode returns true when this get bgp routes disabled response a status code equal to that given

func (*GetBgpRoutesDisabled) IsRedirect 

func (o *GetBgpRoutesDisabled) IsRedirect() bool

IsRedirect returns true when this get bgp routes disabled response has a 3xx status code

func (*GetBgpRoutesDisabled) IsServerError 

func (o *GetBgpRoutesDisabled) IsServerError() bool

IsServerError returns true when this get bgp routes disabled response has a 5xx status code

func (*GetBgpRoutesDisabled) IsSuccess 

func (o *GetBgpRoutesDisabled) IsSuccess() bool

IsSuccess returns true when this get bgp routes disabled response has a 2xx status code

func (*GetBgpRoutesDisabled) String 

func (o *GetBgpRoutesDisabled) String() string

type GetBgpRoutesInternalServerError 

type GetBgpRoutesInternalServerError struct {
	Payload models.Error
}

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

Internal Server Error

func NewGetBgpRoutesInternalServerError 

func NewGetBgpRoutesInternalServerError() *GetBgpRoutesInternalServerError

NewGetBgpRoutesInternalServerError creates a GetBgpRoutesInternalServerError with default headers values

func (*GetBgpRoutesInternalServerError) Code added in v1.16.0 

func (o *GetBgpRoutesInternalServerError) Code() int

Code gets the status code for the get bgp routes internal server error response

func (*GetBgpRoutesInternalServerError) Error 

func (o *GetBgpRoutesInternalServerError) Error() string

func (*GetBgpRoutesInternalServerError) GetPayload 

func (o *GetBgpRoutesInternalServerError) GetPayload() models.Error

func (*GetBgpRoutesInternalServerError) IsClientError 

func (o *GetBgpRoutesInternalServerError) IsClientError() bool

IsClientError returns true when this get bgp routes internal server error response has a 4xx status code

func (*GetBgpRoutesInternalServerError) IsCode 

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

IsCode returns true when this get bgp routes internal server error response a status code equal to that given

func (*GetBgpRoutesInternalServerError) IsRedirect 

func (o *GetBgpRoutesInternalServerError) IsRedirect() bool

IsRedirect returns true when this get bgp routes internal server error response has a 3xx status code

func (*GetBgpRoutesInternalServerError) IsServerError 

func (o *GetBgpRoutesInternalServerError) IsServerError() bool

IsServerError returns true when this get bgp routes internal server error response has a 5xx status code

func (*GetBgpRoutesInternalServerError) IsSuccess 

func (o *GetBgpRoutesInternalServerError) IsSuccess() bool

IsSuccess returns true when this get bgp routes internal server error response has a 2xx status code

func (*GetBgpRoutesInternalServerError) String 

func (o *GetBgpRoutesInternalServerError) String() string

type GetBgpRoutesOK 

type GetBgpRoutesOK struct {
	Payload []*models.BgpRoute
}

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

Success

func NewGetBgpRoutesOK 

func NewGetBgpRoutesOK() *GetBgpRoutesOK

NewGetBgpRoutesOK creates a GetBgpRoutesOK with default headers values

func (*GetBgpRoutesOK) Code added in v1.16.0 

func (o *GetBgpRoutesOK) Code() int

Code gets the status code for the get bgp routes o k response

func (*GetBgpRoutesOK) Error 

func (o *GetBgpRoutesOK) Error() string

func (*GetBgpRoutesOK) GetPayload 

func (o *GetBgpRoutesOK) GetPayload() []*models.BgpRoute

func (*GetBgpRoutesOK) IsClientError 

func (o *GetBgpRoutesOK) IsClientError() bool

IsClientError returns true when this get bgp routes o k response has a 4xx status code

func (*GetBgpRoutesOK) IsCode 

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

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

func (*GetBgpRoutesOK) IsRedirect 

func (o *GetBgpRoutesOK) IsRedirect() bool

IsRedirect returns true when this get bgp routes o k response has a 3xx status code

func (*GetBgpRoutesOK) IsServerError 

func (o *GetBgpRoutesOK) IsServerError() bool

IsServerError returns true when this get bgp routes o k response has a 5xx status code

func (*GetBgpRoutesOK) IsSuccess 

func (o *GetBgpRoutesOK) IsSuccess() bool

IsSuccess returns true when this get bgp routes o k response has a 2xx status code

func (*GetBgpRoutesOK) String 

func (o *GetBgpRoutesOK) String() string

type GetBgpRoutesParams 

type GetBgpRoutesParams struct {

	/* Afi.

	   Address Family Indicator (AFI) of a BGP route
	*/
	Afi string

	/* Neighbor.

	     IP address specifying a BGP neighbor.
	Has to be specified only when table type is adj-rib-in or adj-rib-out.

	*/
	Neighbor *string

	/* RouterAsn.

	     Autonomous System Number (ASN) identifying a BGP virtual router instance.
	If not specified, all virtual router instances are selected.

	*/
	RouterAsn *int64

	/* Safi.

	   Subsequent Address Family Indicator (SAFI) of a BGP route
	*/
	Safi string

	/* TableType.

	   BGP Routing Information Base (RIB) table type
	*/
	TableType string

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

GetBgpRoutesParams contains all the parameters to send to the API endpoint 

for the get bgp routes operation.

Typically these are written to a http.Request.

func NewGetBgpRoutesParams 

func NewGetBgpRoutesParams() *GetBgpRoutesParams

NewGetBgpRoutesParams creates a new GetBgpRoutesParams 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 NewGetBgpRoutesParamsWithContext deprecated 

func NewGetBgpRoutesParamsWithContext(ctx context.Context) *GetBgpRoutesParams

NewGetBgpRoutesParamsWithContext creates a new GetBgpRoutesParams object with the ability to set a context for a request.

Deprecated: use the operation call with context to pass the context instead of GetBgpRoutesParams.

func NewGetBgpRoutesParamsWithHTTPClient 

func NewGetBgpRoutesParamsWithHTTPClient(client *http.Client) *GetBgpRoutesParams

NewGetBgpRoutesParamsWithHTTPClient creates a new GetBgpRoutesParams object with the ability to set a custom HTTPClient for a request.

func NewGetBgpRoutesParamsWithTimeout 

func NewGetBgpRoutesParamsWithTimeout(timeout time.Duration) *GetBgpRoutesParams

NewGetBgpRoutesParamsWithTimeout creates a new GetBgpRoutesParams object with the ability to set a timeout on a request.

func (*GetBgpRoutesParams) SetAfi 

func (o *GetBgpRoutesParams) SetAfi(afi string)

SetAfi adds the afi to the get bgp routes params.

func (*GetBgpRoutesParams) SetContext deprecated 

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

SetContext adds the context to the get bgp routes params.

Deprecated: use the operation call with context to pass the context instead of GetBgpRoutesParams.

func (*GetBgpRoutesParams) SetDefaults 

func (o *GetBgpRoutesParams) SetDefaults()

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

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

func (*GetBgpRoutesParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get bgp routes params.

func (*GetBgpRoutesParams) SetNeighbor 

func (o *GetBgpRoutesParams) SetNeighbor(neighbor *string)

SetNeighbor adds the neighbor to the get bgp routes params.

func (*GetBgpRoutesParams) SetRouterAsn 

func (o *GetBgpRoutesParams) SetRouterAsn(routerAsn *int64)

SetRouterAsn adds the routerAsn to the get bgp routes params.

func (*GetBgpRoutesParams) SetSafi 

func (o *GetBgpRoutesParams) SetSafi(safi string)

SetSafi adds the safi to the get bgp routes params.

func (*GetBgpRoutesParams) SetTableType 

func (o *GetBgpRoutesParams) SetTableType(tableType string)

SetTableType adds the tableType to the get bgp routes params.

func (*GetBgpRoutesParams) SetTimeout 

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

SetTimeout adds the timeout to the get bgp routes params.

func (*GetBgpRoutesParams) WithAfi 

func (o *GetBgpRoutesParams) WithAfi(afi string) *GetBgpRoutesParams

WithAfi adds the afi to the get bgp routes params.

func (*GetBgpRoutesParams) WithContext deprecated 

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

WithContext adds the context to the get bgp routes params.

Deprecated: use the operation call with context to pass the context instead of GetBgpRoutesParams.

func (*GetBgpRoutesParams) WithDefaults 

func (o *GetBgpRoutesParams) WithDefaults() *GetBgpRoutesParams

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

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

func (*GetBgpRoutesParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get bgp routes params.

func (*GetBgpRoutesParams) WithNeighbor 

func (o *GetBgpRoutesParams) WithNeighbor(neighbor *string) *GetBgpRoutesParams

WithNeighbor adds the neighbor to the get bgp routes params.

func (*GetBgpRoutesParams) WithRouterAsn 

func (o *GetBgpRoutesParams) WithRouterAsn(routerAsn *int64) *GetBgpRoutesParams

WithRouterAsn adds the routerAsn to the get bgp routes params.

func (*GetBgpRoutesParams) WithSafi 

func (o *GetBgpRoutesParams) WithSafi(safi string) *GetBgpRoutesParams

WithSafi adds the safi to the get bgp routes params.

func (*GetBgpRoutesParams) WithTableType 

func (o *GetBgpRoutesParams) WithTableType(tableType string) *GetBgpRoutesParams

WithTableType adds the tableType to the get bgp routes params.

func (*GetBgpRoutesParams) WithTimeout 

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

WithTimeout adds the timeout to the get bgp routes params.

func (*GetBgpRoutesParams) WriteToRequest 

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

WriteToRequest writes these params to a runtime.ClientRequest.

type GetBgpRoutesReader 

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

GetBgpRoutesReader is a Reader for the GetBgpRoutes structure.

func (*GetBgpRoutesReader) ReadResponse 

func (o *GetBgpRoutesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, 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.