Class: Google::Apis::FirestoreV1beta1::Write

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1beta1/classes.rb,
lib/google/apis/firestore_v1beta1/representations.rb,
lib/google/apis/firestore_v1beta1/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.



2984
2985
2986
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2984

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

Instance Attribute Details

#current_document ⇒ Google::Apis::FirestoreV1beta1::Precondition

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

Returns:



2951
2952
2953
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2951

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) 


2957
2958
2959
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2957

def delete
  @delete
end

#transform ⇒ Google::Apis::FirestoreV1beta1::DocumentTransform

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

Returns:



2962
2963
2964
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2962

def transform
  @transform
end

#update ⇒ Google::Apis::FirestoreV1beta1::Document

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

Returns:



2967
2968
2969
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2967

def update
  @update
end

#update_mask ⇒ Google::Apis::FirestoreV1beta1::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:



2975
2976
2977
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2975

def update_mask
  @update_mask
end

#update_transforms ⇒ Array<Google::Apis::FirestoreV1beta1::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:



2982
2983
2984
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2982

def update_transforms
  @update_transforms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2989
2990
2991
2992
2993
2994
2995
2996
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2989

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