Class: Google::Apis::FirestoreV1::DocumentsTarget

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 target specified by a set of documents names.

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

Returns a new instance of DocumentsTarget.


588
589
590
# File 'generated/google/apis/firestore_v1/classes.rb', line 588

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

Instance Attribute Details

#documentsArray<String>

The names of the documents to retrieve. In the format: projects/project_id/ databases/database_id/documents/document_path`. The request will fail if any of the document is not a child resource of the givendatabase. Duplicate names will be elided. Corresponds to the JSON propertydocuments`

Returns:

  • (Array<String>)

586
587
588
# File 'generated/google/apis/firestore_v1/classes.rb', line 586

def documents
  @documents
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


593
594
595
# File 'generated/google/apis/firestore_v1/classes.rb', line 593

def update!(**args)
  @documents = args[:documents] if args.key?(:documents)
end