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

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

Overview

A target specified by a set of documents names.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DocumentsTarget

Returns a new instance of DocumentsTarget.



803
804
805
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 803

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

Instance Attribute Details

#documents ⇒ Array<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>) 


801
802
803
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 801

def documents
  @documents
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



808
809
810
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 808

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