Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::BatchWriteRequest.
The request for Firestore.BatchWrite.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#database
def database() -> ::String
Returns
-
(::String) — Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
#database=
def database=(value) -> ::String
Parameter
-
value (::String) — Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
Returns
-
(::String) — Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this batch write.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this batch write.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this batch write.
#writes
def writes() -> ::Array<::Google::Cloud::Firestore::V1::Write>
Returns
-
(::Array<::Google::Cloud::Firestore::V1::Write>) — The writes to apply.
Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.
#writes=
def writes=(value) -> ::Array<::Google::Cloud::Firestore::V1::Write>
Parameter
-
value (::Array<::Google::Cloud::Firestore::V1::Write>) — The writes to apply.
Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.
Returns
-
(::Array<::Google::Cloud::Firestore::V1::Write>) — The writes to apply.
Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.