client

package
v0.41.6 Latest Latest
Warning

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

 Go to latest Published: Mar 12, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildBulkPayload added in v0.26.0 

func BuildBulkPayload(collectionBulkBody string) (*collection.BulkPayload, error)

BuildBulkPayload builds the payload for the collection bulk endpoint from CLI flags.

func BuildCancelPayload 

func BuildCancelPayload(collectionCancelID string) (*collection.CancelPayload, error)

BuildCancelPayload builds the payload for the collection cancel endpoint from CLI flags.

func BuildDecidePayload added in v0.22.0 

func BuildDecidePayload(collectionDecideBody string, collectionDecideID string) (*collection.DecidePayload, error)

BuildDecidePayload builds the payload for the collection decide endpoint from CLI flags.

func BuildDeletePayload 

func BuildDeletePayload(collectionDeleteID string) (*collection.DeletePayload, error)

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

func BuildDownloadPayload added in v0.14.0 

func BuildDownloadPayload(collectionDownloadID string) (*collection.DownloadPayload, error)

BuildDownloadPayload builds the payload for the collection download endpoint from CLI flags.

func BuildListPayload 

func BuildListPayload(collectionListName string, collectionListOriginalID string, collectionListTransferID string, collectionListAipID string, collectionListPipelineID string, collectionListEarliestCreatedTime string, collectionListLatestCreatedTime string, collectionListStatus string, collectionListCursor string) (*collection.ListPayload, error)

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

func BuildRetryPayload 

func BuildRetryPayload(collectionRetryID string) (*collection.RetryPayload, error)

BuildRetryPayload builds the payload for the collection retry endpoint from CLI flags.

func BuildShowPayload 

func BuildShowPayload(collectionShowID string) (*collection.ShowPayload, error)

BuildShowPayload builds the payload for the collection show endpoint from CLI flags.

func BuildWorkflowPayload 

func BuildWorkflowPayload(collectionWorkflowID string) (*collection.WorkflowPayload, error)

BuildWorkflowPayload builds the payload for the collection workflow endpoint from CLI flags.

func BulkCollectionPath added in v0.26.0 

func BulkCollectionPath() string

BulkCollectionPath returns the URL path to the collection service bulk HTTP endpoint.

func BulkStatusCollectionPath added in v0.26.0 

func BulkStatusCollectionPath() string

BulkStatusCollectionPath returns the URL path to the collection service bulk_status HTTP endpoint.

func CancelCollectionPath 

func CancelCollectionPath(id uint) string

CancelCollectionPath returns the URL path to the collection service cancel HTTP endpoint.

func DecideCollectionPath added in v0.22.0 

func DecideCollectionPath(id uint) string

DecideCollectionPath returns the URL path to the collection service decide HTTP endpoint.

func DecodeBulkResponse added in v0.26.0 

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

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

  • "not_available" (type *goa.ServiceError): http.StatusConflict
  • "not_valid" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DecodeBulkStatusResponse added in v0.26.0 

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

DecodeBulkStatusResponse returns a decoder for responses returned by the collection bulk_status endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeCancelResponse 

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

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

  • "not_found" (type *collection.CollectionNotfound): http.StatusNotFound
  • "not_running" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DecodeDecideResponse added in v0.22.0 

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

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

  • "not_found" (type *collection.CollectionNotfound): http.StatusNotFound
  • "not_valid" (type *goa.ServiceError): http.StatusBadRequest
  • 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 collection delete endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeDeleteResponse may return the following errors:

  • "not_found" (type *collection.CollectionNotfound): http.StatusNotFound
  • error: internal error

func DecodeDownloadResponse added in v0.14.0 

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

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

  • "not_found" (type *collection.CollectionNotfound): http.StatusNotFound
  • 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 collection list endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeMonitorResponse added in v0.34.0 

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

DecodeMonitorResponse returns a decoder for responses returned by the collection monitor endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeRetryResponse 

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

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

  • "not_found" (type *collection.CollectionNotfound): http.StatusNotFound
  • "not_running" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DecodeShowResponse 

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

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

  • "not_found" (type *collection.CollectionNotfound): http.StatusNotFound
  • error: internal error

func DecodeWorkflowResponse 

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

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

  • "not_found" (type *collection.CollectionNotfound): http.StatusNotFound
  • error: internal error

func DeleteCollectionPath 

func DeleteCollectionPath(id uint) string

DeleteCollectionPath returns the URL path to the collection service delete HTTP endpoint.

func DownloadCollectionPath added in v0.14.0 

func DownloadCollectionPath(id uint) string

DownloadCollectionPath returns the URL path to the collection service download HTTP endpoint.

func EncodeBulkRequest added in v0.26.0 

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

EncodeBulkRequest returns an encoder for requests sent to the collection bulk server.

func EncodeDecideRequest added in v0.22.0 

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

EncodeDecideRequest returns an encoder for requests sent to the collection decide 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 collection list server.

func ListCollectionPath 

func ListCollectionPath() string

ListCollectionPath returns the URL path to the collection service list HTTP endpoint.

func MonitorCollectionPath added in v0.34.0 

func MonitorCollectionPath() string

MonitorCollectionPath returns the URL path to the collection service monitor HTTP endpoint.

func NewBulkNotAvailable added in v0.26.0 

func NewBulkNotAvailable(body *BulkNotAvailableResponseBody) *goa.ServiceError

NewBulkNotAvailable builds a collection service bulk endpoint not_available error.

func NewBulkNotValid added in v0.26.0 

func NewBulkNotValid(body *BulkNotValidResponseBody) *goa.ServiceError

NewBulkNotValid builds a collection service bulk endpoint not_valid error.

func NewBulkResultAccepted added in v0.26.0 

func NewBulkResultAccepted(body *BulkResponseBody) *collection.BulkResult

NewBulkResultAccepted builds a "collection" service "bulk" endpoint result from a HTTP "Accepted" response.

func NewBulkStatusResultOK added in v0.26.0 

func NewBulkStatusResultOK(body *BulkStatusResponseBody) *collection.BulkStatusResult

NewBulkStatusResultOK builds a "collection" service "bulk_status" endpoint result from a HTTP "OK" response.

func NewCancelNotFound 

func NewCancelNotFound(body *CancelNotFoundResponseBody) *collection.CollectionNotfound

NewCancelNotFound builds a collection service cancel endpoint not_found error.

func NewCancelNotRunning 

func NewCancelNotRunning(body *CancelNotRunningResponseBody) *goa.ServiceError

NewCancelNotRunning builds a collection service cancel endpoint not_running error.

func NewDecideNotFound added in v0.22.0 

func NewDecideNotFound(body *DecideNotFoundResponseBody) *collection.CollectionNotfound

NewDecideNotFound builds a collection service decide endpoint not_found error.

func NewDecideNotValid added in v0.22.0 

func NewDecideNotValid(body *DecideNotValidResponseBody) *goa.ServiceError

NewDecideNotValid builds a collection service decide endpoint not_valid error.

func NewDeleteNotFound 

func NewDeleteNotFound(body *DeleteNotFoundResponseBody) *collection.CollectionNotfound

NewDeleteNotFound builds a collection service delete endpoint not_found error.

func NewDownloadNotFound added in v0.14.0 

func NewDownloadNotFound(body *DownloadNotFoundResponseBody) *collection.CollectionNotfound

NewDownloadNotFound builds a collection service download endpoint not_found error.

func NewDownloadResultOK added in v0.38.0 

func NewDownloadResultOK(contentType string, contentLength int64, contentDisposition string) *collection.DownloadResult

NewDownloadResultOK builds a "collection" service "download" endpoint result from a HTTP "OK" response.

func NewListResultOK added in v0.5.0 

func NewListResultOK(body *ListResponseBody) *collection.ListResult

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

func NewMonitorEnduroMonitorUpdateOK added in v0.34.0 

func NewMonitorEnduroMonitorUpdateOK(body *MonitorResponseBody) *collectionviews.EnduroMonitorUpdateView

NewMonitorEnduroMonitorUpdateOK builds a "collection" service "monitor" endpoint result from a HTTP "OK" response.

func NewRetryNotFound 

func NewRetryNotFound(body *RetryNotFoundResponseBody) *collection.CollectionNotfound

NewRetryNotFound builds a collection service retry endpoint not_found error.

func NewRetryNotRunning 

func NewRetryNotRunning(body *RetryNotRunningResponseBody) *goa.ServiceError

NewRetryNotRunning builds a collection service retry endpoint not_running error.

func NewShowEnduroStoredCollectionOK 

func NewShowEnduroStoredCollectionOK(body *ShowResponseBody) *collectionviews.EnduroStoredCollectionView

NewShowEnduroStoredCollectionOK builds a "collection" service "show" endpoint result from a HTTP "OK" response.

func NewShowNotFound 

func NewShowNotFound(body *ShowNotFoundResponseBody) *collection.CollectionNotfound

NewShowNotFound builds a collection service show endpoint not_found error.

func NewWorkflowEnduroCollectionWorkflowStatusOK 

func NewWorkflowEnduroCollectionWorkflowStatusOK(body *WorkflowResponseBody) *collectionviews.EnduroCollectionWorkflowStatusView

NewWorkflowEnduroCollectionWorkflowStatusOK builds a "collection" service "workflow" endpoint result from a HTTP "OK" response.

func NewWorkflowNotFound 

func NewWorkflowNotFound(body *WorkflowNotFoundResponseBody) *collection.CollectionNotfound

NewWorkflowNotFound builds a collection service workflow endpoint not_found error.

func RetryCollectionPath 

func RetryCollectionPath(id uint) string

RetryCollectionPath returns the URL path to the collection service retry HTTP endpoint.

func ShowCollectionPath 

func ShowCollectionPath(id uint) string

ShowCollectionPath returns the URL path to the collection service show HTTP endpoint.

func ValidateBulkNotAvailableResponseBody added in v0.26.0 

func ValidateBulkNotAvailableResponseBody(body *BulkNotAvailableResponseBody) (err error)

ValidateBulkNotAvailableResponseBody runs the validations defined on bulk_not_available_response_body

func ValidateBulkNotValidResponseBody added in v0.26.0 

func ValidateBulkNotValidResponseBody(body *BulkNotValidResponseBody) (err error)

ValidateBulkNotValidResponseBody runs the validations defined on bulk_not_valid_response_body

func ValidateBulkResponseBody added in v0.26.0 

func ValidateBulkResponseBody(body *BulkResponseBody) (err error)

ValidateBulkResponseBody runs the validations defined on BulkResponseBody

func ValidateBulkStatusResponseBody added in v0.26.0 

func ValidateBulkStatusResponseBody(body *BulkStatusResponseBody) (err error)

ValidateBulkStatusResponseBody runs the validations defined on bulk_status_response_body

func ValidateCancelNotFoundResponseBody 

func ValidateCancelNotFoundResponseBody(body *CancelNotFoundResponseBody) (err error)

ValidateCancelNotFoundResponseBody runs the validations defined on cancel_not_found_response_body

func ValidateCancelNotRunningResponseBody 

func ValidateCancelNotRunningResponseBody(body *CancelNotRunningResponseBody) (err error)

ValidateCancelNotRunningResponseBody runs the validations defined on cancel_not_running_response_body

func ValidateDecideNotFoundResponseBody added in v0.22.0 

func ValidateDecideNotFoundResponseBody(body *DecideNotFoundResponseBody) (err error)

ValidateDecideNotFoundResponseBody runs the validations defined on decide_not_found_response_body

func ValidateDecideNotValidResponseBody added in v0.22.0 

func ValidateDecideNotValidResponseBody(body *DecideNotValidResponseBody) (err error)

ValidateDecideNotValidResponseBody runs the validations defined on decide_not_valid_response_body

func ValidateDeleteNotFoundResponseBody 

func ValidateDeleteNotFoundResponseBody(body *DeleteNotFoundResponseBody) (err error)

ValidateDeleteNotFoundResponseBody runs the validations defined on delete_not_found_response_body

func ValidateDownloadNotFoundResponseBody added in v0.14.0 

func ValidateDownloadNotFoundResponseBody(body *DownloadNotFoundResponseBody) (err error)

ValidateDownloadNotFoundResponseBody runs the validations defined on download_not_found_response_body

func ValidateEnduroStoredCollectionCollectionResponseBody added in v0.5.0 

func ValidateEnduroStoredCollectionCollectionResponseBody(body EnduroStoredCollectionCollectionResponseBody) (err error)

ValidateEnduroStoredCollectionCollectionResponseBody runs the validations defined on EnduroStored-CollectionCollectionResponseBody

func ValidateEnduroStoredCollectionResponseBody added in v0.5.0 

func ValidateEnduroStoredCollectionResponseBody(body *EnduroStoredCollectionResponseBody) (err error)

ValidateEnduroStoredCollectionResponseBody runs the validations defined on EnduroStored-CollectionResponseBody

func ValidateListResponseBody added in v0.5.0 

func ValidateListResponseBody(body *ListResponseBody) (err error)

ValidateListResponseBody runs the validations defined on ListResponseBody

func ValidateRetryNotFoundResponseBody 

func ValidateRetryNotFoundResponseBody(body *RetryNotFoundResponseBody) (err error)

ValidateRetryNotFoundResponseBody runs the validations defined on retry_not_found_response_body

func ValidateRetryNotRunningResponseBody 

func ValidateRetryNotRunningResponseBody(body *RetryNotRunningResponseBody) (err error)

ValidateRetryNotRunningResponseBody runs the validations defined on retry_not_running_response_body

func ValidateShowNotFoundResponseBody 

func ValidateShowNotFoundResponseBody(body *ShowNotFoundResponseBody) (err error)

ValidateShowNotFoundResponseBody runs the validations defined on show_not_found_response_body

func ValidateWorkflowNotFoundResponseBody 

func ValidateWorkflowNotFoundResponseBody(body *WorkflowNotFoundResponseBody) (err error)

ValidateWorkflowNotFoundResponseBody runs the validations defined on workflow_not_found_response_body

func WorkflowCollectionPath 

func WorkflowCollectionPath(id uint) string

WorkflowCollectionPath returns the URL path to the collection service workflow HTTP endpoint.

Types

type BulkNotAvailableResponseBody added in v0.26.0 

type BulkNotAvailableResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

BulkNotAvailableResponseBody is the type of the "collection" service "bulk" endpoint HTTP response body for the "not_available" error.

type BulkNotValidResponseBody added in v0.26.0 

type BulkNotValidResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

BulkNotValidResponseBody is the type of the "collection" service "bulk" endpoint HTTP response body for the "not_valid" error.

type BulkRequestBody added in v0.26.0 

type BulkRequestBody struct {
	Operation string `form:"operation" json:"operation" xml:"operation"`
	Status    string `form:"status" json:"status" xml:"status"`
	Size      uint   `form:"size" json:"size" xml:"size"`
}

BulkRequestBody is the type of the "collection" service "bulk" endpoint HTTP request body.

func NewBulkRequestBody added in v0.26.0 

func NewBulkRequestBody(p *collection.BulkPayload) *BulkRequestBody

NewBulkRequestBody builds the HTTP request body from the payload of the "bulk" endpoint of the "collection" service.

type BulkResponseBody added in v0.26.0 

type BulkResponseBody struct {
	WorkflowID *string `form:"workflow_id,omitempty" json:"workflow_id,omitempty" xml:"workflow_id,omitempty"`
	RunID      *string `form:"run_id,omitempty" json:"run_id,omitempty" xml:"run_id,omitempty"`
}

BulkResponseBody is the type of the "collection" service "bulk" endpoint HTTP response body.

type BulkStatusResponseBody added in v0.26.0 

type BulkStatusResponseBody struct {
	Running    *bool   `form:"running,omitempty" json:"running,omitempty" xml:"running,omitempty"`
	StartedAt  *string `form:"started_at,omitempty" json:"started_at,omitempty" xml:"started_at,omitempty"`
	ClosedAt   *string `form:"closed_at,omitempty" json:"closed_at,omitempty" xml:"closed_at,omitempty"`
	Status     *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	WorkflowID *string `form:"workflow_id,omitempty" json:"workflow_id,omitempty" xml:"workflow_id,omitempty"`
	RunID      *string `form:"run_id,omitempty" json:"run_id,omitempty" xml:"run_id,omitempty"`
}

BulkStatusResponseBody is the type of the "collection" service "bulk_status" endpoint HTTP response body.

type CancelNotFoundResponseBody 

type CancelNotFoundResponseBody struct {
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Identifier of missing collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
}

CancelNotFoundResponseBody is the type of the "collection" service "cancel" endpoint HTTP response body for the "not_found" error.

type CancelNotRunningResponseBody 

type CancelNotRunningResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

CancelNotRunningResponseBody is the type of the "collection" service "cancel" endpoint HTTP response body for the "not_running" error.

type Client 

type Client struct {
	// Monitor Doer is the HTTP client used to make requests to the monitor
	// endpoint.
	MonitorDoer goahttp.Doer

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

	// Show Doer is the HTTP client used to make requests to the show endpoint.
	ShowDoer goahttp.Doer

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

	// Cancel Doer is the HTTP client used to make requests to the cancel endpoint.
	CancelDoer goahttp.Doer

	// Retry Doer is the HTTP client used to make requests to the retry endpoint.
	RetryDoer goahttp.Doer

	// Workflow Doer is the HTTP client used to make requests to the workflow
	// endpoint.
	WorkflowDoer goahttp.Doer

	// Download Doer is the HTTP client used to make requests to the download
	// endpoint.
	DownloadDoer goahttp.Doer

	// Decide Doer is the HTTP client used to make requests to the decide endpoint.
	DecideDoer goahttp.Doer

	// Bulk Doer is the HTTP client used to make requests to the bulk endpoint.
	BulkDoer goahttp.Doer

	// BulkStatus Doer is the HTTP client used to make requests to the bulk_status
	// endpoint.
	BulkStatusDoer 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 collection 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,
	dialer goahttp.Dialer,
	cfn *ConnConfigurer,
) *Client

NewClient instantiates HTTP clients for all the collection service servers.

func (*Client) BuildBulkRequest added in v0.26.0 

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

BuildBulkRequest instantiates a HTTP request object with method and path set to call the "collection" service "bulk" endpoint

func (*Client) BuildBulkStatusRequest added in v0.26.0 

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

BuildBulkStatusRequest instantiates a HTTP request object with method and path set to call the "collection" service "bulk_status" endpoint

func (*Client) BuildCancelRequest 

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

BuildCancelRequest instantiates a HTTP request object with method and path set to call the "collection" service "cancel" endpoint

func (*Client) BuildDecideRequest added in v0.22.0 

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

BuildDecideRequest instantiates a HTTP request object with method and path set to call the "collection" service "decide" 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 "collection" service "delete" endpoint

func (*Client) BuildDownloadRequest added in v0.14.0 

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

BuildDownloadRequest instantiates a HTTP request object with method and path set to call the "collection" service "download" 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 "collection" service "list" endpoint

func (*Client) BuildMonitorRequest added in v0.34.0 

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

BuildMonitorRequest instantiates a HTTP request object with method and path set to call the "collection" service "monitor" endpoint

func (*Client) BuildRetryRequest 

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

BuildRetryRequest instantiates a HTTP request object with method and path set to call the "collection" service "retry" endpoint

func (*Client) BuildShowRequest 

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

BuildShowRequest instantiates a HTTP request object with method and path set to call the "collection" service "show" endpoint

func (*Client) BuildWorkflowRequest 

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

BuildWorkflowRequest instantiates a HTTP request object with method and path set to call the "collection" service "workflow" endpoint

func (*Client) Bulk added in v0.26.0 

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

Bulk returns an endpoint that makes HTTP requests to the collection service bulk server.

func (*Client) BulkStatus added in v0.26.0 

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

BulkStatus returns an endpoint that makes HTTP requests to the collection service bulk_status server.

func (*Client) Cancel 

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

Cancel returns an endpoint that makes HTTP requests to the collection service cancel server.

func (*Client) Decide added in v0.22.0 

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

Decide returns an endpoint that makes HTTP requests to the collection service decide server.

func (*Client) Delete 

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

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

func (*Client) Download added in v0.14.0 

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

Download returns an endpoint that makes HTTP requests to the collection service download server.

func (*Client) List 

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

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

func (*Client) Monitor added in v0.34.0 

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

Monitor returns an endpoint that makes HTTP requests to the collection service monitor server.

func (*Client) Retry 

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

Retry returns an endpoint that makes HTTP requests to the collection service retry server.

func (*Client) Show 

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

Show returns an endpoint that makes HTTP requests to the collection service show server.

func (*Client) Workflow 

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

Workflow returns an endpoint that makes HTTP requests to the collection service workflow server.

type ConnConfigurer added in v0.34.0 

type ConnConfigurer struct {
	MonitorFn goahttp.ConnConfigureFunc
}

ConnConfigurer holds the websocket connection configurer functions for the streaming endpoints in "collection" service.

func NewConnConfigurer added in v0.34.0 

func NewConnConfigurer(fn goahttp.ConnConfigureFunc) *ConnConfigurer

NewConnConfigurer initializes the websocket connection configurer function with fn for all the streaming endpoints in "collection" service.

type DecideNotFoundResponseBody added in v0.22.0 

type DecideNotFoundResponseBody struct {
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Identifier of missing collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
}

DecideNotFoundResponseBody is the type of the "collection" service "decide" endpoint HTTP response body for the "not_found" error.

type DecideNotValidResponseBody added in v0.22.0 

type DecideNotValidResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

DecideNotValidResponseBody is the type of the "collection" service "decide" endpoint HTTP response body for the "not_valid" error.

type DeleteNotFoundResponseBody 

type DeleteNotFoundResponseBody struct {
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Identifier of missing collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
}

DeleteNotFoundResponseBody is the type of the "collection" service "delete" endpoint HTTP response body for the "not_found" error.

type DownloadNotFoundResponseBody added in v0.14.0 

type DownloadNotFoundResponseBody struct {
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Identifier of missing collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
}

DownloadNotFoundResponseBody is the type of the "collection" service "download" endpoint HTTP response body for the "not_found" error.

type EnduroCollectionWorkflowHistoryCollectionResponseBody 

type EnduroCollectionWorkflowHistoryCollectionResponseBody []*EnduroCollectionWorkflowHistoryResponseBody

EnduroCollectionWorkflowHistoryCollectionResponseBody is used to define fields on response body types.

type EnduroCollectionWorkflowHistoryResponseBody 

type EnduroCollectionWorkflowHistoryResponseBody struct {
	// Identifier of collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Type of the event
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// Contents of the event
	Details any `form:"details,omitempty" json:"details,omitempty" xml:"details,omitempty"`
}

EnduroCollectionWorkflowHistoryResponseBody is used to define fields on response body types.

type EnduroStoredCollectionCollectionResponseBody added in v0.5.0 

type EnduroStoredCollectionCollectionResponseBody []*EnduroStoredCollectionResponseBody

EnduroStoredCollectionCollectionResponseBody is used to define fields on response body types.

type EnduroStoredCollectionResponseBody added in v0.5.0 

type EnduroStoredCollectionResponseBody struct {
	// Identifier of collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Name of the collection
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Status of the collection
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Identifier of processing workflow
	WorkflowID *string `form:"workflow_id,omitempty" json:"workflow_id,omitempty" xml:"workflow_id,omitempty"`
	// Identifier of latest processing workflow run
	RunID *string `form:"run_id,omitempty" json:"run_id,omitempty" xml:"run_id,omitempty"`
	// Identifier of Archivematica tranfser
	TransferID *string `form:"transfer_id,omitempty" json:"transfer_id,omitempty" xml:"transfer_id,omitempty"`
	// Identifier of Archivematica AIP
	AipID *string `form:"aip_id,omitempty" json:"aip_id,omitempty" xml:"aip_id,omitempty"`
	// Identifier provided by the client
	OriginalID *string `form:"original_id,omitempty" json:"original_id,omitempty" xml:"original_id,omitempty"`
	// Identifier of Archivematica pipeline
	PipelineID *string `form:"pipeline_id,omitempty" json:"pipeline_id,omitempty" xml:"pipeline_id,omitempty"`
	// Creation datetime
	CreatedAt *string `form:"created_at,omitempty" json:"created_at,omitempty" xml:"created_at,omitempty"`
	// Start datetime
	StartedAt *string `form:"started_at,omitempty" json:"started_at,omitempty" xml:"started_at,omitempty"`
	// Completion datetime
	CompletedAt *string `form:"completed_at,omitempty" json:"completed_at,omitempty" xml:"completed_at,omitempty"`
}

EnduroStoredCollectionResponseBody is used to define fields on response body types.

type ListResponseBody 

type ListResponseBody struct {
	Items      EnduroStoredCollectionCollectionResponseBody `form:"items,omitempty" json:"items,omitempty" xml:"items,omitempty"`
	NextCursor *string                                      `form:"next_cursor,omitempty" json:"next_cursor,omitempty" xml:"next_cursor,omitempty"`
}

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

type MonitorClientStream added in v0.34.0 

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

MonitorClientStream implements the collection.MonitorClientStream interface.

func (*MonitorClientStream) Recv added in v0.34.0 

func (s *MonitorClientStream) Recv() (*collection.EnduroMonitorUpdate, error)

Recv reads instances of "collection.EnduroMonitorUpdate" from the "monitor" endpoint websocket connection.

type MonitorResponseBody added in v0.34.0 

type MonitorResponseBody struct {
	// Identifier of collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Type of the event
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// Collection
	Item *EnduroStoredCollectionResponseBody `form:"item,omitempty" json:"item,omitempty" xml:"item,omitempty"`
}

MonitorResponseBody is the type of the "collection" service "monitor" endpoint HTTP response body.

type RetryNotFoundResponseBody 

type RetryNotFoundResponseBody struct {
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Identifier of missing collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
}

RetryNotFoundResponseBody is the type of the "collection" service "retry" endpoint HTTP response body for the "not_found" error.

type RetryNotRunningResponseBody 

type RetryNotRunningResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

RetryNotRunningResponseBody is the type of the "collection" service "retry" endpoint HTTP response body for the "not_running" error.

type ShowNotFoundResponseBody 

type ShowNotFoundResponseBody struct {
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Identifier of missing collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
}

ShowNotFoundResponseBody is the type of the "collection" service "show" endpoint HTTP response body for the "not_found" error.

type ShowResponseBody 

type ShowResponseBody struct {
	// Identifier of collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Name of the collection
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Status of the collection
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Identifier of processing workflow
	WorkflowID *string `form:"workflow_id,omitempty" json:"workflow_id,omitempty" xml:"workflow_id,omitempty"`
	// Identifier of latest processing workflow run
	RunID *string `form:"run_id,omitempty" json:"run_id,omitempty" xml:"run_id,omitempty"`
	// Identifier of Archivematica tranfser
	TransferID *string `form:"transfer_id,omitempty" json:"transfer_id,omitempty" xml:"transfer_id,omitempty"`
	// Identifier of Archivematica AIP
	AipID *string `form:"aip_id,omitempty" json:"aip_id,omitempty" xml:"aip_id,omitempty"`
	// Identifier provided by the client
	OriginalID *string `form:"original_id,omitempty" json:"original_id,omitempty" xml:"original_id,omitempty"`
	// Identifier of Archivematica pipeline
	PipelineID *string `form:"pipeline_id,omitempty" json:"pipeline_id,omitempty" xml:"pipeline_id,omitempty"`
	// Creation datetime
	CreatedAt *string `form:"created_at,omitempty" json:"created_at,omitempty" xml:"created_at,omitempty"`
	// Start datetime
	StartedAt *string `form:"started_at,omitempty" json:"started_at,omitempty" xml:"started_at,omitempty"`
	// Completion datetime
	CompletedAt *string `form:"completed_at,omitempty" json:"completed_at,omitempty" xml:"completed_at,omitempty"`
}

ShowResponseBody is the type of the "collection" service "show" endpoint HTTP response body.

type WorkflowNotFoundResponseBody 

type WorkflowNotFoundResponseBody struct {
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Identifier of missing collection
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
}

WorkflowNotFoundResponseBody is the type of the "collection" service "workflow" endpoint HTTP response body for the "not_found" error.

type WorkflowResponseBody 

type WorkflowResponseBody struct {
	Status  *string                                               `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	History EnduroCollectionWorkflowHistoryCollectionResponseBody `form:"history,omitempty" json:"history,omitempty" xml:"history,omitempty"`
}

WorkflowResponseBody is the type of the "collection" service "workflow" endpoint HTTP response body.

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.