execs

package
v0.6.0 Latest Latest
Warning

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

Go to latest
Published: Jul 22, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BackgroundExecBoxBadRequest

type BackgroundExecBoxBadRequest struct {
	Payload *models.Error
}

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

The request was invalid or could not be processed.

func NewBackgroundExecBoxBadRequest

func NewBackgroundExecBoxBadRequest() *BackgroundExecBoxBadRequest

NewBackgroundExecBoxBadRequest creates a BackgroundExecBoxBadRequest with default headers values

func (*BackgroundExecBoxBadRequest) Code

func (o *BackgroundExecBoxBadRequest) Code() int

Code gets the status code for the background exec box bad request response

func (*BackgroundExecBoxBadRequest) Error

func (*BackgroundExecBoxBadRequest) GetPayload

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

func (*BackgroundExecBoxBadRequest) IsClientError

func (o *BackgroundExecBoxBadRequest) IsClientError() bool

IsClientError returns true when this background exec box bad request response has a 4xx status code

func (*BackgroundExecBoxBadRequest) IsCode

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

IsCode returns true when this background exec box bad request response a status code equal to that given

func (*BackgroundExecBoxBadRequest) IsRedirect

func (o *BackgroundExecBoxBadRequest) IsRedirect() bool

IsRedirect returns true when this background exec box bad request response has a 3xx status code

func (*BackgroundExecBoxBadRequest) IsServerError

func (o *BackgroundExecBoxBadRequest) IsServerError() bool

IsServerError returns true when this background exec box bad request response has a 5xx status code

func (*BackgroundExecBoxBadRequest) IsSuccess

func (o *BackgroundExecBoxBadRequest) IsSuccess() bool

IsSuccess returns true when this background exec box bad request response has a 2xx status code

func (*BackgroundExecBoxBadRequest) String

func (o *BackgroundExecBoxBadRequest) String() string

type BackgroundExecBoxConflict added in v0.4.0

type BackgroundExecBoxConflict struct {
	Payload *models.Error
}

BackgroundExecBoxConflict describes a response with status code 409, with default header values.

The idempotency key was already used with a different request.

func NewBackgroundExecBoxConflict added in v0.4.0

func NewBackgroundExecBoxConflict() *BackgroundExecBoxConflict

NewBackgroundExecBoxConflict creates a BackgroundExecBoxConflict with default headers values

func (*BackgroundExecBoxConflict) Code added in v0.4.0

func (o *BackgroundExecBoxConflict) Code() int

Code gets the status code for the background exec box conflict response

func (*BackgroundExecBoxConflict) Error added in v0.4.0

func (o *BackgroundExecBoxConflict) Error() string

func (*BackgroundExecBoxConflict) GetPayload added in v0.4.0

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

func (*BackgroundExecBoxConflict) IsClientError added in v0.4.0

func (o *BackgroundExecBoxConflict) IsClientError() bool

IsClientError returns true when this background exec box conflict response has a 4xx status code

func (*BackgroundExecBoxConflict) IsCode added in v0.4.0

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

IsCode returns true when this background exec box conflict response a status code equal to that given

func (*BackgroundExecBoxConflict) IsRedirect added in v0.4.0

func (o *BackgroundExecBoxConflict) IsRedirect() bool

IsRedirect returns true when this background exec box conflict response has a 3xx status code

func (*BackgroundExecBoxConflict) IsServerError added in v0.4.0

func (o *BackgroundExecBoxConflict) IsServerError() bool

IsServerError returns true when this background exec box conflict response has a 5xx status code

func (*BackgroundExecBoxConflict) IsSuccess added in v0.4.0

func (o *BackgroundExecBoxConflict) IsSuccess() bool

IsSuccess returns true when this background exec box conflict response has a 2xx status code

func (*BackgroundExecBoxConflict) String added in v0.4.0

func (o *BackgroundExecBoxConflict) String() string

type BackgroundExecBoxCreated

type BackgroundExecBoxCreated struct {
	Payload *models.APIExecView
}

BackgroundExecBoxCreated describes a response with status code 201, with default header values.

The accepted background exec.

func NewBackgroundExecBoxCreated

func NewBackgroundExecBoxCreated() *BackgroundExecBoxCreated

NewBackgroundExecBoxCreated creates a BackgroundExecBoxCreated with default headers values

func (*BackgroundExecBoxCreated) Code

func (o *BackgroundExecBoxCreated) Code() int

Code gets the status code for the background exec box created response

func (*BackgroundExecBoxCreated) Error

func (o *BackgroundExecBoxCreated) Error() string

func (*BackgroundExecBoxCreated) GetPayload

func (o *BackgroundExecBoxCreated) GetPayload() *models.APIExecView

func (*BackgroundExecBoxCreated) IsClientError

func (o *BackgroundExecBoxCreated) IsClientError() bool

IsClientError returns true when this background exec box created response has a 4xx status code

func (*BackgroundExecBoxCreated) IsCode

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

IsCode returns true when this background exec box created response a status code equal to that given

func (*BackgroundExecBoxCreated) IsRedirect

func (o *BackgroundExecBoxCreated) IsRedirect() bool

IsRedirect returns true when this background exec box created response has a 3xx status code

func (*BackgroundExecBoxCreated) IsServerError

func (o *BackgroundExecBoxCreated) IsServerError() bool

IsServerError returns true when this background exec box created response has a 5xx status code

func (*BackgroundExecBoxCreated) IsSuccess

func (o *BackgroundExecBoxCreated) IsSuccess() bool

IsSuccess returns true when this background exec box created response has a 2xx status code

func (*BackgroundExecBoxCreated) String

func (o *BackgroundExecBoxCreated) String() string

type BackgroundExecBoxParams

type BackgroundExecBoxParams struct {

	/* IdempotencyKey.

	   Opaque key that makes retries of this background exec creation idempotent within the project.
	*/
	IdempotencyKey *string

	/* ID.

	   Resource identifier.
	*/
	ID string

	/* ProjectCid.

	   Project handle (`project_cid`).
	*/
	ProjectCid string

	/* Request.

	   Request body
	*/
	Request *models.BackgroundExecBoxPayload

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

BackgroundExecBoxParams contains all the parameters to send to the API endpoint

for the background exec box operation.

Typically these are written to a http.Request.

func NewBackgroundExecBoxParams

func NewBackgroundExecBoxParams() *BackgroundExecBoxParams

NewBackgroundExecBoxParams creates a new BackgroundExecBoxParams 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 NewBackgroundExecBoxParamsWithContext deprecated

func NewBackgroundExecBoxParamsWithContext(ctx context.Context) *BackgroundExecBoxParams

NewBackgroundExecBoxParamsWithContext creates a new BackgroundExecBoxParams object with the ability to set a context for a request.

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

func NewBackgroundExecBoxParamsWithHTTPClient

func NewBackgroundExecBoxParamsWithHTTPClient(client *http.Client) *BackgroundExecBoxParams

NewBackgroundExecBoxParamsWithHTTPClient creates a new BackgroundExecBoxParams object with the ability to set a custom HTTPClient for a request.

func NewBackgroundExecBoxParamsWithTimeout

func NewBackgroundExecBoxParamsWithTimeout(timeout time.Duration) *BackgroundExecBoxParams

NewBackgroundExecBoxParamsWithTimeout creates a new BackgroundExecBoxParams object with the ability to set a timeout on a request.

func (*BackgroundExecBoxParams) SetContext deprecated

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

SetContext adds the context to the background exec box params.

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

func (*BackgroundExecBoxParams) SetDefaults

func (o *BackgroundExecBoxParams) SetDefaults()

SetDefaults hydrates default values in the background exec box params (not the query body).

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

func (*BackgroundExecBoxParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the background exec box params.

func (*BackgroundExecBoxParams) SetID

func (o *BackgroundExecBoxParams) SetID(id string)

SetID adds the id to the background exec box params.

func (*BackgroundExecBoxParams) SetIdempotencyKey added in v0.4.0

func (o *BackgroundExecBoxParams) SetIdempotencyKey(idempotencyKey *string)

SetIdempotencyKey adds the idempotencyKey to the background exec box params.

func (*BackgroundExecBoxParams) SetProjectCid

func (o *BackgroundExecBoxParams) SetProjectCid(projectCid string)

SetProjectCid adds the projectCid to the background exec box params.

func (*BackgroundExecBoxParams) SetRequest

SetRequest adds the request to the background exec box params.

func (*BackgroundExecBoxParams) SetTimeout

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

SetTimeout adds the timeout to the background exec box params.

func (*BackgroundExecBoxParams) WithContext deprecated

WithContext adds the context to the background exec box params.

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

func (*BackgroundExecBoxParams) WithDefaults

WithDefaults hydrates default values in the background exec box params (not the query body).

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

func (*BackgroundExecBoxParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the background exec box params.

func (*BackgroundExecBoxParams) WithID

WithID adds the id to the background exec box params.

func (*BackgroundExecBoxParams) WithIdempotencyKey added in v0.4.0

func (o *BackgroundExecBoxParams) WithIdempotencyKey(idempotencyKey *string) *BackgroundExecBoxParams

WithIdempotencyKey adds the idempotencyKey to the background exec box params.

func (*BackgroundExecBoxParams) WithProjectCid

func (o *BackgroundExecBoxParams) WithProjectCid(projectCid string) *BackgroundExecBoxParams

WithProjectCid adds the projectCid to the background exec box params.

func (*BackgroundExecBoxParams) WithRequest

WithRequest adds the request to the background exec box params.

func (*BackgroundExecBoxParams) WithTimeout

WithTimeout adds the timeout to the background exec box params.

func (*BackgroundExecBoxParams) WriteToRequest

WriteToRequest writes these params to a runtime.ClientRequest.

type BackgroundExecBoxReader

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

BackgroundExecBoxReader is a Reader for the BackgroundExecBox structure.

func (*BackgroundExecBoxReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type BackgroundExecBoxUnauthorized

type BackgroundExecBoxUnauthorized struct {
	Payload *models.Error
}

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

Missing or invalid credentials.

func NewBackgroundExecBoxUnauthorized

func NewBackgroundExecBoxUnauthorized() *BackgroundExecBoxUnauthorized

NewBackgroundExecBoxUnauthorized creates a BackgroundExecBoxUnauthorized with default headers values

func (*BackgroundExecBoxUnauthorized) Code

Code gets the status code for the background exec box unauthorized response

func (*BackgroundExecBoxUnauthorized) Error

func (*BackgroundExecBoxUnauthorized) GetPayload

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

func (*BackgroundExecBoxUnauthorized) IsClientError

func (o *BackgroundExecBoxUnauthorized) IsClientError() bool

IsClientError returns true when this background exec box unauthorized response has a 4xx status code

func (*BackgroundExecBoxUnauthorized) IsCode

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

IsCode returns true when this background exec box unauthorized response a status code equal to that given

func (*BackgroundExecBoxUnauthorized) IsRedirect

func (o *BackgroundExecBoxUnauthorized) IsRedirect() bool

IsRedirect returns true when this background exec box unauthorized response has a 3xx status code

func (*BackgroundExecBoxUnauthorized) IsServerError

func (o *BackgroundExecBoxUnauthorized) IsServerError() bool

IsServerError returns true when this background exec box unauthorized response has a 5xx status code

func (*BackgroundExecBoxUnauthorized) IsSuccess

func (o *BackgroundExecBoxUnauthorized) IsSuccess() bool

IsSuccess returns true when this background exec box unauthorized response has a 2xx status code

func (*BackgroundExecBoxUnauthorized) String

type Client

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

Client for execs API.

func (*Client) BackgroundExecBox

func (a *Client) BackgroundExecBox(params *BackgroundExecBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*BackgroundExecBoxCreated, error)

BackgroundExecBoxstarts a background command in a box.

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.BackgroundExecBoxContext instead.

func (*Client) BackgroundExecBoxContext

func (a *Client) BackgroundExecBoxContext(ctx context.Context, params *BackgroundExecBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*BackgroundExecBoxCreated, error)

BackgroundExecBoxContextstarts a background command in a box.

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

func (*Client) ExecBox

func (a *Client) ExecBox(params *ExecBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ExecBoxCreated, error)

ExecBoxruns a foreground command in a box.

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.ExecBoxContext instead.

func (*Client) ExecBoxContext

func (a *Client) ExecBoxContext(ctx context.Context, params *ExecBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ExecBoxCreated, error)

ExecBoxContextruns a foreground command in a box.

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

func (*Client) GetExec

func (a *Client) GetExec(params *GetExecParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetExecOK, error)

GetExecgets an exec.

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.GetExecContext instead.

func (*Client) GetExecContext

func (a *Client) GetExecContext(ctx context.Context, params *GetExecParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetExecOK, error)

GetExecContextgets an exec.

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

func (*Client) KillBackgroundExec

func (a *Client) KillBackgroundExec(params *KillBackgroundExecParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*KillBackgroundExecOK, error)

KillBackgroundExeckills a background exec.

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.KillBackgroundExecContext instead.

func (*Client) KillBackgroundExecContext

func (a *Client) KillBackgroundExecContext(ctx context.Context, params *KillBackgroundExecParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*KillBackgroundExecOK, error)

KillBackgroundExecContextkills a background exec.

Do not use the deprecated [KillBackgroundExecParams.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 {

	// BackgroundExecBox start a background command in a box.
	BackgroundExecBox(params *BackgroundExecBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*BackgroundExecBoxCreated, error)

	// BackgroundExecBoxContext start a background command in a box.
	BackgroundExecBoxContext(ctx context.Context, params *BackgroundExecBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*BackgroundExecBoxCreated, error)

	// ExecBox run a foreground command in a box.
	ExecBox(params *ExecBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ExecBoxCreated, error)

	// ExecBoxContext run a foreground command in a box.
	ExecBoxContext(ctx context.Context, params *ExecBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ExecBoxCreated, error)

	// GetExec get an exec.
	GetExec(params *GetExecParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetExecOK, error)

	// GetExecContext get an exec.
	GetExecContext(ctx context.Context, params *GetExecParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetExecOK, error)

	// KillBackgroundExec kill a background exec.
	KillBackgroundExec(params *KillBackgroundExecParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*KillBackgroundExecOK, error)

	// KillBackgroundExecContext kill a background exec.
	KillBackgroundExecContext(ctx context.Context, params *KillBackgroundExecParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*KillBackgroundExecOK, error)

	SetTransport(transport runtime.ContextualTransport)
}

ClientService is the interface for Client methods.

func New

New creates a new execs API client.

func NewClientWithBasicAuth

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

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

type ExecBoxBadRequest struct {
	Payload *models.Error
}

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

The request was invalid or could not be processed.

func NewExecBoxBadRequest

func NewExecBoxBadRequest() *ExecBoxBadRequest

NewExecBoxBadRequest creates a ExecBoxBadRequest with default headers values

func (*ExecBoxBadRequest) Code

func (o *ExecBoxBadRequest) Code() int

Code gets the status code for the exec box bad request response

func (*ExecBoxBadRequest) Error

func (o *ExecBoxBadRequest) Error() string

func (*ExecBoxBadRequest) GetPayload

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

func (*ExecBoxBadRequest) IsClientError

func (o *ExecBoxBadRequest) IsClientError() bool

IsClientError returns true when this exec box bad request response has a 4xx status code

func (*ExecBoxBadRequest) IsCode

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

IsCode returns true when this exec box bad request response a status code equal to that given

func (*ExecBoxBadRequest) IsRedirect

func (o *ExecBoxBadRequest) IsRedirect() bool

IsRedirect returns true when this exec box bad request response has a 3xx status code

func (*ExecBoxBadRequest) IsServerError

func (o *ExecBoxBadRequest) IsServerError() bool

IsServerError returns true when this exec box bad request response has a 5xx status code

func (*ExecBoxBadRequest) IsSuccess

func (o *ExecBoxBadRequest) IsSuccess() bool

IsSuccess returns true when this exec box bad request response has a 2xx status code

func (*ExecBoxBadRequest) String

func (o *ExecBoxBadRequest) String() string

type ExecBoxCreated

type ExecBoxCreated struct {
	Payload *models.APIExecView
}

ExecBoxCreated describes a response with status code 201, with default header values.

The accepted exec.

func NewExecBoxCreated

func NewExecBoxCreated() *ExecBoxCreated

NewExecBoxCreated creates a ExecBoxCreated with default headers values

func (*ExecBoxCreated) Code

func (o *ExecBoxCreated) Code() int

Code gets the status code for the exec box created response

func (*ExecBoxCreated) Error

func (o *ExecBoxCreated) Error() string

func (*ExecBoxCreated) GetPayload

func (o *ExecBoxCreated) GetPayload() *models.APIExecView

func (*ExecBoxCreated) IsClientError

func (o *ExecBoxCreated) IsClientError() bool

IsClientError returns true when this exec box created response has a 4xx status code

func (*ExecBoxCreated) IsCode

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

IsCode returns true when this exec box created response a status code equal to that given

func (*ExecBoxCreated) IsRedirect

func (o *ExecBoxCreated) IsRedirect() bool

IsRedirect returns true when this exec box created response has a 3xx status code

func (*ExecBoxCreated) IsServerError

func (o *ExecBoxCreated) IsServerError() bool

IsServerError returns true when this exec box created response has a 5xx status code

func (*ExecBoxCreated) IsSuccess

func (o *ExecBoxCreated) IsSuccess() bool

IsSuccess returns true when this exec box created response has a 2xx status code

func (*ExecBoxCreated) String

func (o *ExecBoxCreated) String() string

type ExecBoxParams

type ExecBoxParams struct {

	/* ID.

	   Resource identifier.
	*/
	ID string

	/* ProjectCid.

	   Project handle (`project_cid`).
	*/
	ProjectCid string

	/* Request.

	   Request body
	*/
	Request *models.ExecBoxPayload

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

ExecBoxParams contains all the parameters to send to the API endpoint

for the exec box operation.

Typically these are written to a http.Request.

func NewExecBoxParams

func NewExecBoxParams() *ExecBoxParams

NewExecBoxParams creates a new ExecBoxParams 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 NewExecBoxParamsWithContext deprecated

func NewExecBoxParamsWithContext(ctx context.Context) *ExecBoxParams

NewExecBoxParamsWithContext creates a new ExecBoxParams object with the ability to set a context for a request.

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

func NewExecBoxParamsWithHTTPClient

func NewExecBoxParamsWithHTTPClient(client *http.Client) *ExecBoxParams

NewExecBoxParamsWithHTTPClient creates a new ExecBoxParams object with the ability to set a custom HTTPClient for a request.

func NewExecBoxParamsWithTimeout

func NewExecBoxParamsWithTimeout(timeout time.Duration) *ExecBoxParams

NewExecBoxParamsWithTimeout creates a new ExecBoxParams object with the ability to set a timeout on a request.

func (*ExecBoxParams) SetContext deprecated

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

SetContext adds the context to the exec box params.

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

func (*ExecBoxParams) SetDefaults

func (o *ExecBoxParams) SetDefaults()

SetDefaults hydrates default values in the exec box params (not the query body).

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

func (*ExecBoxParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the exec box params.

func (*ExecBoxParams) SetID

func (o *ExecBoxParams) SetID(id string)

SetID adds the id to the exec box params.

func (*ExecBoxParams) SetProjectCid

func (o *ExecBoxParams) SetProjectCid(projectCid string)

SetProjectCid adds the projectCid to the exec box params.

func (*ExecBoxParams) SetRequest

func (o *ExecBoxParams) SetRequest(request *models.ExecBoxPayload)

SetRequest adds the request to the exec box params.

func (*ExecBoxParams) SetTimeout

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

SetTimeout adds the timeout to the exec box params.

func (*ExecBoxParams) WithContext deprecated

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

WithContext adds the context to the exec box params.

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

func (*ExecBoxParams) WithDefaults

func (o *ExecBoxParams) WithDefaults() *ExecBoxParams

WithDefaults hydrates default values in the exec box params (not the query body).

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

func (*ExecBoxParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the exec box params.

func (*ExecBoxParams) WithID

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

WithID adds the id to the exec box params.

func (*ExecBoxParams) WithProjectCid

func (o *ExecBoxParams) WithProjectCid(projectCid string) *ExecBoxParams

WithProjectCid adds the projectCid to the exec box params.

func (*ExecBoxParams) WithRequest

func (o *ExecBoxParams) WithRequest(request *models.ExecBoxPayload) *ExecBoxParams

WithRequest adds the request to the exec box params.

func (*ExecBoxParams) WithTimeout

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

WithTimeout adds the timeout to the exec box params.

func (*ExecBoxParams) WriteToRequest

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

WriteToRequest writes these params to a runtime.ClientRequest.

type ExecBoxReader

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

ExecBoxReader is a Reader for the ExecBox structure.

func (*ExecBoxReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type ExecBoxUnauthorized

type ExecBoxUnauthorized struct {
	Payload *models.Error
}

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

Missing or invalid credentials.

func NewExecBoxUnauthorized

func NewExecBoxUnauthorized() *ExecBoxUnauthorized

NewExecBoxUnauthorized creates a ExecBoxUnauthorized with default headers values

func (*ExecBoxUnauthorized) Code

func (o *ExecBoxUnauthorized) Code() int

Code gets the status code for the exec box unauthorized response

func (*ExecBoxUnauthorized) Error

func (o *ExecBoxUnauthorized) Error() string

func (*ExecBoxUnauthorized) GetPayload

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

func (*ExecBoxUnauthorized) IsClientError

func (o *ExecBoxUnauthorized) IsClientError() bool

IsClientError returns true when this exec box unauthorized response has a 4xx status code

func (*ExecBoxUnauthorized) IsCode

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

IsCode returns true when this exec box unauthorized response a status code equal to that given

func (*ExecBoxUnauthorized) IsRedirect

func (o *ExecBoxUnauthorized) IsRedirect() bool

IsRedirect returns true when this exec box unauthorized response has a 3xx status code

func (*ExecBoxUnauthorized) IsServerError

func (o *ExecBoxUnauthorized) IsServerError() bool

IsServerError returns true when this exec box unauthorized response has a 5xx status code

func (*ExecBoxUnauthorized) IsSuccess

func (o *ExecBoxUnauthorized) IsSuccess() bool

IsSuccess returns true when this exec box unauthorized response has a 2xx status code

func (*ExecBoxUnauthorized) String

func (o *ExecBoxUnauthorized) String() string

type GetExecBadRequest

type GetExecBadRequest struct {
	Payload *models.Error
}

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

The request was invalid or could not be processed.

func NewGetExecBadRequest

func NewGetExecBadRequest() *GetExecBadRequest

NewGetExecBadRequest creates a GetExecBadRequest with default headers values

func (*GetExecBadRequest) Code

func (o *GetExecBadRequest) Code() int

Code gets the status code for the get exec bad request response

func (*GetExecBadRequest) Error

func (o *GetExecBadRequest) Error() string

func (*GetExecBadRequest) GetPayload

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

func (*GetExecBadRequest) IsClientError

func (o *GetExecBadRequest) IsClientError() bool

IsClientError returns true when this get exec bad request response has a 4xx status code

func (*GetExecBadRequest) IsCode

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

IsCode returns true when this get exec bad request response a status code equal to that given

func (*GetExecBadRequest) IsRedirect

func (o *GetExecBadRequest) IsRedirect() bool

IsRedirect returns true when this get exec bad request response has a 3xx status code

func (*GetExecBadRequest) IsServerError

func (o *GetExecBadRequest) IsServerError() bool

IsServerError returns true when this get exec bad request response has a 5xx status code

func (*GetExecBadRequest) IsSuccess

func (o *GetExecBadRequest) IsSuccess() bool

IsSuccess returns true when this get exec bad request response has a 2xx status code

func (*GetExecBadRequest) String

func (o *GetExecBadRequest) String() string

type GetExecOK

type GetExecOK struct {
	Payload *models.APIExecView
}

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

The exec.

func NewGetExecOK

func NewGetExecOK() *GetExecOK

NewGetExecOK creates a GetExecOK with default headers values

func (*GetExecOK) Code

func (o *GetExecOK) Code() int

Code gets the status code for the get exec o k response

func (*GetExecOK) Error

func (o *GetExecOK) Error() string

func (*GetExecOK) GetPayload

func (o *GetExecOK) GetPayload() *models.APIExecView

func (*GetExecOK) IsClientError

func (o *GetExecOK) IsClientError() bool

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

func (*GetExecOK) IsCode

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

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

func (*GetExecOK) IsRedirect

func (o *GetExecOK) IsRedirect() bool

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

func (*GetExecOK) IsServerError

func (o *GetExecOK) IsServerError() bool

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

func (*GetExecOK) IsSuccess

func (o *GetExecOK) IsSuccess() bool

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

func (*GetExecOK) String

func (o *GetExecOK) String() string

type GetExecParams

type GetExecParams struct {

	/* ID.

	   Resource identifier.
	*/
	ID string

	/* ProjectCid.

	   Project handle (`project_cid`).
	*/
	ProjectCid string

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

GetExecParams contains all the parameters to send to the API endpoint

for the get exec operation.

Typically these are written to a http.Request.

func NewGetExecParams

func NewGetExecParams() *GetExecParams

NewGetExecParams creates a new GetExecParams 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 NewGetExecParamsWithContext deprecated

func NewGetExecParamsWithContext(ctx context.Context) *GetExecParams

NewGetExecParamsWithContext creates a new GetExecParams object with the ability to set a context for a request.

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

func NewGetExecParamsWithHTTPClient

func NewGetExecParamsWithHTTPClient(client *http.Client) *GetExecParams

NewGetExecParamsWithHTTPClient creates a new GetExecParams object with the ability to set a custom HTTPClient for a request.

func NewGetExecParamsWithTimeout

func NewGetExecParamsWithTimeout(timeout time.Duration) *GetExecParams

NewGetExecParamsWithTimeout creates a new GetExecParams object with the ability to set a timeout on a request.

func (*GetExecParams) SetContext deprecated

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

SetContext adds the context to the get exec params.

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

func (*GetExecParams) SetDefaults

func (o *GetExecParams) SetDefaults()

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

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

func (*GetExecParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get exec params.

func (*GetExecParams) SetID

func (o *GetExecParams) SetID(id string)

SetID adds the id to the get exec params.

func (*GetExecParams) SetProjectCid

func (o *GetExecParams) SetProjectCid(projectCid string)

SetProjectCid adds the projectCid to the get exec params.

func (*GetExecParams) SetTimeout

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

SetTimeout adds the timeout to the get exec params.

func (*GetExecParams) WithContext deprecated

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

WithContext adds the context to the get exec params.

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

func (*GetExecParams) WithDefaults

func (o *GetExecParams) WithDefaults() *GetExecParams

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

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

func (*GetExecParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get exec params.

func (*GetExecParams) WithID

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

WithID adds the id to the get exec params.

func (*GetExecParams) WithProjectCid

func (o *GetExecParams) WithProjectCid(projectCid string) *GetExecParams

WithProjectCid adds the projectCid to the get exec params.

func (*GetExecParams) WithTimeout

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

WithTimeout adds the timeout to the get exec params.

func (*GetExecParams) WriteToRequest

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

WriteToRequest writes these params to a runtime.ClientRequest.

type GetExecReader

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

GetExecReader is a Reader for the GetExec structure.

func (*GetExecReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetExecUnauthorized

type GetExecUnauthorized struct {
	Payload *models.Error
}

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

Missing or invalid credentials.

func NewGetExecUnauthorized

func NewGetExecUnauthorized() *GetExecUnauthorized

NewGetExecUnauthorized creates a GetExecUnauthorized with default headers values

func (*GetExecUnauthorized) Code

func (o *GetExecUnauthorized) Code() int

Code gets the status code for the get exec unauthorized response

func (*GetExecUnauthorized) Error

func (o *GetExecUnauthorized) Error() string

func (*GetExecUnauthorized) GetPayload

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

func (*GetExecUnauthorized) IsClientError

func (o *GetExecUnauthorized) IsClientError() bool

IsClientError returns true when this get exec unauthorized response has a 4xx status code

func (*GetExecUnauthorized) IsCode

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

IsCode returns true when this get exec unauthorized response a status code equal to that given

func (*GetExecUnauthorized) IsRedirect

func (o *GetExecUnauthorized) IsRedirect() bool

IsRedirect returns true when this get exec unauthorized response has a 3xx status code

func (*GetExecUnauthorized) IsServerError

func (o *GetExecUnauthorized) IsServerError() bool

IsServerError returns true when this get exec unauthorized response has a 5xx status code

func (*GetExecUnauthorized) IsSuccess

func (o *GetExecUnauthorized) IsSuccess() bool

IsSuccess returns true when this get exec unauthorized response has a 2xx status code

func (*GetExecUnauthorized) String

func (o *GetExecUnauthorized) String() string

type KillBackgroundExecBadRequest

type KillBackgroundExecBadRequest struct {
	Payload *models.Error
}

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

The request was invalid or could not be processed.

func NewKillBackgroundExecBadRequest

func NewKillBackgroundExecBadRequest() *KillBackgroundExecBadRequest

NewKillBackgroundExecBadRequest creates a KillBackgroundExecBadRequest with default headers values

func (*KillBackgroundExecBadRequest) Code

Code gets the status code for the kill background exec bad request response

func (*KillBackgroundExecBadRequest) Error

func (*KillBackgroundExecBadRequest) GetPayload

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

func (*KillBackgroundExecBadRequest) IsClientError

func (o *KillBackgroundExecBadRequest) IsClientError() bool

IsClientError returns true when this kill background exec bad request response has a 4xx status code

func (*KillBackgroundExecBadRequest) IsCode

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

IsCode returns true when this kill background exec bad request response a status code equal to that given

func (*KillBackgroundExecBadRequest) IsRedirect

func (o *KillBackgroundExecBadRequest) IsRedirect() bool

IsRedirect returns true when this kill background exec bad request response has a 3xx status code

func (*KillBackgroundExecBadRequest) IsServerError

func (o *KillBackgroundExecBadRequest) IsServerError() bool

IsServerError returns true when this kill background exec bad request response has a 5xx status code

func (*KillBackgroundExecBadRequest) IsSuccess

func (o *KillBackgroundExecBadRequest) IsSuccess() bool

IsSuccess returns true when this kill background exec bad request response has a 2xx status code

func (*KillBackgroundExecBadRequest) String

type KillBackgroundExecOK

type KillBackgroundExecOK struct {
}

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

Kill accepted.

func NewKillBackgroundExecOK

func NewKillBackgroundExecOK() *KillBackgroundExecOK

NewKillBackgroundExecOK creates a KillBackgroundExecOK with default headers values

func (*KillBackgroundExecOK) Code

func (o *KillBackgroundExecOK) Code() int

Code gets the status code for the kill background exec o k response

func (*KillBackgroundExecOK) Error

func (o *KillBackgroundExecOK) Error() string

func (*KillBackgroundExecOK) IsClientError

func (o *KillBackgroundExecOK) IsClientError() bool

IsClientError returns true when this kill background exec o k response has a 4xx status code

func (*KillBackgroundExecOK) IsCode

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

IsCode returns true when this kill background exec o k response a status code equal to that given

func (*KillBackgroundExecOK) IsRedirect

func (o *KillBackgroundExecOK) IsRedirect() bool

IsRedirect returns true when this kill background exec o k response has a 3xx status code

func (*KillBackgroundExecOK) IsServerError

func (o *KillBackgroundExecOK) IsServerError() bool

IsServerError returns true when this kill background exec o k response has a 5xx status code

func (*KillBackgroundExecOK) IsSuccess

func (o *KillBackgroundExecOK) IsSuccess() bool

IsSuccess returns true when this kill background exec o k response has a 2xx status code

func (*KillBackgroundExecOK) String

func (o *KillBackgroundExecOK) String() string

type KillBackgroundExecParams

type KillBackgroundExecParams struct {

	/* ID.

	   Resource identifier.
	*/
	ID string

	/* ProjectCid.

	   Project handle (`project_cid`).
	*/
	ProjectCid string

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

KillBackgroundExecParams contains all the parameters to send to the API endpoint

for the kill background exec operation.

Typically these are written to a http.Request.

func NewKillBackgroundExecParams

func NewKillBackgroundExecParams() *KillBackgroundExecParams

NewKillBackgroundExecParams creates a new KillBackgroundExecParams 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 NewKillBackgroundExecParamsWithContext deprecated

func NewKillBackgroundExecParamsWithContext(ctx context.Context) *KillBackgroundExecParams

NewKillBackgroundExecParamsWithContext creates a new KillBackgroundExecParams object with the ability to set a context for a request.

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

func NewKillBackgroundExecParamsWithHTTPClient

func NewKillBackgroundExecParamsWithHTTPClient(client *http.Client) *KillBackgroundExecParams

NewKillBackgroundExecParamsWithHTTPClient creates a new KillBackgroundExecParams object with the ability to set a custom HTTPClient for a request.

func NewKillBackgroundExecParamsWithTimeout

func NewKillBackgroundExecParamsWithTimeout(timeout time.Duration) *KillBackgroundExecParams

NewKillBackgroundExecParamsWithTimeout creates a new KillBackgroundExecParams object with the ability to set a timeout on a request.

func (*KillBackgroundExecParams) SetContext deprecated

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

SetContext adds the context to the kill background exec params.

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

func (*KillBackgroundExecParams) SetDefaults

func (o *KillBackgroundExecParams) SetDefaults()

SetDefaults hydrates default values in the kill background exec params (not the query body).

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

func (*KillBackgroundExecParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the kill background exec params.

func (*KillBackgroundExecParams) SetID

func (o *KillBackgroundExecParams) SetID(id string)

SetID adds the id to the kill background exec params.

func (*KillBackgroundExecParams) SetProjectCid

func (o *KillBackgroundExecParams) SetProjectCid(projectCid string)

SetProjectCid adds the projectCid to the kill background exec params.

func (*KillBackgroundExecParams) SetTimeout

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

SetTimeout adds the timeout to the kill background exec params.

func (*KillBackgroundExecParams) WithContext deprecated

WithContext adds the context to the kill background exec params.

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

func (*KillBackgroundExecParams) WithDefaults

WithDefaults hydrates default values in the kill background exec params (not the query body).

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

func (*KillBackgroundExecParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the kill background exec params.

func (*KillBackgroundExecParams) WithID

WithID adds the id to the kill background exec params.

func (*KillBackgroundExecParams) WithProjectCid

func (o *KillBackgroundExecParams) WithProjectCid(projectCid string) *KillBackgroundExecParams

WithProjectCid adds the projectCid to the kill background exec params.

func (*KillBackgroundExecParams) WithTimeout

WithTimeout adds the timeout to the kill background exec params.

func (*KillBackgroundExecParams) WriteToRequest

WriteToRequest writes these params to a runtime.ClientRequest.

type KillBackgroundExecReader

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

KillBackgroundExecReader is a Reader for the KillBackgroundExec structure.

func (*KillBackgroundExecReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type KillBackgroundExecUnauthorized

type KillBackgroundExecUnauthorized struct {
	Payload *models.Error
}

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

Missing or invalid credentials.

func NewKillBackgroundExecUnauthorized

func NewKillBackgroundExecUnauthorized() *KillBackgroundExecUnauthorized

NewKillBackgroundExecUnauthorized creates a KillBackgroundExecUnauthorized with default headers values

func (*KillBackgroundExecUnauthorized) Code

Code gets the status code for the kill background exec unauthorized response

func (*KillBackgroundExecUnauthorized) Error

func (*KillBackgroundExecUnauthorized) GetPayload

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

func (*KillBackgroundExecUnauthorized) IsClientError

func (o *KillBackgroundExecUnauthorized) IsClientError() bool

IsClientError returns true when this kill background exec unauthorized response has a 4xx status code

func (*KillBackgroundExecUnauthorized) IsCode

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

IsCode returns true when this kill background exec unauthorized response a status code equal to that given

func (*KillBackgroundExecUnauthorized) IsRedirect

func (o *KillBackgroundExecUnauthorized) IsRedirect() bool

IsRedirect returns true when this kill background exec unauthorized response has a 3xx status code

func (*KillBackgroundExecUnauthorized) IsServerError

func (o *KillBackgroundExecUnauthorized) IsServerError() bool

IsServerError returns true when this kill background exec unauthorized response has a 5xx status code

func (*KillBackgroundExecUnauthorized) IsSuccess

func (o *KillBackgroundExecUnauthorized) IsSuccess() bool

IsSuccess returns true when this kill background exec unauthorized response has a 2xx status code

func (*KillBackgroundExecUnauthorized) String

Jump to

Keyboard shortcuts

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