Class: Google::Apis::FirestoreV1::Write

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

A write on a document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Write

Returns a new instance of Write.



3712
3713
3714
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3712

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#current_document ⇒ Google::Apis::FirestoreV1::Precondition

A precondition on a document, used for conditional operations. Corresponds to the JSON property currentDocument

Returns:



3679
3680
3681
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3679

def current_document
  @current_document
end

#delete ⇒ String

A document name to delete. In the format: projects/project_id/databases/ database_id/documents/document_path`. Corresponds to the JSON propertydelete`

Returns:

  • (String) 


3685
3686
3687
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3685

def delete
  @delete
end

#transform ⇒ Google::Apis::FirestoreV1::DocumentTransform

A transformation of a document. Corresponds to the JSON property transform

Returns:



3690
3691
3692
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3690

def transform
  @transform
end

#update ⇒ Google::Apis::FirestoreV1::Document

A Firestore document. Must not exceed 1 MiB - 4 bytes. Corresponds to the JSON property update

Returns:



3695
3696
3697
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3695

def update
  @update
end

#update_mask ⇒ Google::Apis::FirestoreV1::DocumentMask

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value. Corresponds to the JSON property updateMask

Returns:



3703
3704
3705
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3703

def update_mask
  @update_mask
end

#update_transforms ⇒ Array<Google::Apis::FirestoreV1::FieldTransform>

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. Corresponds to the JSON property updateTransforms

Returns:



3710
3711
3712
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3710

def update_transforms
  @update_transforms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3717
3718
3719
3720
3721
3722
3723
3724
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3717

def update!(**args)
  @current_document = args[:current_document] if args.key?(:current_document)
  @delete = args[:delete] if args.key?(:delete)
  @transform = args[:transform] if args.key?(:transform)
  @update = args[:update] if args.key?(:update)
  @update_mask = args[:update_mask] if args.key?(:update_mask)
  @update_transforms = args[:update_transforms] if args.key?(:update_transforms)
end