datatx

Documentation

Index

• type Manager
• type Repository
• type Transfer

Types

type Manager

type Manager interface {
	// CreateTransfer creates a transfer job and returns a TxInfo object that includes a unique transfer id.
	// Specified target URIs are of form scheme://userinfo@host:port?name={path}
	CreateTransfer(ctx context.Context, srcTargetURI string, dstTargetURI string) (*datatx.TxInfo, error)
	// GetTransferStatus returns a TxInfo object including the current status, and error if any.
	GetTransferStatus(ctx context.Context, transferID string) (*datatx.TxInfo, error)
	// CancelTransfer cancels the transfer and returns a TxInfo object and error if any.
	CancelTransfer(ctx context.Context, transferID string) (*datatx.TxInfo, error)
	// RetryTransfer retries the transfer and returns a TxInfo object and error if any.
	// Note that tokens must still be valid.
	RetryTransfer(ctx context.Context, transferID string) (*datatx.TxInfo, error)
}

Manager the interface any transfer driver should implement.

type Repository

type Repository interface {
	// StoreTransfer stores the transfer by its TxID
	StoreTransfer(transfer *Transfer) error
	// StoreTransfer deletes the transfer by its TxID
	DeleteTransfer(transfer *Transfer) error
	// GetTransfer returns the transfer with the specified transfer id
	GetTransfer(txID string) (*Transfer, error)
	// ListTransfers returns a filtered list of transfers
	ListTransfers(Filters []*datatx.ListTransfersRequest_Filter, UserID *userv1beta1.UserId) ([]*Transfer, error)
}

Repository the interface that any storage driver should implement.

type Transfer

type Transfer struct {
	TxID          string
	SrcTargetURI  string
	DestTargetURI string
	ShareID       string
	UserID        *userv1beta1.UserId
}

Transfer represents datatx transfer.