pipeline

Documentation

Index

• Constants
• Variables
• func NewListEndpoint(s Service) goa.Endpoint
• func NewProcessingEndpoint(s Service) goa.Endpoint
• func NewShowEndpoint(s Service) goa.Endpoint
• func NewViewedEnduroStoredPipeline(res *EnduroStoredPipeline, view string) *pipelineviews.EnduroStoredPipeline
• type Client
  • func NewClient(list, show, processing goa.Endpoint) *Client
  • func (c *Client) List(ctx context.Context, p *ListPayload) (res []*EnduroStoredPipeline, err error)
  • func (c *Client) Processing(ctx context.Context, p *ProcessingPayload) (res []string, err error)
  • func (c *Client) Show(ctx context.Context, p *ShowPayload) (res *EnduroStoredPipeline, err error)
• type Endpoints
  • func NewEndpoints(s Service) *Endpoints
  • func (e *Endpoints) Use(m func(goa.Endpoint) goa.Endpoint)
• type EnduroStoredPipeline
  • func NewEnduroStoredPipeline(vres *pipelineviews.EnduroStoredPipeline) *EnduroStoredPipeline
• type ListPayload
• type PipelineNotFound
  • func (e *PipelineNotFound) Error() string
  • func (e *PipelineNotFound) ErrorName() string
  • func (e *PipelineNotFound) GoaErrorName() string
• type ProcessingPayload
• type Service
• type ShowPayload

Constants

const ServiceName = "pipeline"

ServiceName is the name of the service as defined in the design. This is the same value that is set in the endpoint request contexts under the ServiceKey key.

Variables

var MethodNames = [3]string{"list", "show", "processing"}

MethodNames lists the service method names as defined in the design. These are the same values that are set in the endpoint request contexts under the MethodKey key.

Functions

func NewListEndpoint

func NewListEndpoint(s Service) goa.Endpoint

NewListEndpoint returns an endpoint function that calls the method "list" of service "pipeline".

func NewProcessingEndpoint

func NewProcessingEndpoint(s Service) goa.Endpoint

NewProcessingEndpoint returns an endpoint function that calls the method "processing" of service "pipeline".

func NewShowEndpoint

func NewShowEndpoint(s Service) goa.Endpoint

NewShowEndpoint returns an endpoint function that calls the method "show" of service "pipeline".

func NewViewedEnduroStoredPipeline

func NewViewedEnduroStoredPipeline(res *EnduroStoredPipeline, view string) *pipelineviews.EnduroStoredPipeline

NewViewedEnduroStoredPipeline initializes viewed result type EnduroStoredPipeline from result type EnduroStoredPipeline using the given view.

Types

type Client

type Client struct {
	ListEndpoint       goa.Endpoint
	ShowEndpoint       goa.Endpoint
	ProcessingEndpoint goa.Endpoint
}

Client is the "pipeline" service client.

func NewClient

func NewClient(list, show, processing goa.Endpoint) *Client

NewClient initializes a "pipeline" service client given the endpoints.

func (*Client) List

func (c *Client) List(ctx context.Context, p *ListPayload) (res []*EnduroStoredPipeline, err error)

List calls the "list" endpoint of the "pipeline" service.

func (*Client) Processing

func (c *Client) Processing(ctx context.Context, p *ProcessingPayload) (res []string, err error)

Processing calls the "processing" endpoint of the "pipeline" service. Processing may return the following errors:

• "not_found" (type *PipelineNotFound): Pipeline not found
• error: internal error

func (*Client) Show

func (c *Client) Show(ctx context.Context, p *ShowPayload) (res *EnduroStoredPipeline, err error)

Show calls the "show" endpoint of the "pipeline" service. Show may return the following errors:

• "not_found" (type *PipelineNotFound): Pipeline not found
• error: internal error

type Endpoints

type Endpoints struct {
	List       goa.Endpoint
	Show       goa.Endpoint
	Processing goa.Endpoint
}

Endpoints wraps the "pipeline" service endpoints.

func NewEndpoints

func NewEndpoints(s Service) *Endpoints

NewEndpoints wraps the methods of the "pipeline" service with endpoints.

func (*Endpoints) Use

func (e *Endpoints) Use(m func(goa.Endpoint) goa.Endpoint)

Use applies the given middleware to all the "pipeline" service endpoints.

type EnduroStoredPipeline

type EnduroStoredPipeline struct {
	// Identifier of pipeline
	ID *string
	// Name of the pipeline
	Name string
	// Maximum concurrent transfers
	Capacity *int64
	// Current transfers
	Current *int64
	Status  *string
}

EnduroStoredPipeline is the result type of the pipeline service show method.

func NewEnduroStoredPipeline

func NewEnduroStoredPipeline(vres *pipelineviews.EnduroStoredPipeline) *EnduroStoredPipeline

NewEnduroStoredPipeline initializes result type EnduroStoredPipeline from viewed result type EnduroStoredPipeline.

type ListPayload

type ListPayload struct {
	Name   *string
	Status bool
}

ListPayload is the payload type of the pipeline service list method.

type PipelineNotFound

type PipelineNotFound struct {
	// Message of error
	Message string
	// Identifier of missing pipeline
	ID string
}

Pipeline not found.

func (*PipelineNotFound) Error

func (e *PipelineNotFound) Error() string

Error returns an error description.

func (*PipelineNotFound) ErrorName

func (e *PipelineNotFound) ErrorName() string

ErrorName returns "PipelineNotFound".

Deprecated: Use GoaErrorName - https://github.com/goadesign/goa/issues/3105

func (*PipelineNotFound) GoaErrorName

func (e *PipelineNotFound) GoaErrorName() string

GoaErrorName returns "PipelineNotFound".

type ProcessingPayload

type ProcessingPayload struct {
	// Identifier of pipeline
	ID string
}

ProcessingPayload is the payload type of the pipeline service processing method.

type Service

type Service interface {
	// List all known pipelines
	List(context.Context, *ListPayload) (res []*EnduroStoredPipeline, err error)
	// Show pipeline by ID
	Show(context.Context, *ShowPayload) (res *EnduroStoredPipeline, err error)
	// List all processing configurations of a pipeline given its ID
	Processing(context.Context, *ProcessingPayload) (res []string, err error)
}

The pipeline service manages Archivematica pipelines.

type ShowPayload

type ShowPayload struct {
	// Identifier of pipeline to show
	ID string
}

ShowPayload is the payload type of the pipeline service show method.