Skip to main content

Module batch

Module batch 

Source
Expand description

Wire types of the JSON layout of the batch endpoint.

In this layout, the operation at position i of a request is described by a Descriptor part named "<i>". The server answers with a ResultPart named "<i>" per operation, in completion order. A part named "<i>.payload" carries the object bytes of an insert in a request, or of a successful get in a response, and directly follows the part it belongs to.

Structs§

ResultPart
The JSON body of a result part, which reports the outcome of one operation.

Enums§

Descriptor
The JSON body of a descriptor part, which describes one operation of a request.
OperationKind
The kind of a batch operation.

Constants§

MAX_BATCH_OPERATIONS
Maximum number of operations in one batch request.
MAX_BATCH_PART_SIZE
Maximum size in bytes of the body of a part that carries object bytes.
MAX_DESCRIPTOR_SIZE
Maximum size in bytes of the body of a Descriptor part.
PAYLOAD_SUFFIX
Suffix that marks a payload part.

Functions§

payload_part_name
Returns the name of the payload part of the operation at index, for example "0.payload".