Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::WriteRequest.
The request for 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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#database
def database() -> ::String-
(::String) — Required. The database name. In the format:
projects/{project_id}/databases/{database_id}. This is only required in the first message.
#database=
def database=(value) -> ::String-
value (::String) — Required. The database name. In the format:
projects/{project_id}/databases/{database_id}. This is only required in the first message.
-
(::String) — Required. The database name. In the format:
projects/{project_id}/databases/{database_id}. This is only required in the first message.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}- (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this write request.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}- value (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this write request.
- (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this write request.
#stream_id
def stream_id() -> ::String- (::String) — 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.
#stream_id=
def stream_id=(value) -> ::String- value (::String) — 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.
- (::String) — 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.
#stream_token
def stream_token() -> ::String-
(::String) — 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_idfield.Leave this field unset when creating a new stream.
#stream_token=
def stream_token=(value) -> ::String-
value (::String) — 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_idfield.Leave this field unset when creating a new stream.
-
(::String) — 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_idfield.Leave this field unset when creating a new stream.
#writes
def writes() -> ::Array<::Google::Cloud::Firestore::V1::Write>-
(::Array<::Google::Cloud::Firestore::V1::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.
#writes=
def writes=(value) -> ::Array<::Google::Cloud::Firestore::V1::Write>-
value (::Array<::Google::Cloud::Firestore::V1::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.
-
(::Array<::Google::Cloud::Firestore::V1::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.