Class: Google::Apis::FirestoreV1::PartitionQueryRequest

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 request for Firestore.PartitionQuery.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PartitionQueryRequest

Returns a new instance of PartitionQueryRequest.



1901
1902
1903
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1901

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

Instance Attribute Details

#page_size ⇒ Fixnum

The maximum number of partitions to return in this call, subject to partition_count. For example, if partition_count = 10 and page_size = 8, the first call to PartitionQuery will return up to 8 partitions and a next_page_token if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified in partition_count. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


1872
1873
1874
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1872

def page_size
  @page_size
end

#page_token ⇒ String

The next_page_token value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W Corresponds to the JSON property pageToken

Returns:

  • (String) 


1884
1885
1886
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1884

def page_token
  @page_token
end

#partition_count ⇒ Fixnum

The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available. Corresponds to the JSON property partitionCount

Returns:

  • (Fixnum) 


1894
1895
1896
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1894

def partition_count
  @partition_count
end

#structured_query ⇒ Google::Apis::FirestoreV1::StructuredQuery

A Firestore query. Corresponds to the JSON property structuredQuery

Returns:



1899
1900
1901
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1899

def structured_query
  @structured_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1906
1907
1908
1909
1910
1911
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1906

def update!(**args)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @partition_count = args[:partition_count] if args.key?(:partition_count)
  @structured_query = args[:structured_query] if args.key?(:structured_query)
end