pipeline

Documentation

Index

• Constants
• Variables
• func NewListEndpoint(s Service) goa.Endpoint
• func NewShowEndpoint(s Service) goa.Endpoint
• func NewViewedEnduroStoredPipeline(res *EnduroStoredPipeline, view string) *pipelineviews.EnduroStoredPipeline
• type Client
  • func NewClient(list, show goa.Endpoint) *Client
  • func (c *Client) List(ctx context.Context, p *ListPayload) (res []*EnduroStoredPipeline, 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 NotFound
  • func (e *NotFound) Error() string
  • func (e *NotFound) ErrorName() string
• 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 = [2]string{"list", "show"}

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 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
}

Client is the "pipeline" service client.

func NewClient

func NewClient(list, show 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) 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 *NotFound): Collection not found
• error: internal error

type Endpoints

type Endpoints struct {
	List goa.Endpoint
	Show 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 {
	// Name of the collection
	ID *string
	// Name of the collection
	Name 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
}

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

type NotFound

type NotFound struct {
	// Message of error
	Message string
	// Identifier of missing collection
	ID uint
}

NotFound is the type returned when attempting to operate with a collection that does not exist.

func (*NotFound) Error

func (e *NotFound) Error() string

Error returns an error description.

func (*NotFound) ErrorName

func (e *NotFound) ErrorName() string

ErrorName returns "NotFound".

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)
}

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.