Class: Google::Cloud::Firestore::V1::UpdateDocumentRequest

Inherits:

Object

• Object
• Google::Cloud::Firestore::V1::UpdateDocumentRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/firestore/v1/firestore.rb

Overview

The request for Firestore.UpdateDocument.

Instance Attribute Summary

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

  An optional precondition on the document.

• #document ⇒ ::Google::Cloud::Firestore::V1::Document

  Required.

• #mask ⇒ ::Google::Cloud::Firestore::V1::DocumentMask

  The fields to return.

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

  The fields to update.

Instance Attribute Details

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

Returns An optional precondition on the document. The request will fail if this is set and not met by the target document.

Returns:

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

  An optional precondition on the document. The request will fail if this is set and not met by the target document.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 160

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

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

Returns Required. The updated document. Creates the document if it does not already exist.

Returns:

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

  Required. The updated document. Creates the document if it does not already exist.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 160

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

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

Returns The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

Returns:

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

  The fields to return. If not set, returns all fields.

  If the document has a field that is not present in this mask, that field will not be returned in the response.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 160

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

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

Returns The fields to update. None of the field paths in the mask may contain a reserved name.

If the document exists on the server and has fields not referenced in 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.

Returns:

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

  The fields to update. None of the field paths in the mask may contain a reserved name.

  If the document exists on the server and has fields not referenced in 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.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 160

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