Class: Google::Cloud::Firestore::V1::BatchWriteRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/firestore.rb

Overview

The request for Firestore.BatchWrite.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ ::String

Returns 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}.



872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 872

class BatchWriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels associated with this batch write.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels associated with this batch write.



872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 872

class BatchWriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#writes ⇒ ::Array<::Google::Cloud::Firestore::V1::Write>

Returns 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.



872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 872

class BatchWriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end