WriteRequest

  • The ByteStream.Write request object allows writing data to a cloud resource, potentially in chunks.

  • It requires specifying the resource name, data to write, and the write offset within the resource.

  • For the initial write request, the offset should typically be 0, and for subsequent requests, it should be the cumulative size of previous writes.

  • Setting finishWrite to true signals completion of the write operation, and further requests will result in an error.

Request object for ByteStream.Write.

JSON representation 
{
  "resourceName": string,
  "writeOffset": string,
  "finishWrite": boolean,
  "data": string
}
Fields
resourceName

string

The name of the resource to write. This must be set on the first WriteRequest of each Write() action. If it is set on subsequent calls, it must match the value of the first request.
writeOffset

string (int64 format)

The offset from the beginning of the resource at which the data should be written. It is required on all WriteRequests.

In the first WriteRequest of a Write() action, it indicates the initial offset for the Write() call. The value must be equal to the committedSize that a call to QueryWriteStatus() would return.

On subsequent calls, this value must be set and must be equal to the sum of the first writeOffset and the sizes of all data bundles sent previously on this stream.

An incorrect value will cause an error.
finishWrite

boolean

If true, this indicates that the write is complete. Sending any WriteRequests subsequent to one in which finishWrite is true will cause an error.
data

string (bytes format)

A portion of the data for the resource. The client may leave data empty for any given WriteRequest. This enables the client to inform the service that the request is still live while it is running an operation to generate more data.

A base64-encoded string.