Interface PartitionQueryRequestOrBuilder (3.20.0)

public interface PartitionQueryRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConsistencySelectorCase()

public abstract PartitionQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()

Returns
Type	Description
`PartitionQueryRequest.ConsistencySelectorCase`

getPageSize()

public abstract int getPageSize()

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.

int32 page_size = 5;

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public abstract String getPageToken()

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

string page_token = 4;

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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

string page_token = 4;

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents. Document resource names are not supported; only database resource names can be specified.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents. Document resource names are not supported; only database resource names can be specified.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for parent.

getPartitionCount()

public abstract long getPartitionCount()

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.

int64 partition_count = 3;

Returns
Type	Description
`long`	The partitionCount.

getQueryTypeCase()

public abstract PartitionQueryRequest.QueryTypeCase getQueryTypeCase()

Returns
Type	Description
`PartitionQueryRequest.QueryTypeCase`

getReadTime()

public abstract Timestamp getReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`Timestamp`	The readTime.

getReadTimeOrBuilder()

public abstract TimestampOrBuilder getReadTimeOrBuilder()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`TimestampOrBuilder`

getStructuredQuery()

public abstract StructuredQuery getStructuredQuery()

A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.

.google.firestore.v1.StructuredQuery structured_query = 2;

Returns
Type	Description
`StructuredQuery`	The structuredQuery.

getStructuredQueryOrBuilder()

public abstract StructuredQueryOrBuilder getStructuredQueryOrBuilder()

A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.

.google.firestore.v1.StructuredQuery structured_query = 2;

Returns
Type	Description
`StructuredQueryOrBuilder`

hasReadTime()

public abstract boolean hasReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`boolean`	Whether the readTime field is set.

hasStructuredQuery()

public abstract boolean hasStructuredQuery()

A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.

.google.firestore.v1.StructuredQuery structured_query = 2;

Returns
Type	Description
`boolean`	Whether the structuredQuery field is set.