about

Documentation

Index

• Constants
• Variables
• func NewAboutEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
• func NewViewedEnduroAbout(res *EnduroAbout, view string) *aboutviews.EnduroAbout
• type AboutPayload
• type Auther
• type Client
  • func NewClient(about goa.Endpoint) *Client
  • func (c *Client) About(ctx context.Context, p *AboutPayload) (res *EnduroAbout, err error)
• type Endpoints
  • func NewEndpoints(s Service) *Endpoints
  • func (e *Endpoints) Use(m func(goa.Endpoint) goa.Endpoint)
• type EnduroAbout
  • func NewEnduroAbout(vres *aboutviews.EnduroAbout) *EnduroAbout
• type EnduroPackagePreservationAction
• type EnduroPackagePreservationTask
• type EnduroPackagePreservationTaskCollection
• type EnduroPoststorage
• type EnduroPoststorageCollection
• type EnduroPreprocessing
• type EnduroStoredPackage
• type MonitorPingEvent
• type PackageCreatedEvent
• type PackageLocationUpdatedEvent
• type PackageStatusUpdatedEvent
• type PackageUpdatedEvent
• type PreservationActionCreatedEvent
• type PreservationActionUpdatedEvent
• type PreservationTaskCreatedEvent
• type PreservationTaskUpdatedEvent
• type Service
• type Unauthorized
  • func (e Unauthorized) Error() string
  • func (e Unauthorized) ErrorName() string
  • func (e Unauthorized) GoaErrorName() string

Constants

const APIName = "enduro"

APIName is the name of the API as defined in the design.

const APIVersion = "0.0.1"

APIVersion is the version of the API as defined in the design.

const ServiceName = "about"

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 = [1]string{"about"}

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 NewAboutEndpoint

func NewAboutEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint

NewAboutEndpoint returns an endpoint function that calls the method "about" of service "about".

func NewViewedEnduroAbout

func NewViewedEnduroAbout(res *EnduroAbout, view string) *aboutviews.EnduroAbout

NewViewedEnduroAbout initializes viewed result type EnduroAbout from result type EnduroAbout using the given view.

Types

type AboutPayload

type AboutPayload struct {
	Token *string
}

AboutPayload is the payload type of the about service about method.

type Auther

type Auther interface {
	// JWTAuth implements the authorization logic for the JWT security scheme.
	JWTAuth(ctx context.Context, token string, schema *security.JWTScheme) (context.Context, error)
}

Auther defines the authorization functions to be implemented by the service.

type Client

type Client struct {
	AboutEndpoint goa.Endpoint
}

Client is the "about" service client.

func NewClient

func NewClient(about goa.Endpoint) *Client

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

func (*Client) About

func (c *Client) About(ctx context.Context, p *AboutPayload) (res *EnduroAbout, err error)

About calls the "about" endpoint of the "about" service. About may return the following errors:

• "unauthorized" (type Unauthorized)
• error: internal error

type Endpoints

type Endpoints struct {
	About goa.Endpoint
}

Endpoints wraps the "about" service endpoints.

func NewEndpoints

func NewEndpoints(s Service) *Endpoints

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

func (*Endpoints) Use

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

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

type EnduroAbout

type EnduroAbout struct {
	Version            string
	PreservationSystem string
	Preprocessing      *EnduroPreprocessing
	Poststorage        EnduroPoststorageCollection
}

EnduroAbout is the result type of the about service about method.

func NewEnduroAbout

func NewEnduroAbout(vres *aboutviews.EnduroAbout) *EnduroAbout

NewEnduroAbout initializes result type EnduroAbout from viewed result type EnduroAbout.

type EnduroPackagePreservationAction

type EnduroPackagePreservationAction struct {
	ID          uint
	WorkflowID  string
	Type        string
	Status      string
	StartedAt   string
	CompletedAt *string
	Tasks       EnduroPackagePreservationTaskCollection
	PackageID   *uint
}

PreservationAction describes a preservation action.

type EnduroPackagePreservationTask

type EnduroPackagePreservationTask struct {
	ID                   uint
	TaskID               string
	Name                 string
	Status               string
	StartedAt            string
	CompletedAt          *string
	Note                 *string
	PreservationActionID *uint
}

PreservationTask describes a preservation action task.

type EnduroPackagePreservationTaskCollection

type EnduroPackagePreservationTaskCollection []*EnduroPackagePreservationTask

type EnduroPoststorage

type EnduroPoststorage struct {
	WorkflowName string
	TaskQueue    string
}

type EnduroPoststorageCollection

type EnduroPoststorageCollection []*EnduroPoststorage

type EnduroPreprocessing

type EnduroPreprocessing struct {
	Enabled      bool
	WorkflowName string
	TaskQueue    string
}

type EnduroStoredPackage

type EnduroStoredPackage struct {
	// Identifier of package
	ID uint
	// Name of the package
	Name *string
	// Identifier of storage location
	LocationID *uuid.UUID
	// Status of the package
	Status string
	// Identifier of processing workflow
	WorkflowID *string
	// Identifier of latest processing workflow run
	RunID *string
	// Identifier of AIP
	AipID *string
	// Creation datetime
	CreatedAt string
	// Start datetime
	StartedAt *string
	// Completion datetime
	CompletedAt *string
}

StoredPackage describes a package retrieved by the service.

type MonitorPingEvent

type MonitorPingEvent struct {
	Message *string
}

type PackageCreatedEvent

type PackageCreatedEvent struct {
	// Identifier of package
	ID   uint
	Item *EnduroStoredPackage
}

type PackageLocationUpdatedEvent

type PackageLocationUpdatedEvent struct {
	// Identifier of package
	ID uint
	// Identifier of storage location
	LocationID uuid.UUID
}

type PackageStatusUpdatedEvent

type PackageStatusUpdatedEvent struct {
	// Identifier of package
	ID     uint
	Status string
}

type PackageUpdatedEvent

type PackageUpdatedEvent struct {
	// Identifier of package
	ID   uint
	Item *EnduroStoredPackage
}

type PreservationActionCreatedEvent

type PreservationActionCreatedEvent struct {
	// Identifier of preservation action
	ID   uint
	Item *EnduroPackagePreservationAction
}

type PreservationActionUpdatedEvent

type PreservationActionUpdatedEvent struct {
	// Identifier of preservation action
	ID   uint
	Item *EnduroPackagePreservationAction
}

type PreservationTaskCreatedEvent

type PreservationTaskCreatedEvent struct {
	// Identifier of preservation task
	ID   uint
	Item *EnduroPackagePreservationTask
}

type PreservationTaskUpdatedEvent

type PreservationTaskUpdatedEvent struct {
	// Identifier of preservation task
	ID   uint
	Item *EnduroPackagePreservationTask
}

type Service

type Service interface {
	// Get information about the system
	About(context.Context, *AboutPayload) (res *EnduroAbout, err error)
}

The about service provides information about the system.

type Unauthorized

type Unauthorized string

Unauthorized

func (Unauthorized) Error

func (e Unauthorized) Error() string

Error returns an error description.

func (Unauthorized) ErrorName

func (e Unauthorized) ErrorName() string

ErrorName returns "unauthorized".

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

func (Unauthorized) GoaErrorName

func (e Unauthorized) GoaErrorName() string

GoaErrorName returns "unauthorized".