controllers

package
v0.26.53 Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2026 License: Apache-2.0 Imports: 13 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 controllers API

func (*Client) ListControllers 

func (a *Client) ListControllers(params *ListControllersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListControllersOK, error)

ListControllers lists controllers

Retrieves a list of controllers

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 may be used to customize the behavior of Client methods.

type ClientService 

type ClientService interface {
	ListControllers(params *ListControllersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListControllersOK, 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 controllers API client.

func NewClientWithBasicAuth added in v0.26.53 

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

New creates a new controllers 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 v0.26.53 

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

New creates a new controllers 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 ListControllersBadRequest 

type ListControllersBadRequest struct {

	/* Denotes different type of security token related information
	 */
	WWWAuthenticate []string

	Payload *rest_model.APIErrorEnvelope
}

ListControllersBadRequest 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 NewListControllersBadRequest 

func NewListControllersBadRequest() *ListControllersBadRequest

NewListControllersBadRequest creates a ListControllersBadRequest with default headers values

func (*ListControllersBadRequest) Code added in v0.26.53 

func (o *ListControllersBadRequest) Code() int

Code gets the status code for the list controllers bad request response

func (*ListControllersBadRequest) Error 

func (o *ListControllersBadRequest) Error() string

func (*ListControllersBadRequest) GetPayload 

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

func (*ListControllersBadRequest) IsClientError added in v0.26.53 

func (o *ListControllersBadRequest) IsClientError() bool

IsClientError returns true when this list controllers bad request response has a 4xx status code

func (*ListControllersBadRequest) IsCode added in v0.26.53 

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

IsCode returns true when this list controllers bad request response a status code equal to that given

func (*ListControllersBadRequest) IsRedirect added in v0.26.53 

func (o *ListControllersBadRequest) IsRedirect() bool

IsRedirect returns true when this list controllers bad request response has a 3xx status code

func (*ListControllersBadRequest) IsServerError added in v0.26.53 

func (o *ListControllersBadRequest) IsServerError() bool

IsServerError returns true when this list controllers bad request response has a 5xx status code

func (*ListControllersBadRequest) IsSuccess added in v0.26.53 

func (o *ListControllersBadRequest) IsSuccess() bool

IsSuccess returns true when this list controllers bad request response has a 2xx status code

func (*ListControllersBadRequest) String added in v0.26.53 

func (o *ListControllersBadRequest) String() string

type ListControllersOK 

type ListControllersOK struct {

	/* Denotes different type of security token related information
	 */
	WWWAuthenticate []string

	Payload *rest_model.ListControllersEnvelope
}

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

A list of controllers

func NewListControllersOK 

func NewListControllersOK() *ListControllersOK

NewListControllersOK creates a ListControllersOK with default headers values

func (*ListControllersOK) Code added in v0.26.53 

func (o *ListControllersOK) Code() int

Code gets the status code for the list controllers o k response

func (*ListControllersOK) Error 

func (o *ListControllersOK) Error() string

func (*ListControllersOK) GetPayload 

func (o *ListControllersOK) GetPayload() *rest_model.ListControllersEnvelope

func (*ListControllersOK) IsClientError added in v0.26.53 

func (o *ListControllersOK) IsClientError() bool

IsClientError returns true when this list controllers o k response has a 4xx status code

func (*ListControllersOK) IsCode added in v0.26.53 

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

IsCode returns true when this list controllers o k response a status code equal to that given

func (*ListControllersOK) IsRedirect added in v0.26.53 

func (o *ListControllersOK) IsRedirect() bool

IsRedirect returns true when this list controllers o k response has a 3xx status code

func (*ListControllersOK) IsServerError added in v0.26.53 

func (o *ListControllersOK) IsServerError() bool

IsServerError returns true when this list controllers o k response has a 5xx status code

func (*ListControllersOK) IsSuccess added in v0.26.53 

func (o *ListControllersOK) IsSuccess() bool

IsSuccess returns true when this list controllers o k response has a 2xx status code

func (*ListControllersOK) String added in v0.26.53 

func (o *ListControllersOK) String() string

type ListControllersParams 

type ListControllersParams struct {

	// Filter.
	Filter *string

	// Limit.
	Limit *int64

	// Offset.
	Offset *int64

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

ListControllersParams contains all the parameters to send to the API endpoint 

for the list controllers operation.

Typically these are written to a http.Request.

func NewListControllersParams 

func NewListControllersParams() *ListControllersParams

NewListControllersParams creates a new ListControllersParams 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 NewListControllersParamsWithContext 

func NewListControllersParamsWithContext(ctx context.Context) *ListControllersParams

NewListControllersParamsWithContext creates a new ListControllersParams object with the ability to set a context for a request.

func NewListControllersParamsWithHTTPClient 

func NewListControllersParamsWithHTTPClient(client *http.Client) *ListControllersParams

NewListControllersParamsWithHTTPClient creates a new ListControllersParams object with the ability to set a custom HTTPClient for a request.

func NewListControllersParamsWithTimeout 

func NewListControllersParamsWithTimeout(timeout time.Duration) *ListControllersParams

NewListControllersParamsWithTimeout creates a new ListControllersParams object with the ability to set a timeout on a request.

func (*ListControllersParams) SetContext 

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

SetContext adds the context to the list controllers params

func (*ListControllersParams) SetDefaults 

func (o *ListControllersParams) SetDefaults()

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

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

func (*ListControllersParams) SetFilter 

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

SetFilter adds the filter to the list controllers params

func (*ListControllersParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the list controllers params

func (*ListControllersParams) SetLimit 

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

SetLimit adds the limit to the list controllers params

func (*ListControllersParams) SetOffset 

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

SetOffset adds the offset to the list controllers params

func (*ListControllersParams) SetTimeout 

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

SetTimeout adds the timeout to the list controllers params

func (*ListControllersParams) WithContext 

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

WithContext adds the context to the list controllers params

func (*ListControllersParams) WithDefaults 

func (o *ListControllersParams) WithDefaults() *ListControllersParams

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

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

func (*ListControllersParams) WithFilter 

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

WithFilter adds the filter to the list controllers params

func (*ListControllersParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the list controllers params

func (*ListControllersParams) WithLimit 

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

WithLimit adds the limit to the list controllers params

func (*ListControllersParams) WithOffset 

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

WithOffset adds the offset to the list controllers params

func (*ListControllersParams) WithTimeout 

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

WithTimeout adds the timeout to the list controllers params

func (*ListControllersParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ListControllersReader 

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

ListControllersReader is a Reader for the ListControllers structure.

func (*ListControllersReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ListControllersTooManyRequests 

type ListControllersTooManyRequests struct {

	/* Denotes different type of security token related information
	 */
	WWWAuthenticate []string

	Payload *rest_model.APIErrorEnvelope
}

ListControllersTooManyRequests 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 NewListControllersTooManyRequests 

func NewListControllersTooManyRequests() *ListControllersTooManyRequests

NewListControllersTooManyRequests creates a ListControllersTooManyRequests with default headers values

func (*ListControllersTooManyRequests) Code added in v0.26.53 

func (o *ListControllersTooManyRequests) Code() int

Code gets the status code for the list controllers too many requests response

func (*ListControllersTooManyRequests) Error 

func (o *ListControllersTooManyRequests) Error() string

func (*ListControllersTooManyRequests) GetPayload 

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

func (*ListControllersTooManyRequests) IsClientError added in v0.26.53 

func (o *ListControllersTooManyRequests) IsClientError() bool

IsClientError returns true when this list controllers too many requests response has a 4xx status code

func (*ListControllersTooManyRequests) IsCode added in v0.26.53 

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

IsCode returns true when this list controllers too many requests response a status code equal to that given

func (*ListControllersTooManyRequests) IsRedirect added in v0.26.53 

func (o *ListControllersTooManyRequests) IsRedirect() bool

IsRedirect returns true when this list controllers too many requests response has a 3xx status code

func (*ListControllersTooManyRequests) IsServerError added in v0.26.53 

func (o *ListControllersTooManyRequests) IsServerError() bool

IsServerError returns true when this list controllers too many requests response has a 5xx status code

func (*ListControllersTooManyRequests) IsSuccess added in v0.26.53 

func (o *ListControllersTooManyRequests) IsSuccess() bool

IsSuccess returns true when this list controllers too many requests response has a 2xx status code

func (*ListControllersTooManyRequests) String added in v0.26.53 

func (o *ListControllersTooManyRequests) String() string

type ListControllersUnauthorized 

type ListControllersUnauthorized struct {

	/* Denotes different type of security token related information
	 */
	WWWAuthenticate []string

	Payload *rest_model.APIErrorEnvelope
}

ListControllersUnauthorized describes a response with status code 401, with default header values.

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

func NewListControllersUnauthorized 

func NewListControllersUnauthorized() *ListControllersUnauthorized

NewListControllersUnauthorized creates a ListControllersUnauthorized with default headers values

func (*ListControllersUnauthorized) Code added in v0.26.53 

func (o *ListControllersUnauthorized) Code() int

Code gets the status code for the list controllers unauthorized response

func (*ListControllersUnauthorized) Error 

func (o *ListControllersUnauthorized) Error() string

func (*ListControllersUnauthorized) GetPayload 

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

func (*ListControllersUnauthorized) IsClientError added in v0.26.53 

func (o *ListControllersUnauthorized) IsClientError() bool

IsClientError returns true when this list controllers unauthorized response has a 4xx status code

func (*ListControllersUnauthorized) IsCode added in v0.26.53 

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

IsCode returns true when this list controllers unauthorized response a status code equal to that given

func (*ListControllersUnauthorized) IsRedirect added in v0.26.53 

func (o *ListControllersUnauthorized) IsRedirect() bool

IsRedirect returns true when this list controllers unauthorized response has a 3xx status code

func (*ListControllersUnauthorized) IsServerError added in v0.26.53 

func (o *ListControllersUnauthorized) IsServerError() bool

IsServerError returns true when this list controllers unauthorized response has a 5xx status code

func (*ListControllersUnauthorized) IsSuccess added in v0.26.53 

func (o *ListControllersUnauthorized) IsSuccess() bool

IsSuccess returns true when this list controllers unauthorized response has a 2xx status code

func (*ListControllersUnauthorized) String added in v0.26.53 

func (o *ListControllersUnauthorized) String() string

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.