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

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::ListDocumentsResponse

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

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

  The Documents found.

• #next_page_token ⇒ String

  A token to retrieve the next page of documents.

Instance Method Summary

• #initialize(**args) ⇒ ListDocumentsResponse constructor

  A new instance of ListDocumentsResponse.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ ListDocumentsResponse

Returns a new instance of ListDocumentsResponse.

# File 'lib/google/apis/firestore_v1/classes.rb', line 2936

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:

• (Array<Google::Apis::FirestoreV1::Document>)

# File 'lib/google/apis/firestore_v1/classes.rb', line 2928

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)

# File 'lib/google/apis/firestore_v1/classes.rb', line 2934

def next_page_token
  @next_page_token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/firestore_v1/classes.rb', line 2941

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