Package com.google.firestore.v1

Interface PartitionQueryRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PartitionQueryRequest, PartitionQueryRequest.Builder
public interface PartitionQueryRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getParent

      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:
      The parent.

    • getParentBytes

      com.google.protobuf.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:
      The bytes for parent.

    • hasStructuredQuery

      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:
      Whether the structuredQuery field is set.

    • getStructuredQuery

      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:
      The structuredQuery.

    • getStructuredQueryOrBuilder

      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;

    • getPartitionCount

      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:
      The partitionCount.

    • getPageToken

      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:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       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:
      The bytes for pageToken.

    • getPageSize

      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:
      The pageSize.

    • hasReadTime

      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:
      Whether the readTime field is set.

    • getReadTime

      com.google.protobuf.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:
      The readTime.

    • getReadTimeOrBuilder

      com.google.protobuf.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;

    • getQueryTypeCase

      PartitionQueryRequest.QueryTypeCase getQueryTypeCase()

    • getConsistencySelectorCase

      PartitionQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()