package cs3.tx.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Tx API The Tx API provides data transfer capabilities. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. The following are global requirements that apply to all methods: Any method MUST return CODE_OK on a succesful operation. Any method MAY return NOT_IMPLEMENTED. Any method MAY return INTERNAL. Any method MAY return UNKNOWN. Any method MAY return UNAUTHENTICATED.

• rpc CancelTransfer (CancelTransferRequest, CancelTransferResponse)

  tx_api.proto:58

  Requests to cancel a transfer.

• rpc CreateTransfer (CreateTransferRequest, CreateTransferResponse)

  tx_api.proto:54

  Requests creation of a transfer. Returns a CreateTransferResponse.

• rpc GetTransferStatus (GetTransferStatusRequest, GetTransferStatusResponse)

  tx_api.proto:56

  Requests a transfer status.

• rpc ListTransfers (ListTransfersRequest, ListTransfersResponse)

  tx_api.proto:61

  Requests a list of transfers received by the authenticated principle. If a filter is specified, only transfers satisfying the filter MUST be returned.

• rpc RetryTransfer (RetryTransferRequest, RetryTransferResponse)

  tx_api.proto:63

  Requests retrying a transfer.

Used as request type in: gateway.v1beta1.GatewayAPI.CancelTransfer, TxAPI.CancelTransfer

• optional TxId tx_id = 1

  REQUIRED. The transfer identifier.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

Used as response type in: gateway.v1beta1.GatewayAPI.CancelTransfer, TxAPI.CancelTransfer

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional TxInfo tx_info = 2

  REQUIRED. TxInfo, includes ao. transfer id, status, description.

• optional types.v1beta1.Opaque opaque = 3

  OPTIONAL. Opaque information.

Used as request type in: gateway.v1beta1.GatewayAPI.CreateTransfer, TxAPI.CreateTransfer

• string src_target_uri = 1

  REQUIRED. The source target URI. Should include at the minimum all the info needed to access the source. https://golang.org/pkg/net/url/#URL provides a quick view of the format.

• string dest_target_uri = 2

  REQUIRED. The destination target URI. Should include at the minimum all the info needed to access the destination. https://golang.org/pkg/net/url/#URL provides a quick view of the format.

• optional sharing.ocm.v1beta1.ShareId share_id = 3

  REQUIRED. The share Id of the share this transfer is based on.

• optional types.v1beta1.Opaque opaque = 4

  OPTIONAL. Opaque information.

Used as response type in: gateway.v1beta1.GatewayAPI.CreateTransfer, TxAPI.CreateTransfer

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional TxInfo tx_info = 2

  REQUIRED. TxInfo, includes transfer id, status, description.

• optional types.v1beta1.Opaque opaque = 3

  OPTIONAL. Opaque information.

Used as request type in: gateway.v1beta1.GatewayAPI.GetTransferStatus, TxAPI.GetTransferStatus

• optional TxId tx_id = 1

  REQUIRED. The transfer identifier.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

Used as response type in: gateway.v1beta1.GatewayAPI.GetTransferStatus, TxAPI.GetTransferStatus

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional TxInfo tx_info = 2

  REQUIRED. TxInfo, includes ao. transfer id, status, description.

• optional types.v1beta1.Opaque opaque = 3

  OPTIONAL. Opaque information.

Used as request type in: gateway.v1beta1.GatewayAPI.ListTransfers, TxAPI.ListTransfers

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• repeated ListTransfersRequest.Filter filters = 2

  OPTIONAL. The list of filters to apply if any.

REQUIRED. Represents a filter to apply to the request.

Used in: ListTransfersRequest

• Filter.Type type = 1

  REQUIRED.

• oneof term

  REQUIRED.

  • Status status = 2

  • sharing.ocm.v1beta1.ShareId share_id = 3

  • TxId tx_id = 4

The filter type.

Used in: Filter

• TYPE_INVALID = 0

• TYPE_STATUS = 1

• TYPE_SHARE_ID = 2

• TYPE_TX_ID = 3

Used as response type in: gateway.v1beta1.GatewayAPI.ListTransfers, TxAPI.ListTransfers

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• repeated TxInfo transfers = 2

  REQUIRED. List of TxInfo types representing transfers.

• optional types.v1beta1.Opaque opaque = 3

  OPTIONAL. Opaque information.

Used as request type in: gateway.v1beta1.GatewayAPI.RetryTransfer, TxAPI.RetryTransfer

• optional TxId tx_id = 1

  REQUIRED. The transfer identifier.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

Used as response type in: gateway.v1beta1.GatewayAPI.RetryTransfer, TxAPI.RetryTransfer

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional TxInfo tx_info = 2

  REQUIRED. TxInfo, includes ao. transfer id, status, description.

• optional types.v1beta1.Opaque opaque = 3

  OPTIONAL. Opaque information.

Status represents transfer status.

Used in: ListTransfersRequest.Filter, TxInfo

• STATUS_INVALID = 0

• STATUS_DESTINATION_NOT_FOUND = 1

  The destination could not be found.

• STATUS_TRANSFER_NEW = 2

  A new data transfer

• STATUS_TRANSFER_AWAITING_ACCEPTANCE = 3

  The data transfer is awaiting acceptance from the destination

• STATUS_TRANSFER_ACCEPTED = 4

  The data transfer is accepted by the destination.

• STATUS_TRANSFER_IN_PROGRESS = 5

  The data transfer has started and not yet completed.

• STATUS_TRANSFER_COMPLETE = 6

  The data transfer has completed.

• STATUS_TRANSFER_FAILED = 7

  The data transfer has failed.

• STATUS_TRANSFER_CANCELLED = 8

  The data transfer had been cancelled.

• STATUS_TRANSFER_CANCEL_FAILED = 9

  The request for cancelling the data transfer has failed.

• STATUS_TRANSFER_EXPIRED = 10

  The transfer has expired somewhere down the line.

TxId uniquely identifies a transfer in the transfer provider namespace.

Used in: CancelTransferRequest, GetTransferStatusRequest, ListTransfersRequest.Filter, RetryTransferRequest, TxInfo

• string opaque_id = 1

  REQUIRED. The internal transfer id used by the service implementor to uniquely identity the transfer in the internal implementation of the service.

TxInfo represents information about a transfer.

Used in: CancelTransferResponse, CreateTransferResponse, GetTransferStatusResponse, ListTransfersResponse, RetryTransferResponse

• optional TxId id = 1

  REQUIRED. The transfer identifier.

• Status status = 2

  REQUIRED. The transfer status. Eg.: STATUS_TRANSFER_FAILED. Note: the description field may provide additional information on the transfer status.

• optional storage.provider.v1beta1.Grantee grantee = 3

  REQUIRED. The destination (receiver of the transfer)

• optional identity.user.v1beta1.UserId creator = 4

  REQUIRED. Uniquely identifies a principal who initiates the transfer creation.

• optional types.v1beta1.Timestamp ctime = 5

  REQUIRED. Creation time of the transfer.

• string description = 6

  OPTIONAL. Information to describe the transfer status. Eg. may contain information about a transfer failure. Meant to be human-readable.

• optional sharing.ocm.v1beta1.ShareId share_id = 7

  REQUIRED. Opaque unique identifier of the share on which the transfer is based.