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

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

Overview

A write on a document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Write

Returns a new instance of Write.



2076
2077
2078
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2076

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

Instance Attribute Details

#current_documentGoogle::Apis::FirestoreV1beta1::Precondition

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



2040
2041
2042
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2040

def current_document
  @current_document
end

#deleteString

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

Returns:

  • (String)


2046
2047
2048
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2046

def delete
  @delete
end

#transformGoogle::Apis::FirestoreV1beta1::DocumentTransform

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



2051
2052
2053
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2051

def transform
  @transform
end

#updateGoogle::Apis::FirestoreV1beta1::Document

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



2057
2058
2059
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2057

def update
  @update
end

#update_maskGoogle::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



2066
2067
2068
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2066

def update_mask
  @update_mask
end

#update_transformsArray<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



2074
2075
2076
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2074

def update_transforms
  @update_transforms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2081
2082
2083
2084
2085
2086
2087
2088
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2081

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