package cacheroach.upload

Get desktop application:
View/edit binary Protocol Buffers messages

An upload process starts by calling Begin, which issues a TransferState message. The TransferState will be incrementally updated by some number of calls to Transfer. A final call to Commit will attach the transferred data to the requested file path. The BeginResponse will include a maximum chunk size that is enforced by the server. Clients may upload smaller chunks, but this will decrease overall efficiency. Calls to Transfer and Commit are idempotent. A client need only retry a call to Transfer or to Commit in order to recover from an interrupted connection. After a file has been uploaded, it may be retrieved with a regular HTTP GET call to the tenant's virtual host, or a signed URI path may be generated with the Retrieve endpoint.

• rpc Begin (BeginRequest, BeginResponse)

  upload.proto:151

  message BeginRequest

  upload.proto:37

  • optional tenant.ID tenant = 1

  • string path = 2

  • oneof committed

    For trivially small (or empty) files, we'd like to be able to effect the transfer in a single request.

    • bytes contents = 3

      The contents of the file. This should generally be under 1 MiB. If the contents exceed the server's configured maximum, an error may be returned.

    • bool empty = 4

      If true, an empty file will be committed.

  message BeginResponse

  upload.proto:66

  • optional TransferState state = 1

    Continuation data to provide to TransferRequest.

  • int32 max_chunk_size = 2

    The maximum number of bytes to include in a single transfer.

  • bool committed = 3

    If this field is true, the contents in the BeginRequest were committed successfully and the transfer is finished. If false, the client can use the returned TransferState to perform the file transfer as usual.

• rpc Commit (CommitRequest, CommitResponse)

  upload.proto:154

  message CommitRequest

  upload.proto:78

  • optional TransferState state = 1

    Continuation data from a previous TransferRequest.

  • map<string, string> meta = 2

    Additional metadata to be returned when subsequently fetching the file. The metadata is placed on the CommitRequest so that stream- based operations (e.g. computing a checksum) may be performed during the transfer process.

  message CommitResponse

  upload.proto:88

  (message has no fields)

• rpc Fetch (FetchRequest, FetchResponse)

  upload.proto:158

  message FetchRequest

  upload.proto:90

  • optional tenant.ID tenant = 1

  • string path = 2

  • string remote_url = 3

    The URL to fetch.

  • map<string, string> remote_headers = 4

    Additional headers to append to the request, (e.g. Authorization).

  • string remote_method = 5

    The HTTP method to make the request with. Defaults to GET if unspecified.

  message FetchResponse

  upload.proto:116

  • int32 remote_http_code = 1

  • string remote_http_message = 2

• rpc Transfer (TransferRequest, TransferResponse)

  upload.proto:161

  message TransferRequest

  upload.proto:121

  • optional TransferState state = 1

    This state must be provided from either BeginResponse or a previous TransferResponse.

  • bytes data = 2

    The size of data must not exceed BeginResponse.max_chunk_size.

  message TransferResponse

  upload.proto:129

  • optional TransferState state = 1

    The state to pass into the next TransferRequest.

Used in: TransferState

• bytes data = 1

TransferState should be treated as an opaque value by the client. The structure of the message is not guaranteed by any API compatibility policy.

Used in: BeginResponse, CommitRequest, TransferRequest, TransferResponse

• optional ID ID = 1

• int64 offset = 2

• bytes data = 3

• optional google.protobuf.Timestamp deadline = 4

• optional tenant.ID tenant_id = 5

• bytes signature = 15