Class: Google::Cloud::Firestore::V1::Write

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

Overview

A write on a document.

Instance Attribute Summary collapse

Instance Attribute Details

#current_document ⇒ ::Google::Cloud::Firestore::V1::Precondition

Returns An optional precondition on the document.

The write will fail if this is set and not met by the target document.

Returns:



65
66
67
68
 
# File 'proto_docs/google/firestore/v1/write.rb', line 65

class Write
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#delete ⇒ ::String

Returns A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Note: The following fields are mutually exclusive: delete, update, transform. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

    Note: The following fields are mutually exclusive: delete, update, transform. If a field in that set is populated, all other fields in the set will automatically be cleared.



65
66
67
68
 
# File 'proto_docs/google/firestore/v1/write.rb', line 65

class Write
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transform ⇒ ::Google::Cloud::Firestore::V1::DocumentTransform

Returns Applies a transformation to a document.

Note: The following fields are mutually exclusive: transform, update, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Firestore::V1::DocumentTransform) —

    Applies a transformation to a document.

    Note: The following fields are mutually exclusive: transform, update, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.



65
66
67
68
 
# File 'proto_docs/google/firestore/v1/write.rb', line 65

class Write
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update ⇒ ::Google::Cloud::Firestore::V1::Document

Returns A document to write.

Note: The following fields are mutually exclusive: update, delete, transform. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Firestore::V1::Document) —

    A document to write.

    Note: The following fields are mutually exclusive: update, delete, transform. If a field in that set is populated, all other fields in the set will automatically be cleared.



65
66
67
68
 
# File 'proto_docs/google/firestore/v1/write.rb', line 65

class Write
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Cloud::Firestore::V1::DocumentMask

Returns The fields to update in this write.

This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.

Returns:

  • (::Google::Cloud::Firestore::V1::DocumentMask) —

    The fields to update in this write.

    This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.



65
66
67
68
 
# File 'proto_docs/google/firestore/v1/write.rb', line 65

class Write
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_transforms ⇒ ::Array<::Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform>

Returns The transforms to perform after update.

This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

Returns:



65
66
67
68
 
# File 'proto_docs/google/firestore/v1/write.rb', line 65

class Write
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end