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.



2607
2608
2609
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2607

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:



2574
2575
2576
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2574

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) 


2580
2581
2582
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2580

def delete
  @delete
end

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

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

Returns:



2585
2586
2587
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2585

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:



2590
2591
2592
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2590

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:



2598
2599
2600
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2598

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:



2605
2606
2607
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2605

def update_transforms
  @update_transforms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2612
2613
2614
2615
2616
2617
2618
2619
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2612

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