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.



2199
2200
2201
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2199

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:



2166
2167
2168
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2166

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) 


2172
2173
2174
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2172

def delete
  @delete
end

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

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

Returns:



2177
2178
2179
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2177

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:



2182
2183
2184
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2182

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:



2190
2191
2192
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2190

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:



2197
2198
2199
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2197

def update_transforms
  @update_transforms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2204

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