Package com.google.firestore.v1

Class PartitionQueryRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>
com.google.firestore.v1.PartitionQueryRequest.Builder
All Implemented Interfaces:
PartitionQueryRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PartitionQueryRequest
public static final class PartitionQueryRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder> implements PartitionQueryRequestOrBuilder
 The request for
 [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].
Protobuf type google.firestore.v1.PartitionQueryRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • clear

      public PartitionQueryRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • getDefaultInstanceForType

      public PartitionQueryRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public PartitionQueryRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public PartitionQueryRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public PartitionQueryRequest.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • setField

      public PartitionQueryRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • clearField

      public PartitionQueryRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • clearOneof

      public PartitionQueryRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • setRepeatedField

      public PartitionQueryRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • addRepeatedField

      public PartitionQueryRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • mergeFrom

      public PartitionQueryRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartitionQueryRequest.Builder>

    • mergeFrom

      public PartitionQueryRequest.Builder mergeFrom(PartitionQueryRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • mergeFrom

      public PartitionQueryRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartitionQueryRequest.Builder>
      Throws:
      IOException

    • getQueryTypeCase

      public PartitionQueryRequest.QueryTypeCase getQueryTypeCase()
      Specified by:
      getQueryTypeCase in interface PartitionQueryRequestOrBuilder

    • clearQueryType

      public PartitionQueryRequest.Builder clearQueryType()

    • getConsistencySelectorCase

      public PartitionQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
      Specified by:
      getConsistencySelectorCase in interface PartitionQueryRequestOrBuilder

    • clearConsistencySelector

      public PartitionQueryRequest.Builder clearConsistencySelector()

    • getParent

      public 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];
      Specified by:
      getParent in interface PartitionQueryRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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];
      Specified by:
      getParentBytes in interface PartitionQueryRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public PartitionQueryRequest.Builder setParent(String value)
       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];
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public PartitionQueryRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public PartitionQueryRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • hasStructuredQuery

      public 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;
      Specified by:
      hasStructuredQuery in interface PartitionQueryRequestOrBuilder
      Returns:
      Whether the structuredQuery field is set.

    • getStructuredQuery

      public 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;
      Specified by:
      getStructuredQuery in interface PartitionQueryRequestOrBuilder
      Returns:
      The structuredQuery.

    • setStructuredQuery

      public PartitionQueryRequest.Builder setStructuredQuery(StructuredQuery value)
       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;

    • setStructuredQuery

      public PartitionQueryRequest.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)
       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;

    • mergeStructuredQuery

      public PartitionQueryRequest.Builder mergeStructuredQuery(StructuredQuery value)
       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;

    • clearStructuredQuery

      public PartitionQueryRequest.Builder clearStructuredQuery()
       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;

    • getStructuredQueryBuilder

      public StructuredQuery.Builder getStructuredQueryBuilder()
       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;

    • getStructuredQueryOrBuilder

      public 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;
      Specified by:
      getStructuredQueryOrBuilder in interface PartitionQueryRequestOrBuilder

    • getPartitionCount

      public 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;
      Specified by:
      getPartitionCount in interface PartitionQueryRequestOrBuilder
      Returns:
      The partitionCount.

    • setPartitionCount

      public PartitionQueryRequest.Builder setPartitionCount(long value)
       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;
      Parameters:
      value - The partitionCount to set.
      Returns:
      This builder for chaining.

    • clearPartitionCount

      public PartitionQueryRequest.Builder clearPartitionCount()
       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:
      This builder for chaining.

    • getPageToken

      public 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;
      Specified by:
      getPageToken in interface PartitionQueryRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public 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;
      Specified by:
      getPageTokenBytes in interface PartitionQueryRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public PartitionQueryRequest.Builder setPageToken(String value)
       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;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public PartitionQueryRequest.Builder clearPageToken()
       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:
      This builder for chaining.

    • setPageTokenBytes

      public PartitionQueryRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public 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;
      Specified by:
      getPageSize in interface PartitionQueryRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public PartitionQueryRequest.Builder setPageSize(int value)
       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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public PartitionQueryRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • hasReadTime

      public 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;
      Specified by:
      hasReadTime in interface PartitionQueryRequestOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public 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;
      Specified by:
      getReadTime in interface PartitionQueryRequestOrBuilder
      Returns:
      The readTime.

    • setReadTime

      public PartitionQueryRequest.Builder setReadTime(com.google.protobuf.Timestamp value)
       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;

    • setReadTime

      public PartitionQueryRequest.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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;

    • mergeReadTime

      public PartitionQueryRequest.Builder mergeReadTime(com.google.protobuf.Timestamp value)
       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;

    • clearReadTime

      public PartitionQueryRequest.Builder clearReadTime()
       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;

    • getReadTimeBuilder

      public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
       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;

    • getReadTimeOrBuilder

      public 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;
      Specified by:
      getReadTimeOrBuilder in interface PartitionQueryRequestOrBuilder

    • setUnknownFields

      public final PartitionQueryRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>

    • mergeUnknownFields

      public final PartitionQueryRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>