Class WriteRequest (2.7.2)

Stay organized with collections Save and categorize content based on your preferences.
WriteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request for Firestore.Write][google.firestore.v1.Firestore.Write].

The first request creates a stream, or resumes an existing one from a token.

When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request.

When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

Attributes

NameDescription
database str
Required. The database name. In the format: projects/{project_id}/databases/{database_id}. This is only required in the first message.
stream_id str
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.
writes Sequence[google.cloud.firestore_v1.types.Write]
The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.
stream_token bytes
A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse][google.firestore.v1.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.
labels Mapping[str, str]
Labels associated with this write request.

Inheritance

builtins.object > proto.message.Message > WriteRequest

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.