Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1338139174.7 KB
projects

Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).

post/v1/{+database}/documents:write

Path parameters

databasestring required

Required. The database name. In the format: projects/{project_id}/databases/{database_id}. This is only required in the first message.

Request body

streamIdstring

The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.

streamTokenstring byte

A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the stream_id field. Leave this field unset when creating a new stream.

labelsobject

Labels associated with this write request.

Response

Successful response