Class: Google::Apis::FirestoreV1::PartitionQueryResponse

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.PartitionQuery.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PartitionQueryResponse

Returns a new instance of PartitionQueryResponse.



1966
1967
1968
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1966

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

Instance Attribute Details

#next_page_token ⇒ String

A page token that may be used to request an additional set of results, up to the number specified by partition_count in the PartitionQuery request. If blank, there are no more results. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


1951
1952
1953
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1951

def next_page_token
  @next_page_token
end

#partitions ⇒ Array<Google::Apis::FirestoreV1::Cursor>

Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned. Corresponds to the JSON property partitions

Returns:



1964
1965
1966
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1964

def partitions
  @partitions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1971
1972
1973
1974
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1971

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