client

package
v0.0.0-...-3febccf Latest Latest
Warning

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

Go to latest
Published: Sep 14, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildCreatePayload

func BuildCreatePayload(backupServiceCreateBody string) (*backupservice.Backup, error)

BuildCreatePayload builds the payload for the Backup Service create endpoint from CLI flags.

func BuildDeletePayload

func BuildDeletePayload(backupServiceDeleteID string) (*backupservice.DeletePayload, error)

BuildDeletePayload builds the payload for the Backup Service delete endpoint from CLI flags.

func BuildGetPayload

func BuildGetPayload(backupServiceGetID string) (*backupservice.GetPayload, error)

BuildGetPayload builds the payload for the Backup Service get endpoint from CLI flags.

func BuildUpdatePayload

func BuildUpdatePayload(backupServiceUpdateBody string) (*backupservice.Backupresult, error)

BuildUpdatePayload builds the payload for the Backup Service update endpoint from CLI flags.

func CreateBackupServicePath

func CreateBackupServicePath() string

CreateBackupServicePath returns the URL path to the Backup Service service create HTTP endpoint.

func DecodeCreateResponse

func DecodeCreateResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error)

DecodeCreateResponse returns a decoder for responses returned by the Backup Service create endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeDeleteResponse

func DecodeDeleteResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error)

DecodeDeleteResponse returns a decoder for responses returned by the Backup Service delete endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeDeleteResponse may return the following errors:

  • "backup_not_found" (type *backupservice.BackupNotFound): http.StatusNotFound
  • error: internal error

func DecodeGetResponse

func DecodeGetResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error)

DecodeGetResponse returns a decoder for responses returned by the Backup Service get endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetResponse may return the following errors:

  • "backup_not_found" (type *backupservice.BackupNotFound): http.StatusNotFound
  • error: internal error

func DecodeUpdateResponse

func DecodeUpdateResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error)

DecodeUpdateResponse returns a decoder for responses returned by the Backup Service update endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeUpdateResponse may return the following errors:

  • "backup_not_found" (type *backupservice.BackupNotFound): http.StatusNotFound
  • error: internal error

func DeleteBackupServicePath

func DeleteBackupServicePath(id string) string

DeleteBackupServicePath returns the URL path to the Backup Service service delete HTTP endpoint.

func EncodeCreateRequest

func EncodeCreateRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, interface{}) error

EncodeCreateRequest returns an encoder for requests sent to the Backup Service create server.

func EncodeUpdateRequest

func EncodeUpdateRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, interface{}) error

EncodeUpdateRequest returns an encoder for requests sent to the Backup Service update server.

func GetBackupServicePath

func GetBackupServicePath(id string) string

GetBackupServicePath returns the URL path to the Backup Service service get HTTP endpoint.

func NewCreateBackupresultAccepted

func NewCreateBackupresultAccepted(body *CreateResponseBody) *backupserviceviews.BackupresultView

NewCreateBackupresultAccepted builds a "Backup Service" service "create" endpoint result from a HTTP "Accepted" response.

func NewDeleteBackupNotFound

func NewDeleteBackupNotFound(body *DeleteBackupNotFoundResponseBody) *backupservice.BackupNotFound

NewDeleteBackupNotFound builds a Backup Service service delete endpoint backup_not_found error.

func NewDeleteBackupresultOK

func NewDeleteBackupresultOK(body *DeleteResponseBody) *backupserviceviews.BackupresultView

NewDeleteBackupresultOK builds a "Backup Service" service "delete" endpoint result from a HTTP "OK" response.

func NewGetBackupNotFound

func NewGetBackupNotFound(body *GetBackupNotFoundResponseBody) *backupservice.BackupNotFound

NewGetBackupNotFound builds a Backup Service service get endpoint backup_not_found error.

func NewGetBackupresultOK

func NewGetBackupresultOK(body *GetResponseBody) *backupserviceviews.BackupresultView

NewGetBackupresultOK builds a "Backup Service" service "get" endpoint result from a HTTP "OK" response.

func NewUpdateBackupNotFound

func NewUpdateBackupNotFound(body *UpdateBackupNotFoundResponseBody) *backupservice.BackupNotFound

NewUpdateBackupNotFound builds a Backup Service service update endpoint backup_not_found error.

func NewUpdateBackupresultOK

func NewUpdateBackupresultOK(body *UpdateResponseBody) *backupserviceviews.BackupresultView

NewUpdateBackupresultOK builds a "Backup Service" service "update" endpoint result from a HTTP "OK" response.

func UpdateBackupServicePath

func UpdateBackupServicePath() string

UpdateBackupServicePath returns the URL path to the Backup Service service update HTTP endpoint.

func ValidateDeleteBackupNotFoundResponseBody

func ValidateDeleteBackupNotFoundResponseBody(body *DeleteBackupNotFoundResponseBody) (err error)

ValidateDeleteBackupNotFoundResponseBody runs the validations defined on delete_backup_not_found_response_body

func ValidateGetBackupNotFoundResponseBody

func ValidateGetBackupNotFoundResponseBody(body *GetBackupNotFoundResponseBody) (err error)

ValidateGetBackupNotFoundResponseBody runs the validations defined on get_backup_not_found_response_body

func ValidateUpdateBackupNotFoundResponseBody

func ValidateUpdateBackupNotFoundResponseBody(body *UpdateBackupNotFoundResponseBody) (err error)

ValidateUpdateBackupNotFoundResponseBody runs the validations defined on update_backup_not_found_response_body

Types

type Client

type Client struct {
	// Create Doer is the HTTP client used to make requests to the create endpoint.
	CreateDoer goahttp.Doer

	// Get Doer is the HTTP client used to make requests to the get endpoint.
	GetDoer goahttp.Doer

	// Update Doer is the HTTP client used to make requests to the update endpoint.
	UpdateDoer goahttp.Doer

	// Delete Doer is the HTTP client used to make requests to the delete endpoint.
	DeleteDoer goahttp.Doer

	// RestoreResponseBody controls whether the response bodies are reset after
	// decoding so they can be read again.
	RestoreResponseBody bool
	// contains filtered or unexported fields
}

Client lists the Backup Service service endpoint HTTP clients.

func NewClient

func NewClient(
	scheme string,
	host string,
	doer goahttp.Doer,
	enc func(*http.Request) goahttp.Encoder,
	dec func(*http.Response) goahttp.Decoder,
	restoreBody bool,
) *Client

NewClient instantiates HTTP clients for all the Backup Service service servers.

func (*Client) BuildCreateRequest

func (c *Client) BuildCreateRequest(ctx context.Context, v interface{}) (*http.Request, error)

BuildCreateRequest instantiates a HTTP request object with method and path set to call the "Backup Service" service "create" endpoint

func (*Client) BuildDeleteRequest

func (c *Client) BuildDeleteRequest(ctx context.Context, v interface{}) (*http.Request, error)

BuildDeleteRequest instantiates a HTTP request object with method and path set to call the "Backup Service" service "delete" endpoint

func (*Client) BuildGetRequest

func (c *Client) BuildGetRequest(ctx context.Context, v interface{}) (*http.Request, error)

BuildGetRequest instantiates a HTTP request object with method and path set to call the "Backup Service" service "get" endpoint

func (*Client) BuildUpdateRequest

func (c *Client) BuildUpdateRequest(ctx context.Context, v interface{}) (*http.Request, error)

BuildUpdateRequest instantiates a HTTP request object with method and path set to call the "Backup Service" service "update" endpoint

func (*Client) Create

func (c *Client) Create() goa.Endpoint

Create returns an endpoint that makes HTTP requests to the Backup Service service create server.

func (*Client) Delete

func (c *Client) Delete() goa.Endpoint

Delete returns an endpoint that makes HTTP requests to the Backup Service service delete server.

func (*Client) Get

func (c *Client) Get() goa.Endpoint

Get returns an endpoint that makes HTTP requests to the Backup Service service get server.

func (*Client) Update

func (c *Client) Update() goa.Endpoint

Update returns an endpoint that makes HTTP requests to the Backup Service service update server.

type CreateRequestBody

type CreateRequestBody struct {
	// Name of pachyderm instance backed up
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Namespace of resource backed up
	Namespace *string `form:"namespace,omitempty" json:"namespace,omitempty" xml:"namespace,omitempty"`
	// Name of target pod
	Pod *string `form:"pod,omitempty" json:"pod,omitempty" xml:"pod,omitempty"`
	// Name of container in pod
	Container *string `form:"container,omitempty" json:"container,omitempty" xml:"container,omitempty"`
	// base64 encoded command to run in pod
	Command *string `form:"command,omitempty" json:"command,omitempty" xml:"command,omitempty"`
	// Kubernetes secret containing S3 storage credentials
	StorageSecret *string `form:"storage_secret,omitempty" json:"storage_secret,omitempty" xml:"storage_secret,omitempty"`
	// base64 encoded json representation of object
	KubernetesResource *string `form:"kubernetes_resource,omitempty" json:"kubernetes_resource,omitempty" xml:"kubernetes_resource,omitempty"`
}

CreateRequestBody is the type of the "Backup Service" service "create" endpoint HTTP request body.

func NewCreateRequestBody

func NewCreateRequestBody(p *backupservice.Backup) *CreateRequestBody

NewCreateRequestBody builds the HTTP request body from the payload of the "create" endpoint of the "Backup Service" service.

type CreateResponseBody

type CreateResponseBody struct {
	CreatedAt *string `form:"created_at,omitempty" json:"created_at,omitempty" xml:"created_at,omitempty"`
	UpdatedAt *string `form:"updated_at,omitempty" json:"updated_at,omitempty" xml:"updated_at,omitempty"`
	DeletedAt *string `form:"deleted_at,omitempty" json:"deleted_at,omitempty" xml:"deleted_at,omitempty"`
	ID        *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Current state of the job
	State *string `form:"state,omitempty" json:"state,omitempty" xml:"state,omitempty"`
	// Name of pachyderm instance backed up
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Namespace of resource backed up
	Namespace *string `form:"namespace,omitempty" json:"namespace,omitempty" xml:"namespace,omitempty"`
	// Name of target pod
	Pod *string `form:"pod,omitempty" json:"pod,omitempty" xml:"pod,omitempty"`
	// Name of container in pod
	Container *string `form:"container,omitempty" json:"container,omitempty" xml:"container,omitempty"`
	// base64 encoded command to run in pod
	Command *string `form:"command,omitempty" json:"command,omitempty" xml:"command,omitempty"`
	// Kubernetes secret containing S3 storage credentials
	StorageSecret *string `form:"storage_secret,omitempty" json:"storage_secret,omitempty" xml:"storage_secret,omitempty"`
	// base64 encoded json representation of object
	KubernetesResource *string `form:"kubernetes_resource,omitempty" json:"kubernetes_resource,omitempty" xml:"kubernetes_resource,omitempty"`
	// URL of the uploaded backup tarball
	Location *string `form:"location,omitempty" json:"location,omitempty" xml:"location,omitempty"`
}

CreateResponseBody is the type of the "Backup Service" service "create" endpoint HTTP response body.

type DeleteBackupNotFoundResponseBody

type DeleteBackupNotFoundResponseBody struct {
	// backup resource not found
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

DeleteBackupNotFoundResponseBody is the type of the "Backup Service" service "delete" endpoint HTTP response body for the "backup_not_found" error.

type DeleteResponseBody

type DeleteResponseBody struct {
	CreatedAt *string `form:"created_at,omitempty" json:"created_at,omitempty" xml:"created_at,omitempty"`
	UpdatedAt *string `form:"updated_at,omitempty" json:"updated_at,omitempty" xml:"updated_at,omitempty"`
	DeletedAt *string `form:"deleted_at,omitempty" json:"deleted_at,omitempty" xml:"deleted_at,omitempty"`
	ID        *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Current state of the job
	State *string `form:"state,omitempty" json:"state,omitempty" xml:"state,omitempty"`
	// Name of pachyderm instance backed up
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Namespace of resource backed up
	Namespace *string `form:"namespace,omitempty" json:"namespace,omitempty" xml:"namespace,omitempty"`
	// Name of target pod
	Pod *string `form:"pod,omitempty" json:"pod,omitempty" xml:"pod,omitempty"`
	// Name of container in pod
	Container *string `form:"container,omitempty" json:"container,omitempty" xml:"container,omitempty"`
	// base64 encoded command to run in pod
	Command *string `form:"command,omitempty" json:"command,omitempty" xml:"command,omitempty"`
	// Kubernetes secret containing S3 storage credentials
	StorageSecret *string `form:"storage_secret,omitempty" json:"storage_secret,omitempty" xml:"storage_secret,omitempty"`
	// base64 encoded json representation of object
	KubernetesResource *string `form:"kubernetes_resource,omitempty" json:"kubernetes_resource,omitempty" xml:"kubernetes_resource,omitempty"`
	// URL of the uploaded backup tarball
	Location *string `form:"location,omitempty" json:"location,omitempty" xml:"location,omitempty"`
}

DeleteResponseBody is the type of the "Backup Service" service "delete" endpoint HTTP response body.

type GetBackupNotFoundResponseBody

type GetBackupNotFoundResponseBody struct {
	// backup resource not found
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

GetBackupNotFoundResponseBody is the type of the "Backup Service" service "get" endpoint HTTP response body for the "backup_not_found" error.

type GetResponseBody

type GetResponseBody struct {
	CreatedAt *string `form:"created_at,omitempty" json:"created_at,omitempty" xml:"created_at,omitempty"`
	UpdatedAt *string `form:"updated_at,omitempty" json:"updated_at,omitempty" xml:"updated_at,omitempty"`
	DeletedAt *string `form:"deleted_at,omitempty" json:"deleted_at,omitempty" xml:"deleted_at,omitempty"`
	ID        *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Current state of the job
	State *string `form:"state,omitempty" json:"state,omitempty" xml:"state,omitempty"`
	// Name of pachyderm instance backed up
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Namespace of resource backed up
	Namespace *string `form:"namespace,omitempty" json:"namespace,omitempty" xml:"namespace,omitempty"`
	// Name of target pod
	Pod *string `form:"pod,omitempty" json:"pod,omitempty" xml:"pod,omitempty"`
	// Name of container in pod
	Container *string `form:"container,omitempty" json:"container,omitempty" xml:"container,omitempty"`
	// base64 encoded command to run in pod
	Command *string `form:"command,omitempty" json:"command,omitempty" xml:"command,omitempty"`
	// Kubernetes secret containing S3 storage credentials
	StorageSecret *string `form:"storage_secret,omitempty" json:"storage_secret,omitempty" xml:"storage_secret,omitempty"`
	// base64 encoded json representation of object
	KubernetesResource *string `form:"kubernetes_resource,omitempty" json:"kubernetes_resource,omitempty" xml:"kubernetes_resource,omitempty"`
	// URL of the uploaded backup tarball
	Location *string `form:"location,omitempty" json:"location,omitempty" xml:"location,omitempty"`
}

GetResponseBody is the type of the "Backup Service" service "get" endpoint HTTP response body.

type UpdateBackupNotFoundResponseBody

type UpdateBackupNotFoundResponseBody struct {
	// backup resource not found
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

UpdateBackupNotFoundResponseBody is the type of the "Backup Service" service "update" endpoint HTTP response body for the "backup_not_found" error.

type UpdateRequestBody

type UpdateRequestBody struct {
	CreatedAt *string `form:"created_at,omitempty" json:"created_at,omitempty" xml:"created_at,omitempty"`
	UpdatedAt *string `form:"updated_at,omitempty" json:"updated_at,omitempty" xml:"updated_at,omitempty"`
	DeletedAt *string `form:"deleted_at,omitempty" json:"deleted_at,omitempty" xml:"deleted_at,omitempty"`
	ID        *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Current state of the job
	State *string `form:"state,omitempty" json:"state,omitempty" xml:"state,omitempty"`
	// Name of pachyderm instance backed up
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Namespace of resource backed up
	Namespace *string `form:"namespace,omitempty" json:"namespace,omitempty" xml:"namespace,omitempty"`
	// Name of target pod
	Pod *string `form:"pod,omitempty" json:"pod,omitempty" xml:"pod,omitempty"`
	// Name of container in pod
	Container *string `form:"container,omitempty" json:"container,omitempty" xml:"container,omitempty"`
	// base64 encoded command to run in pod
	Command *string `form:"command,omitempty" json:"command,omitempty" xml:"command,omitempty"`
	// Kubernetes secret containing S3 storage credentials
	StorageSecret *string `form:"storage_secret,omitempty" json:"storage_secret,omitempty" xml:"storage_secret,omitempty"`
	// base64 encoded json representation of object
	KubernetesResource *string `form:"kubernetes_resource,omitempty" json:"kubernetes_resource,omitempty" xml:"kubernetes_resource,omitempty"`
	// URL of the uploaded backup tarball
	Location *string `form:"location,omitempty" json:"location,omitempty" xml:"location,omitempty"`
}

UpdateRequestBody is the type of the "Backup Service" service "update" endpoint HTTP request body.

func NewUpdateRequestBody

func NewUpdateRequestBody(p *backupservice.Backupresult) *UpdateRequestBody

NewUpdateRequestBody builds the HTTP request body from the payload of the "update" endpoint of the "Backup Service" service.

type UpdateResponseBody

type UpdateResponseBody struct {
	CreatedAt *string `form:"created_at,omitempty" json:"created_at,omitempty" xml:"created_at,omitempty"`
	UpdatedAt *string `form:"updated_at,omitempty" json:"updated_at,omitempty" xml:"updated_at,omitempty"`
	DeletedAt *string `form:"deleted_at,omitempty" json:"deleted_at,omitempty" xml:"deleted_at,omitempty"`
	ID        *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Current state of the job
	State *string `form:"state,omitempty" json:"state,omitempty" xml:"state,omitempty"`
	// Name of pachyderm instance backed up
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Namespace of resource backed up
	Namespace *string `form:"namespace,omitempty" json:"namespace,omitempty" xml:"namespace,omitempty"`
	// Name of target pod
	Pod *string `form:"pod,omitempty" json:"pod,omitempty" xml:"pod,omitempty"`
	// Name of container in pod
	Container *string `form:"container,omitempty" json:"container,omitempty" xml:"container,omitempty"`
	// base64 encoded command to run in pod
	Command *string `form:"command,omitempty" json:"command,omitempty" xml:"command,omitempty"`
	// Kubernetes secret containing S3 storage credentials
	StorageSecret *string `form:"storage_secret,omitempty" json:"storage_secret,omitempty" xml:"storage_secret,omitempty"`
	// base64 encoded json representation of object
	KubernetesResource *string `form:"kubernetes_resource,omitempty" json:"kubernetes_resource,omitempty" xml:"kubernetes_resource,omitempty"`
	// URL of the uploaded backup tarball
	Location *string `form:"location,omitempty" json:"location,omitempty" xml:"location,omitempty"`
}

UpdateResponseBody is the type of the "Backup Service" service "update" endpoint HTTP response body.

Jump to

Keyboard shortcuts

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