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

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::PartitionQueryResponse

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

The response for Firestore.PartitionQuery.

Instance Attribute Summary

• #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.

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

  Partition results.

Instance Method Summary

• #initialize(**args) ⇒ PartitionQueryResponse constructor

  A new instance of PartitionQueryResponse.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ PartitionQueryResponse

Returns a new instance of PartitionQueryResponse.

# File 'generated/google/apis/firestore_v1/classes.rb', line 1870

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)

# File 'generated/google/apis/firestore_v1/classes.rb', line 1855

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:

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

# File 'generated/google/apis/firestore_v1/classes.rb', line 1868

def partitions
  @partitions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/firestore_v1/classes.rb', line 1875

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