controller

package
v0.2.0-beta1 Latest Latest
Warning

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

 Go to latest Published: Apr 13, 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 controller API

func (*Client) ForceToolsSync 

func (a *Client) ForceToolsSync(params *ForceToolsSyncParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ForceToolsSyncOK, error)
ForceToolsSync forces immediate sync of g a r m agent tools

Forces an immediate sync of GARM agent tools by resetting the cached timestamp.

This will trigger the background worker to fetch the latest tools from the configured release URL and sync them to the object store.

Note: This endpoint requires that GARM agent tools sync is enabled. If sync is disabled, the request will return an error.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) UpdateController 

func (a *Client) UpdateController(params *UpdateControllerParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateControllerOK, error)

UpdateController updates controller

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

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

type ClientService 

type ClientService interface {
	ForceToolsSync(params *ForceToolsSyncParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ForceToolsSyncOK, error)

	UpdateController(params *UpdateControllerParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateControllerOK, 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 controller API client.

func NewClientWithBasicAuth 

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

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

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

New creates a new controller 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 ForceToolsSyncBadRequest 

type ForceToolsSyncBadRequest struct {
	Payload apiserver_params.APIErrorResponse
}

ForceToolsSyncBadRequest describes a response with status code 400, with default header values.

APIErrorResponse

func NewForceToolsSyncBadRequest 

func NewForceToolsSyncBadRequest() *ForceToolsSyncBadRequest

NewForceToolsSyncBadRequest creates a ForceToolsSyncBadRequest with default headers values

func (*ForceToolsSyncBadRequest) Code 

func (o *ForceToolsSyncBadRequest) Code() int

Code gets the status code for the force tools sync bad request response

func (*ForceToolsSyncBadRequest) Error 

func (o *ForceToolsSyncBadRequest) Error() string

func (*ForceToolsSyncBadRequest) GetPayload 

func (o *ForceToolsSyncBadRequest) GetPayload() apiserver_params.APIErrorResponse

func (*ForceToolsSyncBadRequest) IsClientError 

func (o *ForceToolsSyncBadRequest) IsClientError() bool

IsClientError returns true when this force tools sync bad request response has a 4xx status code

func (*ForceToolsSyncBadRequest) IsCode 

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

IsCode returns true when this force tools sync bad request response a status code equal to that given

func (*ForceToolsSyncBadRequest) IsRedirect 

func (o *ForceToolsSyncBadRequest) IsRedirect() bool

IsRedirect returns true when this force tools sync bad request response has a 3xx status code

func (*ForceToolsSyncBadRequest) IsServerError 

func (o *ForceToolsSyncBadRequest) IsServerError() bool

IsServerError returns true when this force tools sync bad request response has a 5xx status code

func (*ForceToolsSyncBadRequest) IsSuccess 

func (o *ForceToolsSyncBadRequest) IsSuccess() bool

IsSuccess returns true when this force tools sync bad request response has a 2xx status code

func (*ForceToolsSyncBadRequest) String 

func (o *ForceToolsSyncBadRequest) String() string

type ForceToolsSyncOK 

type ForceToolsSyncOK struct {
	Payload garm_params.ControllerInfo
}

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

ControllerInfo

func NewForceToolsSyncOK 

func NewForceToolsSyncOK() *ForceToolsSyncOK

NewForceToolsSyncOK creates a ForceToolsSyncOK with default headers values

func (*ForceToolsSyncOK) Code 

func (o *ForceToolsSyncOK) Code() int

Code gets the status code for the force tools sync o k response

func (*ForceToolsSyncOK) Error 

func (o *ForceToolsSyncOK) Error() string

func (*ForceToolsSyncOK) GetPayload 

func (o *ForceToolsSyncOK) GetPayload() garm_params.ControllerInfo

func (*ForceToolsSyncOK) IsClientError 

func (o *ForceToolsSyncOK) IsClientError() bool

IsClientError returns true when this force tools sync o k response has a 4xx status code

func (*ForceToolsSyncOK) IsCode 

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

IsCode returns true when this force tools sync o k response a status code equal to that given

func (*ForceToolsSyncOK) IsRedirect 

func (o *ForceToolsSyncOK) IsRedirect() bool

IsRedirect returns true when this force tools sync o k response has a 3xx status code

func (*ForceToolsSyncOK) IsServerError 

func (o *ForceToolsSyncOK) IsServerError() bool

IsServerError returns true when this force tools sync o k response has a 5xx status code

func (*ForceToolsSyncOK) IsSuccess 

func (o *ForceToolsSyncOK) IsSuccess() bool

IsSuccess returns true when this force tools sync o k response has a 2xx status code

func (*ForceToolsSyncOK) String 

func (o *ForceToolsSyncOK) String() string

type ForceToolsSyncParams 

type ForceToolsSyncParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ForceToolsSyncParams contains all the parameters to send to the API endpoint 

for the force tools sync operation.

Typically these are written to a http.Request.

func NewForceToolsSyncParams 

func NewForceToolsSyncParams() *ForceToolsSyncParams

NewForceToolsSyncParams creates a new ForceToolsSyncParams 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 NewForceToolsSyncParamsWithContext 

func NewForceToolsSyncParamsWithContext(ctx context.Context) *ForceToolsSyncParams

NewForceToolsSyncParamsWithContext creates a new ForceToolsSyncParams object with the ability to set a context for a request.

func NewForceToolsSyncParamsWithHTTPClient 

func NewForceToolsSyncParamsWithHTTPClient(client *http.Client) *ForceToolsSyncParams

NewForceToolsSyncParamsWithHTTPClient creates a new ForceToolsSyncParams object with the ability to set a custom HTTPClient for a request.

func NewForceToolsSyncParamsWithTimeout 

func NewForceToolsSyncParamsWithTimeout(timeout time.Duration) *ForceToolsSyncParams

NewForceToolsSyncParamsWithTimeout creates a new ForceToolsSyncParams object with the ability to set a timeout on a request.

func (*ForceToolsSyncParams) SetContext 

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

SetContext adds the context to the force tools sync params

func (*ForceToolsSyncParams) SetDefaults 

func (o *ForceToolsSyncParams) SetDefaults()

SetDefaults hydrates default values in the force tools sync params (not the query body).

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

func (*ForceToolsSyncParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the force tools sync params

func (*ForceToolsSyncParams) SetTimeout 

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

SetTimeout adds the timeout to the force tools sync params

func (*ForceToolsSyncParams) WithContext 

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

WithContext adds the context to the force tools sync params

func (*ForceToolsSyncParams) WithDefaults 

func (o *ForceToolsSyncParams) WithDefaults() *ForceToolsSyncParams

WithDefaults hydrates default values in the force tools sync params (not the query body).

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

func (*ForceToolsSyncParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the force tools sync params

func (*ForceToolsSyncParams) WithTimeout 

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

WithTimeout adds the timeout to the force tools sync params

func (*ForceToolsSyncParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ForceToolsSyncReader 

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

ForceToolsSyncReader is a Reader for the ForceToolsSync structure.

func (*ForceToolsSyncReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ForceToolsSyncUnauthorized 

type ForceToolsSyncUnauthorized struct {
	Payload apiserver_params.APIErrorResponse
}

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

APIErrorResponse

func NewForceToolsSyncUnauthorized 

func NewForceToolsSyncUnauthorized() *ForceToolsSyncUnauthorized

NewForceToolsSyncUnauthorized creates a ForceToolsSyncUnauthorized with default headers values

func (*ForceToolsSyncUnauthorized) Code 

func (o *ForceToolsSyncUnauthorized) Code() int

Code gets the status code for the force tools sync unauthorized response

func (*ForceToolsSyncUnauthorized) Error 

func (o *ForceToolsSyncUnauthorized) Error() string

func (*ForceToolsSyncUnauthorized) GetPayload 

func (o *ForceToolsSyncUnauthorized) GetPayload() apiserver_params.APIErrorResponse

func (*ForceToolsSyncUnauthorized) IsClientError 

func (o *ForceToolsSyncUnauthorized) IsClientError() bool

IsClientError returns true when this force tools sync unauthorized response has a 4xx status code

func (*ForceToolsSyncUnauthorized) IsCode 

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

IsCode returns true when this force tools sync unauthorized response a status code equal to that given

func (*ForceToolsSyncUnauthorized) IsRedirect 

func (o *ForceToolsSyncUnauthorized) IsRedirect() bool

IsRedirect returns true when this force tools sync unauthorized response has a 3xx status code

func (*ForceToolsSyncUnauthorized) IsServerError 

func (o *ForceToolsSyncUnauthorized) IsServerError() bool

IsServerError returns true when this force tools sync unauthorized response has a 5xx status code

func (*ForceToolsSyncUnauthorized) IsSuccess 

func (o *ForceToolsSyncUnauthorized) IsSuccess() bool

IsSuccess returns true when this force tools sync unauthorized response has a 2xx status code

func (*ForceToolsSyncUnauthorized) String 

func (o *ForceToolsSyncUnauthorized) String() string

type UpdateControllerBadRequest 

type UpdateControllerBadRequest struct {
	Payload apiserver_params.APIErrorResponse
}

UpdateControllerBadRequest describes a response with status code 400, with default header values.

APIErrorResponse

func NewUpdateControllerBadRequest 

func NewUpdateControllerBadRequest() *UpdateControllerBadRequest

NewUpdateControllerBadRequest creates a UpdateControllerBadRequest with default headers values

func (*UpdateControllerBadRequest) Code 

func (o *UpdateControllerBadRequest) Code() int

Code gets the status code for the update controller bad request response

func (*UpdateControllerBadRequest) Error 

func (o *UpdateControllerBadRequest) Error() string

func (*UpdateControllerBadRequest) GetPayload 

func (o *UpdateControllerBadRequest) GetPayload() apiserver_params.APIErrorResponse

func (*UpdateControllerBadRequest) IsClientError 

func (o *UpdateControllerBadRequest) IsClientError() bool

IsClientError returns true when this update controller bad request response has a 4xx status code

func (*UpdateControllerBadRequest) IsCode 

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

IsCode returns true when this update controller bad request response a status code equal to that given

func (*UpdateControllerBadRequest) IsRedirect 

func (o *UpdateControllerBadRequest) IsRedirect() bool

IsRedirect returns true when this update controller bad request response has a 3xx status code

func (*UpdateControllerBadRequest) IsServerError 

func (o *UpdateControllerBadRequest) IsServerError() bool

IsServerError returns true when this update controller bad request response has a 5xx status code

func (*UpdateControllerBadRequest) IsSuccess 

func (o *UpdateControllerBadRequest) IsSuccess() bool

IsSuccess returns true when this update controller bad request response has a 2xx status code

func (*UpdateControllerBadRequest) String 

func (o *UpdateControllerBadRequest) String() string

type UpdateControllerOK 

type UpdateControllerOK struct {
	Payload garm_params.ControllerInfo
}

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

ControllerInfo

func NewUpdateControllerOK 

func NewUpdateControllerOK() *UpdateControllerOK

NewUpdateControllerOK creates a UpdateControllerOK with default headers values

func (*UpdateControllerOK) Code 

func (o *UpdateControllerOK) Code() int

Code gets the status code for the update controller o k response

func (*UpdateControllerOK) Error 

func (o *UpdateControllerOK) Error() string

func (*UpdateControllerOK) GetPayload 

func (o *UpdateControllerOK) GetPayload() garm_params.ControllerInfo

func (*UpdateControllerOK) IsClientError 

func (o *UpdateControllerOK) IsClientError() bool

IsClientError returns true when this update controller o k response has a 4xx status code

func (*UpdateControllerOK) IsCode 

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

IsCode returns true when this update controller o k response a status code equal to that given

func (*UpdateControllerOK) IsRedirect 

func (o *UpdateControllerOK) IsRedirect() bool

IsRedirect returns true when this update controller o k response has a 3xx status code

func (*UpdateControllerOK) IsServerError 

func (o *UpdateControllerOK) IsServerError() bool

IsServerError returns true when this update controller o k response has a 5xx status code

func (*UpdateControllerOK) IsSuccess 

func (o *UpdateControllerOK) IsSuccess() bool

IsSuccess returns true when this update controller o k response has a 2xx status code

func (*UpdateControllerOK) String 

func (o *UpdateControllerOK) String() string

type UpdateControllerParams 

type UpdateControllerParams struct {

	/* Body.

	   Parameters used when updating the controller.
	*/
	Body garm_params.UpdateControllerParams

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

UpdateControllerParams contains all the parameters to send to the API endpoint 

for the update controller operation.

Typically these are written to a http.Request.

func NewUpdateControllerParams 

func NewUpdateControllerParams() *UpdateControllerParams

NewUpdateControllerParams creates a new UpdateControllerParams 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 NewUpdateControllerParamsWithContext 

func NewUpdateControllerParamsWithContext(ctx context.Context) *UpdateControllerParams

NewUpdateControllerParamsWithContext creates a new UpdateControllerParams object with the ability to set a context for a request.

func NewUpdateControllerParamsWithHTTPClient 

func NewUpdateControllerParamsWithHTTPClient(client *http.Client) *UpdateControllerParams

NewUpdateControllerParamsWithHTTPClient creates a new UpdateControllerParams object with the ability to set a custom HTTPClient for a request.

func NewUpdateControllerParamsWithTimeout 

func NewUpdateControllerParamsWithTimeout(timeout time.Duration) *UpdateControllerParams

NewUpdateControllerParamsWithTimeout creates a new UpdateControllerParams object with the ability to set a timeout on a request.

func (*UpdateControllerParams) SetBody 

func (o *UpdateControllerParams) SetBody(body garm_params.UpdateControllerParams)

SetBody adds the body to the update controller params

func (*UpdateControllerParams) SetContext 

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

SetContext adds the context to the update controller params

func (*UpdateControllerParams) SetDefaults 

func (o *UpdateControllerParams) SetDefaults()

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

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

func (*UpdateControllerParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the update controller params

func (*UpdateControllerParams) SetTimeout 

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

SetTimeout adds the timeout to the update controller params

func (*UpdateControllerParams) WithBody 

func (o *UpdateControllerParams) WithBody(body garm_params.UpdateControllerParams) *UpdateControllerParams

WithBody adds the body to the update controller params

func (*UpdateControllerParams) WithContext 

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

WithContext adds the context to the update controller params

func (*UpdateControllerParams) WithDefaults 

func (o *UpdateControllerParams) WithDefaults() *UpdateControllerParams

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

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

func (*UpdateControllerParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the update controller params

func (*UpdateControllerParams) WithTimeout 

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

WithTimeout adds the timeout to the update controller params

func (*UpdateControllerParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type UpdateControllerReader 

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

UpdateControllerReader is a Reader for the UpdateController structure.

func (*UpdateControllerReader) ReadResponse 

func (o *UpdateControllerReader) 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.