client

package
v0.43.0 Latest Latest
Warning

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

Go to latest
Published: Dec 4, 2024 License: Apache-2.0 Imports: 13 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildCreateServicePayload

func BuildCreateServicePayload(serviceCreateServiceBody string, serviceCreateServiceJWT string) (*service.CreateServicePayload, error)

BuildCreateServicePayload builds the payload for the service create_service endpoint from CLI flags.

func BuildDeletePayload

func BuildDeletePayload(serviceDeleteID string, serviceDeleteJWT string) (*service.DeletePayload, error)

BuildDeletePayload builds the payload for the service delete endpoint from CLI flags.

func BuildListPayload

func BuildListPayload(serviceListLimit string, serviceListPage string, serviceListFilter string, serviceListOrderBy string, serviceListOrderDesc string, serviceListAtTime string, serviceListJWT string) (*service.ListPayload, error)

BuildListPayload builds the payload for the service list endpoint from CLI flags.

func BuildReadPayload

func BuildReadPayload(serviceReadID string, serviceReadJWT string) (*service.ReadPayload, error)

BuildReadPayload builds the payload for the service read endpoint from CLI flags.

func BuildUpdatePayload

func BuildUpdatePayload(serviceUpdateBody string, serviceUpdateID string, serviceUpdateForceCreate string, serviceUpdateJWT string) (*service.UpdatePayload, error)

BuildUpdatePayload builds the payload for the service update endpoint from CLI flags.

func CreateServiceServicePath

func CreateServiceServicePath() string

CreateServiceServicePath returns the URL path to the service service create_service HTTP endpoint.

func DecodeCreateServiceResponse

func DecodeCreateServiceResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeCreateServiceResponse returns a decoder for responses returned by the service create_service endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeCreateServiceResponse may return the following errors:

  • "bad-request" (type *service.BadRequestT): http.StatusBadRequest
  • "invalid-parameter" (type *service.InvalidParameterT): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *service.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *service.NotImplementedT): http.StatusNotImplemented
  • "already-created" (type *service.ResourceAlreadyCreatedT): http.StatusConflict
  • "not-found" (type *service.ResourceNotFoundT): http.StatusNotFound
  • "not-available" (type *service.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *service.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeDeleteResponse

func DecodeDeleteResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

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

  • "bad-request" (type *service.BadRequestT): http.StatusBadRequest
  • "invalid-scopes" (type *service.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *service.NotImplementedT): http.StatusNotImplemented
  • "not-available" (type *service.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *service.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeListResponse

func DecodeListResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListResponse returns a decoder for responses returned by the service list endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeListResponse may return the following errors:

  • "bad-request" (type *service.BadRequestT): http.StatusBadRequest
  • "invalid-parameter" (type *service.InvalidParameterT): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *service.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *service.NotImplementedT): http.StatusNotImplemented
  • "not-available" (type *service.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *service.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeReadResponse

func DecodeReadResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

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

  • "bad-request" (type *service.BadRequestT): http.StatusBadRequest
  • "invalid-scopes" (type *service.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *service.NotImplementedT): http.StatusNotImplemented
  • "not-found" (type *service.ResourceNotFoundT): http.StatusNotFound
  • "not-available" (type *service.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *service.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeUpdateResponse

func DecodeUpdateResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

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

  • "bad-request" (type *service.BadRequestT): http.StatusBadRequest
  • "invalid-parameter" (type *service.InvalidParameterT): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *service.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *service.NotImplementedT): http.StatusNotImplemented
  • "not-found" (type *service.ResourceNotFoundT): http.StatusNotFound
  • "not-available" (type *service.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *service.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DeleteServicePath

func DeleteServicePath(id string) string

DeleteServicePath returns the URL path to the service service delete HTTP endpoint.

func EncodeCreateServiceRequest

func EncodeCreateServiceRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeCreateServiceRequest returns an encoder for requests sent to the service create_service server.

func EncodeDeleteRequest

func EncodeDeleteRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeDeleteRequest returns an encoder for requests sent to the service delete server.

func EncodeListRequest

func EncodeListRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListRequest returns an encoder for requests sent to the service list server.

func EncodeReadRequest

func EncodeReadRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeReadRequest returns an encoder for requests sent to the service read server.

func EncodeUpdateRequest

func EncodeUpdateRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

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

func ListServicePath

func ListServicePath() string

ListServicePath returns the URL path to the service service list HTTP endpoint.

func NewCreateServiceAlreadyCreated

func NewCreateServiceAlreadyCreated(body *CreateServiceAlreadyCreatedResponseBody) *service.ResourceAlreadyCreatedT

NewCreateServiceAlreadyCreated builds a service service create_service endpoint already-created error.

func NewCreateServiceBadRequest

func NewCreateServiceBadRequest(body *CreateServiceBadRequestResponseBody) *service.BadRequestT

NewCreateServiceBadRequest builds a service service create_service endpoint bad-request error.

func NewCreateServiceInvalidParameter

func NewCreateServiceInvalidParameter(body *CreateServiceInvalidParameterResponseBody) *service.InvalidParameterT

NewCreateServiceInvalidParameter builds a service service create_service endpoint invalid-parameter error.

func NewCreateServiceInvalidScopes

func NewCreateServiceInvalidScopes(body *CreateServiceInvalidScopesResponseBody) *service.InvalidScopesT

NewCreateServiceInvalidScopes builds a service service create_service endpoint invalid-scopes error.

func NewCreateServiceNotAuthorized

func NewCreateServiceNotAuthorized() *service.UnauthorizedT

NewCreateServiceNotAuthorized builds a service service create_service endpoint not-authorized error.

func NewCreateServiceNotAvailable added in v0.39.0

func NewCreateServiceNotAvailable() *service.ServiceNotAvailableT

NewCreateServiceNotAvailable builds a service service create_service endpoint not-available error.

func NewCreateServiceNotFound

func NewCreateServiceNotFound(body *CreateServiceNotFoundResponseBody) *service.ResourceNotFoundT

NewCreateServiceNotFound builds a service service create_service endpoint not-found error.

func NewCreateServiceNotImplemented

func NewCreateServiceNotImplemented(body *CreateServiceNotImplementedResponseBody) *service.NotImplementedT

NewCreateServiceNotImplemented builds a service service create_service endpoint not-implemented error.

func NewCreateServiceServiceStatusRTCreated

func NewCreateServiceServiceStatusRTCreated(body *CreateServiceResponseBody) *service.ServiceStatusRT

NewCreateServiceServiceStatusRTCreated builds a "service" service "create_service" endpoint result from a HTTP "Created" response.

func NewDeleteBadRequest

func NewDeleteBadRequest(body *DeleteBadRequestResponseBody) *service.BadRequestT

NewDeleteBadRequest builds a service service delete endpoint bad-request error.

func NewDeleteInvalidScopes

func NewDeleteInvalidScopes(body *DeleteInvalidScopesResponseBody) *service.InvalidScopesT

NewDeleteInvalidScopes builds a service service delete endpoint invalid-scopes error.

func NewDeleteNotAuthorized

func NewDeleteNotAuthorized() *service.UnauthorizedT

NewDeleteNotAuthorized builds a service service delete endpoint not-authorized error.

func NewDeleteNotAvailable added in v0.39.0

func NewDeleteNotAvailable() *service.ServiceNotAvailableT

NewDeleteNotAvailable builds a service service delete endpoint not-available error.

func NewDeleteNotImplemented

func NewDeleteNotImplemented(body *DeleteNotImplementedResponseBody) *service.NotImplementedT

NewDeleteNotImplemented builds a service service delete endpoint not-implemented error.

func NewListBadRequest

func NewListBadRequest(body *ListBadRequestResponseBody) *service.BadRequestT

NewListBadRequest builds a service service list endpoint bad-request error.

func NewListInvalidParameter

func NewListInvalidParameter(body *ListInvalidParameterResponseBody) *service.InvalidParameterT

NewListInvalidParameter builds a service service list endpoint invalid-parameter error.

func NewListInvalidScopes

func NewListInvalidScopes(body *ListInvalidScopesResponseBody) *service.InvalidScopesT

NewListInvalidScopes builds a service service list endpoint invalid-scopes error.

func NewListNotAuthorized

func NewListNotAuthorized() *service.UnauthorizedT

NewListNotAuthorized builds a service service list endpoint not-authorized error.

func NewListNotAvailable added in v0.39.0

func NewListNotAvailable() *service.ServiceNotAvailableT

NewListNotAvailable builds a service service list endpoint not-available error.

func NewListNotImplemented

func NewListNotImplemented(body *ListNotImplementedResponseBody) *service.NotImplementedT

NewListNotImplemented builds a service service list endpoint not-implemented error.

func NewListServiceListRTOK

func NewListServiceListRTOK(body *ListResponseBody) *serviceviews.ServiceListRTView

NewListServiceListRTOK builds a "service" service "list" endpoint result from a HTTP "OK" response.

func NewReadBadRequest

func NewReadBadRequest(body *ReadBadRequestResponseBody) *service.BadRequestT

NewReadBadRequest builds a service service read endpoint bad-request error.

func NewReadInvalidScopes

func NewReadInvalidScopes(body *ReadInvalidScopesResponseBody) *service.InvalidScopesT

NewReadInvalidScopes builds a service service read endpoint invalid-scopes error.

func NewReadNotAuthorized

func NewReadNotAuthorized() *service.UnauthorizedT

NewReadNotAuthorized builds a service service read endpoint not-authorized error.

func NewReadNotAvailable added in v0.39.0

func NewReadNotAvailable() *service.ServiceNotAvailableT

NewReadNotAvailable builds a service service read endpoint not-available error.

func NewReadNotFound

func NewReadNotFound(body *ReadNotFoundResponseBody) *service.ResourceNotFoundT

NewReadNotFound builds a service service read endpoint not-found error.

func NewReadNotImplemented

func NewReadNotImplemented(body *ReadNotImplementedResponseBody) *service.NotImplementedT

NewReadNotImplemented builds a service service read endpoint not-implemented error.

func NewReadServiceStatusRTCreated added in v0.42.1

func NewReadServiceStatusRTCreated(body *ReadResponseBody) *service.ServiceStatusRT

NewReadServiceStatusRTCreated builds a "service" service "read" endpoint result from a HTTP "Created" response.

func NewUpdateBadRequest

func NewUpdateBadRequest(body *UpdateBadRequestResponseBody) *service.BadRequestT

NewUpdateBadRequest builds a service service update endpoint bad-request error.

func NewUpdateInvalidParameter

func NewUpdateInvalidParameter(body *UpdateInvalidParameterResponseBody) *service.InvalidParameterT

NewUpdateInvalidParameter builds a service service update endpoint invalid-parameter error.

func NewUpdateInvalidScopes

func NewUpdateInvalidScopes(body *UpdateInvalidScopesResponseBody) *service.InvalidScopesT

NewUpdateInvalidScopes builds a service service update endpoint invalid-scopes error.

func NewUpdateNotAuthorized

func NewUpdateNotAuthorized() *service.UnauthorizedT

NewUpdateNotAuthorized builds a service service update endpoint not-authorized error.

func NewUpdateNotAvailable added in v0.39.0

func NewUpdateNotAvailable() *service.ServiceNotAvailableT

NewUpdateNotAvailable builds a service service update endpoint not-available error.

func NewUpdateNotFound

func NewUpdateNotFound(body *UpdateNotFoundResponseBody) *service.ResourceNotFoundT

NewUpdateNotFound builds a service service update endpoint not-found error.

func NewUpdateNotImplemented

func NewUpdateNotImplemented(body *UpdateNotImplementedResponseBody) *service.NotImplementedT

NewUpdateNotImplemented builds a service service update endpoint not-implemented error.

func NewUpdateServiceStatusRTOK

func NewUpdateServiceStatusRTOK(body *UpdateResponseBody) *service.ServiceStatusRT

NewUpdateServiceStatusRTOK builds a "service" service "update" endpoint result from a HTTP "OK" response.

func ReadServicePath

func ReadServicePath(id string) string

ReadServicePath returns the URL path to the service service read HTTP endpoint.

func UpdateServicePath

func UpdateServicePath(id string) string

UpdateServicePath returns the URL path to the service service update HTTP endpoint.

func ValidateBasicWorkflowOptsTRequestBodyRequestBody

func ValidateBasicWorkflowOptsTRequestBodyRequestBody(body *BasicWorkflowOptsTRequestBodyRequestBody) (err error)

ValidateBasicWorkflowOptsTRequestBodyRequestBody runs the validations defined on BasicWorkflowOptsTRequestBodyRequestBody

func ValidateCreateServiceAlreadyCreatedResponseBody

func ValidateCreateServiceAlreadyCreatedResponseBody(body *CreateServiceAlreadyCreatedResponseBody) (err error)

ValidateCreateServiceAlreadyCreatedResponseBody runs the validations defined on create_service_already-created_response_body

func ValidateCreateServiceBadRequestResponseBody

func ValidateCreateServiceBadRequestResponseBody(body *CreateServiceBadRequestResponseBody) (err error)

ValidateCreateServiceBadRequestResponseBody runs the validations defined on create_service_bad-request_response_body

func ValidateCreateServiceInvalidParameterResponseBody

func ValidateCreateServiceInvalidParameterResponseBody(body *CreateServiceInvalidParameterResponseBody) (err error)

ValidateCreateServiceInvalidParameterResponseBody runs the validations defined on create_service_invalid-parameter_response_body

func ValidateCreateServiceInvalidScopesResponseBody

func ValidateCreateServiceInvalidScopesResponseBody(body *CreateServiceInvalidScopesResponseBody) (err error)

ValidateCreateServiceInvalidScopesResponseBody runs the validations defined on create_service_invalid-scopes_response_body

func ValidateCreateServiceNotFoundResponseBody

func ValidateCreateServiceNotFoundResponseBody(body *CreateServiceNotFoundResponseBody) (err error)

ValidateCreateServiceNotFoundResponseBody runs the validations defined on create_service_not-found_response_body

func ValidateCreateServiceNotImplementedResponseBody

func ValidateCreateServiceNotImplementedResponseBody(body *CreateServiceNotImplementedResponseBody) (err error)

ValidateCreateServiceNotImplementedResponseBody runs the validations defined on create_service_not-implemented_response_body

func ValidateCreateServiceResponseBody added in v0.30.0

func ValidateCreateServiceResponseBody(body *CreateServiceResponseBody) (err error)

ValidateCreateServiceResponseBody runs the validations defined on create_service_response_body

func ValidateDeleteBadRequestResponseBody

func ValidateDeleteBadRequestResponseBody(body *DeleteBadRequestResponseBody) (err error)

ValidateDeleteBadRequestResponseBody runs the validations defined on delete_bad-request_response_body

func ValidateDeleteInvalidScopesResponseBody

func ValidateDeleteInvalidScopesResponseBody(body *DeleteInvalidScopesResponseBody) (err error)

ValidateDeleteInvalidScopesResponseBody runs the validations defined on delete_invalid-scopes_response_body

func ValidateDeleteNotImplementedResponseBody

func ValidateDeleteNotImplementedResponseBody(body *DeleteNotImplementedResponseBody) (err error)

ValidateDeleteNotImplementedResponseBody runs the validations defined on delete_not-implemented_response_body

func ValidateLinkTResponseBody added in v0.30.0

func ValidateLinkTResponseBody(body *LinkTResponseBody) (err error)

ValidateLinkTResponseBody runs the validations defined on LinkTResponseBody

func ValidateListBadRequestResponseBody

func ValidateListBadRequestResponseBody(body *ListBadRequestResponseBody) (err error)

ValidateListBadRequestResponseBody runs the validations defined on list_bad-request_response_body

func ValidateListInvalidParameterResponseBody

func ValidateListInvalidParameterResponseBody(body *ListInvalidParameterResponseBody) (err error)

ValidateListInvalidParameterResponseBody runs the validations defined on list_invalid-parameter_response_body

func ValidateListInvalidScopesResponseBody

func ValidateListInvalidScopesResponseBody(body *ListInvalidScopesResponseBody) (err error)

ValidateListInvalidScopesResponseBody runs the validations defined on list_invalid-scopes_response_body

func ValidateListNotImplementedResponseBody

func ValidateListNotImplementedResponseBody(body *ListNotImplementedResponseBody) (err error)

ValidateListNotImplementedResponseBody runs the validations defined on list_not-implemented_response_body

func ValidateParameterDefTResponseBody added in v0.40.1

func ValidateParameterDefTResponseBody(body *ParameterDefTResponseBody) (err error)

ValidateParameterDefTResponseBody runs the validations defined on ParameterDefTResponseBody

func ValidateReadBadRequestResponseBody

func ValidateReadBadRequestResponseBody(body *ReadBadRequestResponseBody) (err error)

ValidateReadBadRequestResponseBody runs the validations defined on read_bad-request_response_body

func ValidateReadInvalidScopesResponseBody

func ValidateReadInvalidScopesResponseBody(body *ReadInvalidScopesResponseBody) (err error)

ValidateReadInvalidScopesResponseBody runs the validations defined on read_invalid-scopes_response_body

func ValidateReadNotFoundResponseBody

func ValidateReadNotFoundResponseBody(body *ReadNotFoundResponseBody) (err error)

ValidateReadNotFoundResponseBody runs the validations defined on read_not-found_response_body

func ValidateReadNotImplementedResponseBody

func ValidateReadNotImplementedResponseBody(body *ReadNotImplementedResponseBody) (err error)

ValidateReadNotImplementedResponseBody runs the validations defined on read_not-implemented_response_body

func ValidateReadResponseBody added in v0.30.0

func ValidateReadResponseBody(body *ReadResponseBody) (err error)

ValidateReadResponseBody runs the validations defined on ReadResponseBody

func ValidateReferenceTRequestBodyRequestBody

func ValidateReferenceTRequestBodyRequestBody(body *ReferenceTRequestBodyRequestBody) (err error)

ValidateReferenceTRequestBodyRequestBody runs the validations defined on ReferenceTRequestBodyRequestBody

func ValidateServiceListItemResponseBody

func ValidateServiceListItemResponseBody(body *ServiceListItemResponseBody) (err error)

ValidateServiceListItemResponseBody runs the validations defined on ServiceListItemResponseBody

func ValidateUpdateBadRequestResponseBody

func ValidateUpdateBadRequestResponseBody(body *UpdateBadRequestResponseBody) (err error)

ValidateUpdateBadRequestResponseBody runs the validations defined on update_bad-request_response_body

func ValidateUpdateInvalidParameterResponseBody

func ValidateUpdateInvalidParameterResponseBody(body *UpdateInvalidParameterResponseBody) (err error)

ValidateUpdateInvalidParameterResponseBody runs the validations defined on update_invalid-parameter_response_body

func ValidateUpdateInvalidScopesResponseBody

func ValidateUpdateInvalidScopesResponseBody(body *UpdateInvalidScopesResponseBody) (err error)

ValidateUpdateInvalidScopesResponseBody runs the validations defined on update_invalid-scopes_response_body

func ValidateUpdateNotFoundResponseBody

func ValidateUpdateNotFoundResponseBody(body *UpdateNotFoundResponseBody) (err error)

ValidateUpdateNotFoundResponseBody runs the validations defined on update_not-found_response_body

func ValidateUpdateNotImplementedResponseBody

func ValidateUpdateNotImplementedResponseBody(body *UpdateNotImplementedResponseBody) (err error)

ValidateUpdateNotImplementedResponseBody runs the validations defined on update_not-implemented_response_body

func ValidateUpdateResponseBody added in v0.30.0

func ValidateUpdateResponseBody(body *UpdateResponseBody) (err error)

ValidateUpdateResponseBody runs the validations defined on UpdateResponseBody

func ValidateWorkflowTRequestBodyRequestBody

func ValidateWorkflowTRequestBodyRequestBody(body *WorkflowTRequestBodyRequestBody) (err error)

ValidateWorkflowTRequestBodyRequestBody runs the validations defined on WorkflowTRequestBodyRequestBody

Types

type BasicWorkflowOptsTRequestBodyRequestBody

type BasicWorkflowOptsTRequestBodyRequestBody struct {
	// container image name
	Image string `form:"image" json:"image" xml:"image"`
	// Optionally definesq the image pull policy
	ImagePullPolicy string `json:"image-pull-policy,omitempty"`
	// Command to start the container - needed for some container runtimes
	Command []string `form:"command" json:"command" xml:"command"`
	// Defines memory resource requests and limits
	Memory *ResourceMemoryTRequestBodyRequestBody `form:"memory,omitempty" json:"memory,omitempty" xml:"memory,omitempty"`
	// Defines cpu resource requests and limits
	// (see
	// https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu)
	CPU *ResourceMemoryTRequestBodyRequestBody `form:"cpu,omitempty" json:"cpu,omitempty" xml:"cpu,omitempty"`
	// Defines ephemeral storage resource requests and limits
	// (see
	// https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#local-ephemeral-storage)
	EphemeralStorage *ResourceMemoryTRequestBodyRequestBody `json:"ephemeral-storage,omitempty"`
	// Defines required gpu type
	GpuType *string `json:"gpu-type,omitempty"`
	// Defines number of required gpu
	GpuNumber *int `json:"gpu-number,omitempty"`
	// Defines needed amount of shared-memory
	SharedMemory *string `json:"shared-memory,omitempty"`
}

BasicWorkflowOptsTRequestBodyRequestBody is used to define fields on request body types.

type Client

type Client struct {
	// List Doer is the HTTP client used to make requests to the list endpoint.
	ListDoer goahttp.Doer

	// CreateService Doer is the HTTP client used to make requests to the
	// create_service endpoint.
	CreateServiceDoer goahttp.Doer

	// Read Doer is the HTTP client used to make requests to the read endpoint.
	ReadDoer 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

	// CORS Doer is the HTTP client used to make requests to the  endpoint.
	CORSDoer 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 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 service service servers.

func (*Client) BuildCreateServiceRequest

func (c *Client) BuildCreateServiceRequest(ctx context.Context, v any) (*http.Request, error)

BuildCreateServiceRequest instantiates a HTTP request object with method and path set to call the "service" service "create_service" endpoint

func (*Client) BuildDeleteRequest

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

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

func (*Client) BuildListRequest

func (c *Client) BuildListRequest(ctx context.Context, v any) (*http.Request, error)

BuildListRequest instantiates a HTTP request object with method and path set to call the "service" service "list" endpoint

func (*Client) BuildReadRequest

func (c *Client) BuildReadRequest(ctx context.Context, v any) (*http.Request, error)

BuildReadRequest instantiates a HTTP request object with method and path set to call the "service" service "read" endpoint

func (*Client) BuildUpdateRequest

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

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

func (*Client) CreateService

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

CreateService returns an endpoint that makes HTTP requests to the service service create_service server.

func (*Client) Delete

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

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

func (*Client) List

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

List returns an endpoint that makes HTTP requests to the service service list server.

func (*Client) Read

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

Read returns an endpoint that makes HTTP requests to the service service read server.

func (*Client) Update

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

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

type CreateServiceAlreadyCreatedResponseBody

type CreateServiceAlreadyCreatedResponseBody struct {
	// ID of already existing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateServiceAlreadyCreatedResponseBody is the type of the "service" service "create_service" endpoint HTTP response body for the "already-created" error.

type CreateServiceBadRequestResponseBody

type CreateServiceBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateServiceBadRequestResponseBody is the type of the "service" service "create_service" endpoint HTTP response body for the "bad-request" error.

type CreateServiceInvalidParameterResponseBody

type CreateServiceInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

CreateServiceInvalidParameterResponseBody is the type of the "service" service "create_service" endpoint HTTP response body for the "invalid-parameter" error.

type CreateServiceInvalidScopesResponseBody

type CreateServiceInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateServiceInvalidScopesResponseBody is the type of the "service" service "create_service" endpoint HTTP response body for the "invalid-scopes" error.

type CreateServiceNotFoundResponseBody

type CreateServiceNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateServiceNotFoundResponseBody is the type of the "service" service "create_service" endpoint HTTP response body for the "not-found" error.

type CreateServiceNotImplementedResponseBody

type CreateServiceNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateServiceNotImplementedResponseBody is the type of the "service" service "create_service" endpoint HTTP response body for the "not-implemented" error.

type CreateServiceRequestBody

type CreateServiceRequestBody struct {
	// More detailed description of the service
	Description string `form:"description" json:"description" xml:"description"`
	// Reference to account revenues for this service should be credited to
	References []*ReferenceTRequestBodyRequestBody `form:"references,omitempty" json:"references,omitempty" xml:"references,omitempty"`
	// Link to banner image optionally used for this service
	Banner *string `form:"banner,omitempty" json:"banner,omitempty" xml:"banner,omitempty"`
	// Definition of the workflow to use for executing this service
	Workflow *WorkflowTRequestBodyRequestBody `form:"workflow" json:"workflow" xml:"workflow"`
	// Reference to policy used
	Policy *string `form:"policy,omitempty" json:"policy,omitempty" xml:"policy,omitempty"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Optional provider provided tags
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefT `form:"parameters" json:"parameters" xml:"parameters"`
}

CreateServiceRequestBody is the type of the "service" service "create_service" endpoint HTTP request body.

func NewCreateServiceRequestBody

func NewCreateServiceRequestBody(p *service.CreateServicePayload) *CreateServiceRequestBody

NewCreateServiceRequestBody builds the HTTP request body from the payload of the "create_service" endpoint of the "service" service.

type CreateServiceResponseBody

type CreateServiceResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// More detailed description of the service
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Service status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Reference to billable account
	Account *string              `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	Links   []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Optional provider provided tags
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefTResponseBody `form:"parameters,omitempty" json:"parameters,omitempty" xml:"parameters,omitempty"`
}

CreateServiceResponseBody is the type of the "service" service "create_service" endpoint HTTP response body.

type DeleteBadRequestResponseBody

type DeleteBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

DeleteBadRequestResponseBody is the type of the "service" service "delete" endpoint HTTP response body for the "bad-request" error.

type DeleteInvalidScopesResponseBody

type DeleteInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

DeleteInvalidScopesResponseBody is the type of the "service" service "delete" endpoint HTTP response body for the "invalid-scopes" error.

type DeleteNotImplementedResponseBody

type DeleteNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

DeleteNotImplementedResponseBody is the type of the "service" service "delete" endpoint HTTP response body for the "not-implemented" error.

type LinkTResponseBody added in v0.30.0

type LinkTResponseBody struct {
	// relation type
	Rel *string `form:"rel,omitempty" json:"rel,omitempty" xml:"rel,omitempty"`
	// mime type
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// web link
	Href *string `form:"href,omitempty" json:"href,omitempty" xml:"href,omitempty"`
}

LinkTResponseBody is used to define fields on response body types.

type ListBadRequestResponseBody

type ListBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListBadRequestResponseBody is the type of the "service" service "list" endpoint HTTP response body for the "bad-request" error.

type ListInvalidParameterResponseBody

type ListInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

ListInvalidParameterResponseBody is the type of the "service" service "list" endpoint HTTP response body for the "invalid-parameter" error.

type ListInvalidScopesResponseBody

type ListInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListInvalidScopesResponseBody is the type of the "service" service "list" endpoint HTTP response body for the "invalid-scopes" error.

type ListNotImplementedResponseBody

type ListNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListNotImplementedResponseBody is the type of the "service" service "list" endpoint HTTP response body for the "not-implemented" error.

type ListResponseBody

type ListResponseBody struct {
	// Services
	Items []*ServiceListItemResponseBody `form:"items,omitempty" json:"items,omitempty" xml:"items,omitempty"`
	// Time at which this list was valid
	AtTime *string              `form:"at-time,omitempty" json:"at-time,omitempty" xml:"at-time,omitempty"`
	Links  []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

ListResponseBody is the type of the "service" service "list" endpoint HTTP response body.

type ParameterDefT

type ParameterDefT struct {
	Name        string           `form:"name" json:"name" xml:"name"`
	Label       *string          `form:"label,omitempty" json:"label,omitempty" xml:"label,omitempty"`
	Type        string           `form:"type" json:"type" xml:"type"`
	Description string           `form:"description" json:"description" xml:"description"`
	Unit        *string          `form:"unit,omitempty" json:"unit,omitempty" xml:"unit,omitempty"`
	Constant    *bool            `form:"constant,omitempty" json:"constant,omitempty" xml:"constant,omitempty"`
	Optional    *bool            `form:"optional,omitempty" json:"optional,omitempty" xml:"optional,omitempty"`
	Default     *string          `form:"default,omitempty" json:"default,omitempty" xml:"default,omitempty"`
	Options     []*ParameterOptT `form:"options,omitempty" json:"options,omitempty" xml:"options,omitempty"`
	Unary       *bool            `form:"unary,omitempty" json:"unary,omitempty" xml:"unary,omitempty"`
}

ParameterDefT is used to define fields on request body types.

type ParameterDefTResponseBody

type ParameterDefTResponseBody struct {
	Name        *string                      `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	Label       *string                      `form:"label,omitempty" json:"label,omitempty" xml:"label,omitempty"`
	Type        *string                      `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	Description *string                      `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	Unit        *string                      `form:"unit,omitempty" json:"unit,omitempty" xml:"unit,omitempty"`
	Constant    *bool                        `form:"constant,omitempty" json:"constant,omitempty" xml:"constant,omitempty"`
	Optional    *bool                        `form:"optional,omitempty" json:"optional,omitempty" xml:"optional,omitempty"`
	Default     *string                      `form:"default,omitempty" json:"default,omitempty" xml:"default,omitempty"`
	Options     []*ParameterOptTResponseBody `form:"options,omitempty" json:"options,omitempty" xml:"options,omitempty"`
	Unary       *bool                        `form:"unary,omitempty" json:"unary,omitempty" xml:"unary,omitempty"`
}

ParameterDefTResponseBody is used to define fields on response body types.

type ParameterOptT

type ParameterOptT struct {
	Value       *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
}

ParameterOptT is used to define fields on request body types.

type ParameterOptTResponseBody

type ParameterOptTResponseBody struct {
	Value       *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
}

ParameterOptTResponseBody is used to define fields on response body types.

type ReadBadRequestResponseBody

type ReadBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadBadRequestResponseBody is the type of the "service" service "read" endpoint HTTP response body for the "bad-request" error.

type ReadInvalidScopesResponseBody

type ReadInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadInvalidScopesResponseBody is the type of the "service" service "read" endpoint HTTP response body for the "invalid-scopes" error.

type ReadNotFoundResponseBody

type ReadNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadNotFoundResponseBody is the type of the "service" service "read" endpoint HTTP response body for the "not-found" error.

type ReadNotImplementedResponseBody

type ReadNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadNotImplementedResponseBody is the type of the "service" service "read" endpoint HTTP response body for the "not-implemented" error.

type ReadResponseBody

type ReadResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// More detailed description of the service
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Service status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Reference to billable account
	Account *string              `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	Links   []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Optional provider provided tags
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefTResponseBody `form:"parameters,omitempty" json:"parameters,omitempty" xml:"parameters,omitempty"`
}

ReadResponseBody is the type of the "service" service "read" endpoint HTTP response body.

type ReferenceTRequestBodyRequestBody

type ReferenceTRequestBodyRequestBody struct {
	// Title of reference document
	Title *string `form:"title,omitempty" json:"title,omitempty" xml:"title,omitempty"`
	// Link to document
	URI *string `form:"uri,omitempty" json:"uri,omitempty" xml:"uri,omitempty"`
}

ReferenceTRequestBodyRequestBody is used to define fields on request body types.

type ResourceMemoryTRequestBodyRequestBody

type ResourceMemoryTRequestBodyRequestBody struct {
	// minimal requirements [0]
	Request *string `form:"request,omitempty" json:"request,omitempty" xml:"request,omitempty"`
	// minimal requirements [system limit]
	Limit *string `form:"limit,omitempty" json:"limit,omitempty" xml:"limit,omitempty"`
}

ResourceMemoryTRequestBodyRequestBody is used to define fields on request body types.

type ServiceListItemResponseBody

type ServiceListItemResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Optional customer provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Optional description of the service
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Optional banner image for this service
	Banner *string `form:"banner,omitempty" json:"banner,omitempty" xml:"banner,omitempty"`
	// time this service was published
	PublishedAt *string `form:"published-at,omitempty" json:"published-at,omitempty" xml:"published-at,omitempty"`
	// Reference to policy used
	Policy *string `form:"policy,omitempty" json:"policy,omitempty" xml:"policy,omitempty"`
	// Reference to billable account
	Account *string `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	Href    *string `json:"href,omitempty"`
}

ServiceListItemResponseBody is used to define fields on response body types.

type UpdateBadRequestResponseBody

type UpdateBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

UpdateBadRequestResponseBody is the type of the "service" service "update" endpoint HTTP response body for the "bad-request" error.

type UpdateInvalidParameterResponseBody

type UpdateInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

UpdateInvalidParameterResponseBody is the type of the "service" service "update" endpoint HTTP response body for the "invalid-parameter" error.

type UpdateInvalidScopesResponseBody

type UpdateInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

UpdateInvalidScopesResponseBody is the type of the "service" service "update" endpoint HTTP response body for the "invalid-scopes" error.

type UpdateNotFoundResponseBody

type UpdateNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

UpdateNotFoundResponseBody is the type of the "service" service "update" endpoint HTTP response body for the "not-found" error.

type UpdateNotImplementedResponseBody

type UpdateNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

UpdateNotImplementedResponseBody is the type of the "service" service "update" endpoint HTTP response body for the "not-implemented" error.

type UpdateRequestBody

type UpdateRequestBody struct {
	// More detailed description of the service
	Description string `form:"description" json:"description" xml:"description"`
	// Reference to account revenues for this service should be credited to
	References []*ReferenceTRequestBodyRequestBody `form:"references,omitempty" json:"references,omitempty" xml:"references,omitempty"`
	// Link to banner image optionally used for this service
	Banner *string `form:"banner,omitempty" json:"banner,omitempty" xml:"banner,omitempty"`
	// Definition of the workflow to use for executing this service
	Workflow *WorkflowTRequestBodyRequestBody `form:"workflow" json:"workflow" xml:"workflow"`
	// Reference to policy used
	Policy *string `form:"policy,omitempty" json:"policy,omitempty" xml:"policy,omitempty"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Optional provider provided tags
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefT `form:"parameters" json:"parameters" xml:"parameters"`
}

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

func NewUpdateRequestBody

func NewUpdateRequestBody(p *service.UpdatePayload) *UpdateRequestBody

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

type UpdateResponseBody

type UpdateResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// More detailed description of the service
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Service status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Reference to billable account
	Account *string              `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	Links   []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Optional provider provided tags
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefTResponseBody `form:"parameters,omitempty" json:"parameters,omitempty" xml:"parameters,omitempty"`
}

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

type WorkflowTRequestBodyRequestBody

type WorkflowTRequestBodyRequestBody struct {
	// Type of workflow
	Type string `form:"type" json:"type" xml:"type"`
	// Type of workflow
	Basic *BasicWorkflowOptsTRequestBodyRequestBody `form:"basic,omitempty" json:"basic,omitempty" xml:"basic,omitempty"`
	// Defines the workflow using argo's WF schema
	Argo any `form:"argo,omitempty" json:"argo,omitempty" xml:"argo,omitempty"`
}

WorkflowTRequestBodyRequestBody is used to define fields on request body types.

Jump to

Keyboard shortcuts

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