pipeline

Documentation

Overview

Package pipeline provides tools to work with one of more pipelines.

Index

• Variables
• func IngestStatus(ctx context.Context, ingestService amclient.IngestService, ID string) error
• func NewService(logger logr.Logger, registry *Registry) *pipelineImpl
• func TransferStatus(ctx context.Context, transferService amclient.TransferService, ID string) (string, error)
• type Config
• type Pipeline
  • func NewPipeline(logger logr.Logger, config Config) (*Pipeline, error)
  • func (p *Pipeline) Capacity() (size, cur int64)
  • func (p Pipeline) Client() *amclient.Client
  • func (p Pipeline) Config() *Config
  • func (p *Pipeline) Release()
  • func (p Pipeline) SSAccess() (*url.URL, string, error)
  • func (p Pipeline) TempFile(pattern string) (*os.File, error)
  • func (p *Pipeline) TryAcquire() bool
• type Registry
  • func NewPipelineRegistry(logger logr.Logger, configs []Config) (*Registry, error)
  • func (r *Registry) ByID(id string) (*Pipeline, error)
  • func (r *Registry) ByName(name string) (*Pipeline, error)
  • func (r *Registry) List() []*Pipeline
  • func (r *Registry) Names() []string
• type Service

Variables

var (
	ErrStatusNonRetryable = errors.New("non retryable error")
	ErrStatusRetryable    = errors.New("retryable error")
	ErrStatusInProgress   = errors.New("waitable error")
)

var ErrUnknownPipeline = errors.New("unknown pipeline")

Functions

func IngestStatus

func IngestStatus(ctx context.Context, ingestService amclient.IngestService, ID string) error

IngestStatus returns a non-nil error when the SIP is not fully ingested.

func NewService

func NewService(logger logr.Logger, registry *Registry) *pipelineImpl

func TransferStatus

func TransferStatus(ctx context.Context, transferService amclient.TransferService, ID string) (string, error)

TransferStatus returns a non-nil error when the transfer is not fully transferred.

Types

type Config

type Config struct {
	ID                 string
	Name               string
	BaseURL            string
	User               string
	Key                string
	TransferDir        string
	TransferLocationID string
	ProcessingDir      string
	ProcessingConfig   string
	StorageServiceURL  string
	Capacity           uint64
	RetryDeadline      *time.Duration
	TransferDeadline   *time.Duration
}

type Pipeline

type Pipeline struct {

	// ID (UUID) of the pipeline. This is not provided by the user but loaded
	// on demand once we have access to the pipeline API.
	ID string
	// contains filtered or unexported fields
}

func NewPipeline

func NewPipeline(logger logr.Logger, config Config) (*Pipeline, error)

func (*Pipeline) Capacity

func (p *Pipeline) Capacity() (size, cur int64)

func (Pipeline) Client

func (p Pipeline) Client() *amclient.Client

Client returns the Archivematica API client ready for use.

func (Pipeline) Config

func (p Pipeline) Config() *Config

func (*Pipeline) Release

func (p *Pipeline) Release()

func (Pipeline) SSAccess

func (p Pipeline) SSAccess() (*url.URL, string, error)

SSAccess returns the URL and user:key pair needed to access Storage Service.

func (Pipeline) TempFile

func (p Pipeline) TempFile(pattern string) (*os.File, error)

TempFile creates a temporary file in the processing directory.

func (*Pipeline) TryAcquire

func (p *Pipeline) TryAcquire() bool

type Registry

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

Registry is a collection of known pipelines.

func NewPipelineRegistry

func NewPipelineRegistry(logger logr.Logger, configs []Config) (*Registry, error)

func (*Registry) ByID

func (r *Registry) ByID(id string) (*Pipeline, error)

func (*Registry) ByName

func (r *Registry) ByName(name string) (*Pipeline, error)

func (*Registry) List

func (r *Registry) List() []*Pipeline

func (*Registry) Names

func (r *Registry) Names() []string

type Service

type Service interface {
	List(context.Context, *goapipeline.ListPayload) ([]*goapipeline.EnduroStoredPipeline, error)
	Show(context.Context, *goapipeline.ShowPayload) (*goapipeline.EnduroStoredPipeline, error)
	Processing(context.Context, *goapipeline.ProcessingPayload) ([]string, error)
}