Class: Google::Apis::FirestoreV1::Document

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

Overview

A Firestore document. Must not exceed 1 MiB - 4 bytes.

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) ⇒ Document

Returns a new instance of Document



368
369
370
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 368

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the read_time of a query. Corresponds to the JSON property createTime

Returns:

  • (String) 


329
330
331
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 329

def create_time
  @create_time
end

#fields ⇒ Hash<String,Google::Apis::FirestoreV1::Value>

The document's fields. The map keys represent field names. A simple field name contains only characters a to z, A to Z, 0 to 9, or _, and must not start with 0 to 9. For example, foo_bar_17. Field names matching the regular expression __.*__ are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For map_value, the field path is represented by the simple or quoted field names of the containing fields, delimited by .. For example, the structured field "foo" : map_value: "x&y" : string_value: "hello" ``would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with and may contain any character. Some characters, including , must be escaped using a `\`. For example, x&y represents `x&y` and bak\tikrepresentsbaktik `. Corresponds to the JSON propertyfields`

Returns:



352
353
354
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 352

def fields
  @fields
end

#name ⇒ String

The resource name of the document, for example projects/project_id/databases/database_id/documents/document_path`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


358
359
360
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 358

def name
  @name
end

#update_time ⇒ String

Output only. The time at which the document was last changed. This value is initially set to the create_time then increases monotonically with each change to the document. It can also be compared to values from other documents and the read_time of a query. Corresponds to the JSON property updateTime

Returns:

  • (String) 


366
367
368
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 366

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



373
374
375
376
377
378
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 373

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @fields = args[:fields] if args.key?(:fields)
  @name = args[:name] if args.key?(:name)
  @update_time = args[:update_time] if args.key?(:update_time)
end