Class: Google::Apis::FirestoreV1beta1::WriteRequest
- Inherits:
-
Object
- Object
- Google::Apis::FirestoreV1beta1::WriteRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/firestore_v1beta1/classes.rb,
generated/google/apis/firestore_v1beta1/representations.rb,
generated/google/apis/firestore_v1beta1/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#labels ⇒ Hash<String,String>
Labels associated with this write request.
-
#stream_id ⇒ String
The ID of the write stream to resume.
-
#stream_token ⇒ String
A stream token that was previously sent by the server.
-
#writes ⇒ Array<Google::Apis::FirestoreV1beta1::Write>
The writes to apply.
Instance Method Summary collapse
-
#initialize(**args) ⇒ WriteRequest
constructor
A new instance of WriteRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ WriteRequest
Returns a new instance of WriteRequest
2233 2234 2235 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2233 def initialize(**args) update!(**args) end |
Instance Attribute Details
#labels ⇒ Hash<String,String>
Labels associated with this write request.
Corresponds to the JSON property labels
2200 2201 2202 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2200 def labels @labels end |
#stream_id ⇒ 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.
Corresponds to the JSON property streamId
2207 2208 2209 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2207 def stream_id @stream_id end |
#stream_token ⇒ 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_id
field.
Leave this field unset when creating a new stream.
Corresponds to the JSON property streamToken
NOTE: Values are automatically base64 encoded/decoded in the client library.
2222 2223 2224 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2222 def stream_token @stream_token end |
#writes ⇒ Array<Google::Apis::FirestoreV1beta1::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.
Corresponds to the JSON property writes
2231 2232 2233 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2231 def writes @writes end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2238 2239 2240 2241 2242 2243 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2238 def update!(**args) @labels = args[:labels] if args.key?(:labels) @stream_id = args[:stream_id] if args.key?(:stream_id) @stream_token = args[:stream_token] if args.key?(:stream_token) @writes = args[:writes] if args.key?(:writes) end |