swagger

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(goa.Endpoint) *Client
• type Endpoints
  • func NewEndpoints(s Service) *Endpoints
  • func (e *Endpoints) Use(m func(goa.Endpoint) goa.Endpoint)
• type EnduroPackagePreservationAction
• type EnduroPackagePreservationTask
• type EnduroPackagePreservationTaskCollection
• type EnduroStoredPackage
• type MonitorPingEvent
• type PackageCreatedEvent
• type PackageLocationUpdatedEvent
• type PackageStatusUpdatedEvent
• type PackageUpdatedEvent
• type PreservationActionCreatedEvent
• type PreservationActionUpdatedEvent
• type PreservationTaskCreatedEvent
• type PreservationTaskUpdatedEvent
• type Service

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 = "swagger"

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 = [0]string{}

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.

Types

type Client

type Client struct {
}

Client is the "swagger" service client.

func NewClient

func NewClient(goa.Endpoint) *Client

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

type Endpoints

type Endpoints struct {
}

Endpoints wraps the "swagger" service endpoints.

func NewEndpoints

func NewEndpoints(s Service) *Endpoints

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

func (*Endpoints) Use

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

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

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

The swagger service serves the API swagger definition.