resources

package
v1.8.8 Latest Latest
Warning

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

 Go to latest Published: Jan 27, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithContentTypeApplicationJSON 

func WithContentTypeApplicationJSON(r *runtime.ClientOperation)

WithContentTypeApplicationJSON sets the Content-Type header to "application/json".

func WithContentTypeTextPlain 

func WithContentTypeTextPlain(r *runtime.ClientOperation)

WithContentTypeTextPlain sets the Content-Type header to "text/plain".

Types

type Client 

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

Client for resources API

func (*Client) CreateResource 

func (a *Client) CreateResource(params *CreateResourceParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateResourceCreated, error)

CreateResource creates resources

Create one or more Kargo resources from YAML or JSON manifests.

func (*Client) DeleteResource 

func (a *Client) DeleteResource(params *DeleteResourceParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteResourceOK, error)
DeleteResource deletes resources

Delete one or more Kargo resources using namespaces and names

obtained from YAML or JSON manifests.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) UpdateResource 

func (a *Client) UpdateResource(params *UpdateResourceParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateResourceOK, error)

UpdateResource updates resources

Update (or optionally, upsert) one or more Kargo resources from

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

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

func WithContentType 

func WithContentType(mime string) ClientOption

WithContentType allows the client to force the Content-Type header to negotiate a specific Consumer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

type ClientService 

type ClientService interface {
	CreateResource(params *CreateResourceParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateResourceCreated, error)

	DeleteResource(params *DeleteResourceParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteResourceOK, error)

	UpdateResource(params *UpdateResourceParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateResourceOK, 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 resources API client.

func NewClientWithBasicAuth 

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

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

type CreateResourceCreated struct {
	Payload *models.CreateResourceResponse
}

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

Created successfully

func NewCreateResourceCreated 

func NewCreateResourceCreated() *CreateResourceCreated

NewCreateResourceCreated creates a CreateResourceCreated with default headers values

func (*CreateResourceCreated) Code 

func (o *CreateResourceCreated) Code() int

Code gets the status code for the create resource created response

func (*CreateResourceCreated) Error 

func (o *CreateResourceCreated) Error() string

func (*CreateResourceCreated) GetPayload 

func (o *CreateResourceCreated) GetPayload() *models.CreateResourceResponse

func (*CreateResourceCreated) IsClientError 

func (o *CreateResourceCreated) IsClientError() bool

IsClientError returns true when this create resource created response has a 4xx status code

func (*CreateResourceCreated) IsCode 

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

IsCode returns true when this create resource created response a status code equal to that given

func (*CreateResourceCreated) IsRedirect 

func (o *CreateResourceCreated) IsRedirect() bool

IsRedirect returns true when this create resource created response has a 3xx status code

func (*CreateResourceCreated) IsServerError 

func (o *CreateResourceCreated) IsServerError() bool

IsServerError returns true when this create resource created response has a 5xx status code

func (*CreateResourceCreated) IsSuccess 

func (o *CreateResourceCreated) IsSuccess() bool

IsSuccess returns true when this create resource created response has a 2xx status code

func (*CreateResourceCreated) String 

func (o *CreateResourceCreated) String() string

type CreateResourceParams 

type CreateResourceParams struct {

	/* Manifest.

	   YAML or JSON manifest(s)
	*/
	Manifest string

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

CreateResourceParams contains all the parameters to send to the API endpoint 

for the create resource operation.

Typically these are written to a http.Request.

func NewCreateResourceParams 

func NewCreateResourceParams() *CreateResourceParams

NewCreateResourceParams creates a new CreateResourceParams 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 NewCreateResourceParamsWithContext 

func NewCreateResourceParamsWithContext(ctx context.Context) *CreateResourceParams

NewCreateResourceParamsWithContext creates a new CreateResourceParams object with the ability to set a context for a request.

func NewCreateResourceParamsWithHTTPClient 

func NewCreateResourceParamsWithHTTPClient(client *http.Client) *CreateResourceParams

NewCreateResourceParamsWithHTTPClient creates a new CreateResourceParams object with the ability to set a custom HTTPClient for a request.

func NewCreateResourceParamsWithTimeout 

func NewCreateResourceParamsWithTimeout(timeout time.Duration) *CreateResourceParams

NewCreateResourceParamsWithTimeout creates a new CreateResourceParams object with the ability to set a timeout on a request.

func (*CreateResourceParams) SetContext 

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

SetContext adds the context to the create resource params

func (*CreateResourceParams) SetDefaults 

func (o *CreateResourceParams) SetDefaults()

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

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

func (*CreateResourceParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the create resource params

func (*CreateResourceParams) SetManifest 

func (o *CreateResourceParams) SetManifest(manifest string)

SetManifest adds the manifest to the create resource params

func (*CreateResourceParams) SetTimeout 

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

SetTimeout adds the timeout to the create resource params

func (*CreateResourceParams) WithContext 

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

WithContext adds the context to the create resource params

func (*CreateResourceParams) WithDefaults 

func (o *CreateResourceParams) WithDefaults() *CreateResourceParams

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

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

func (*CreateResourceParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the create resource params

func (*CreateResourceParams) WithManifest 

func (o *CreateResourceParams) WithManifest(manifest string) *CreateResourceParams

WithManifest adds the manifest to the create resource params

func (*CreateResourceParams) WithTimeout 

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

WithTimeout adds the timeout to the create resource params

func (*CreateResourceParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type CreateResourceReader 

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

CreateResourceReader is a Reader for the CreateResource structure.

func (*CreateResourceReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DeleteResourceOK 

type DeleteResourceOK struct {
	Payload *models.DeleteResourceResponse
}

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

OK

func NewDeleteResourceOK 

func NewDeleteResourceOK() *DeleteResourceOK

NewDeleteResourceOK creates a DeleteResourceOK with default headers values

func (*DeleteResourceOK) Code 

func (o *DeleteResourceOK) Code() int

Code gets the status code for the delete resource o k response

func (*DeleteResourceOK) Error 

func (o *DeleteResourceOK) Error() string

func (*DeleteResourceOK) GetPayload 

func (o *DeleteResourceOK) GetPayload() *models.DeleteResourceResponse

func (*DeleteResourceOK) IsClientError 

func (o *DeleteResourceOK) IsClientError() bool

IsClientError returns true when this delete resource o k response has a 4xx status code

func (*DeleteResourceOK) IsCode 

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

IsCode returns true when this delete resource o k response a status code equal to that given

func (*DeleteResourceOK) IsRedirect 

func (o *DeleteResourceOK) IsRedirect() bool

IsRedirect returns true when this delete resource o k response has a 3xx status code

func (*DeleteResourceOK) IsServerError 

func (o *DeleteResourceOK) IsServerError() bool

IsServerError returns true when this delete resource o k response has a 5xx status code

func (*DeleteResourceOK) IsSuccess 

func (o *DeleteResourceOK) IsSuccess() bool

IsSuccess returns true when this delete resource o k response has a 2xx status code

func (*DeleteResourceOK) String 

func (o *DeleteResourceOK) String() string

type DeleteResourceParams 

type DeleteResourceParams struct {

	/* Manifest.

	   YAML or JSON manifest(s)
	*/
	Manifest string

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

DeleteResourceParams contains all the parameters to send to the API endpoint 

for the delete resource operation.

Typically these are written to a http.Request.

func NewDeleteResourceParams 

func NewDeleteResourceParams() *DeleteResourceParams

NewDeleteResourceParams creates a new DeleteResourceParams 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 NewDeleteResourceParamsWithContext 

func NewDeleteResourceParamsWithContext(ctx context.Context) *DeleteResourceParams

NewDeleteResourceParamsWithContext creates a new DeleteResourceParams object with the ability to set a context for a request.

func NewDeleteResourceParamsWithHTTPClient 

func NewDeleteResourceParamsWithHTTPClient(client *http.Client) *DeleteResourceParams

NewDeleteResourceParamsWithHTTPClient creates a new DeleteResourceParams object with the ability to set a custom HTTPClient for a request.

func NewDeleteResourceParamsWithTimeout 

func NewDeleteResourceParamsWithTimeout(timeout time.Duration) *DeleteResourceParams

NewDeleteResourceParamsWithTimeout creates a new DeleteResourceParams object with the ability to set a timeout on a request.

func (*DeleteResourceParams) SetContext 

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

SetContext adds the context to the delete resource params

func (*DeleteResourceParams) SetDefaults 

func (o *DeleteResourceParams) SetDefaults()

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

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

func (*DeleteResourceParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the delete resource params

func (*DeleteResourceParams) SetManifest 

func (o *DeleteResourceParams) SetManifest(manifest string)

SetManifest adds the manifest to the delete resource params

func (*DeleteResourceParams) SetTimeout 

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

SetTimeout adds the timeout to the delete resource params

func (*DeleteResourceParams) WithContext 

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

WithContext adds the context to the delete resource params

func (*DeleteResourceParams) WithDefaults 

func (o *DeleteResourceParams) WithDefaults() *DeleteResourceParams

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

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

func (*DeleteResourceParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the delete resource params

func (*DeleteResourceParams) WithManifest 

func (o *DeleteResourceParams) WithManifest(manifest string) *DeleteResourceParams

WithManifest adds the manifest to the delete resource params

func (*DeleteResourceParams) WithTimeout 

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

WithTimeout adds the timeout to the delete resource params

func (*DeleteResourceParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DeleteResourceReader 

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

DeleteResourceReader is a Reader for the DeleteResource structure.

func (*DeleteResourceReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type UpdateResourceOK 

type UpdateResourceOK struct {
	Payload *models.CreateOrUpdateResourceResponse
}

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

Update results

func NewUpdateResourceOK 

func NewUpdateResourceOK() *UpdateResourceOK

NewUpdateResourceOK creates a UpdateResourceOK with default headers values

func (*UpdateResourceOK) Code 

func (o *UpdateResourceOK) Code() int

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

func (*UpdateResourceOK) Error 

func (o *UpdateResourceOK) Error() string

func (*UpdateResourceOK) GetPayload 

func (o *UpdateResourceOK) GetPayload() *models.CreateOrUpdateResourceResponse

func (*UpdateResourceOK) IsClientError 

func (o *UpdateResourceOK) IsClientError() bool

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

func (*UpdateResourceOK) IsCode 

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

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

func (*UpdateResourceOK) IsRedirect 

func (o *UpdateResourceOK) IsRedirect() bool

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

func (*UpdateResourceOK) IsServerError 

func (o *UpdateResourceOK) IsServerError() bool

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

func (*UpdateResourceOK) IsSuccess 

func (o *UpdateResourceOK) IsSuccess() bool

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

func (*UpdateResourceOK) String 

func (o *UpdateResourceOK) String() string

type UpdateResourceParams 

type UpdateResourceParams struct {

	/* Manifest.

	   YAML or JSON manifest(s)
	*/
	Manifest string

	/* Upsert.

	   If true, create a resource if it does not exist
	*/
	Upsert *bool

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

UpdateResourceParams contains all the parameters to send to the API endpoint 

for the update resource operation.

Typically these are written to a http.Request.

func NewUpdateResourceParams 

func NewUpdateResourceParams() *UpdateResourceParams

NewUpdateResourceParams creates a new UpdateResourceParams 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 NewUpdateResourceParamsWithContext 

func NewUpdateResourceParamsWithContext(ctx context.Context) *UpdateResourceParams

NewUpdateResourceParamsWithContext creates a new UpdateResourceParams object with the ability to set a context for a request.

func NewUpdateResourceParamsWithHTTPClient 

func NewUpdateResourceParamsWithHTTPClient(client *http.Client) *UpdateResourceParams

NewUpdateResourceParamsWithHTTPClient creates a new UpdateResourceParams object with the ability to set a custom HTTPClient for a request.

func NewUpdateResourceParamsWithTimeout 

func NewUpdateResourceParamsWithTimeout(timeout time.Duration) *UpdateResourceParams

NewUpdateResourceParamsWithTimeout creates a new UpdateResourceParams object with the ability to set a timeout on a request.

func (*UpdateResourceParams) SetContext 

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

SetContext adds the context to the update resource params

func (*UpdateResourceParams) SetDefaults 

func (o *UpdateResourceParams) SetDefaults()

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

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

func (*UpdateResourceParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the update resource params

func (*UpdateResourceParams) SetManifest 

func (o *UpdateResourceParams) SetManifest(manifest string)

SetManifest adds the manifest to the update resource params

func (*UpdateResourceParams) SetTimeout 

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

SetTimeout adds the timeout to the update resource params

func (*UpdateResourceParams) SetUpsert 

func (o *UpdateResourceParams) SetUpsert(upsert *bool)

SetUpsert adds the upsert to the update resource params

func (*UpdateResourceParams) WithContext 

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

WithContext adds the context to the update resource params

func (*UpdateResourceParams) WithDefaults 

func (o *UpdateResourceParams) WithDefaults() *UpdateResourceParams

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

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

func (*UpdateResourceParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the update resource params

func (*UpdateResourceParams) WithManifest 

func (o *UpdateResourceParams) WithManifest(manifest string) *UpdateResourceParams

WithManifest adds the manifest to the update resource params

func (*UpdateResourceParams) WithTimeout 

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

WithTimeout adds the timeout to the update resource params

func (*UpdateResourceParams) WithUpsert 

func (o *UpdateResourceParams) WithUpsert(upsert *bool) *UpdateResourceParams

WithUpsert adds the upsert to the update resource params

func (*UpdateResourceParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type UpdateResourceReader 

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

UpdateResourceReader is a Reader for the UpdateResource structure.

func (*UpdateResourceReader) ReadResponse 

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