Class: Google::Apis::FirestoreV1::ListDocumentsResponse

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

The response for Firestore.ListDocuments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ListDocumentsResponse

Returns a new instance of ListDocumentsResponse.



3308
3309
3310
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3308

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

Instance Attribute Details

#documents ⇒ Array<Google::Apis::FirestoreV1::Document>

The Documents found. Corresponds to the JSON property documents

Returns:



3300
3301
3302
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3300

def documents
  @documents
end

#next_page_token ⇒ String

A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


3306
3307
3308
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3306

def next_page_token
  @next_page_token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3313
3314
3315
3316
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3313

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