Package com.google.firestore.v1

Class PartitionQueryResponse.Builder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

      public PartitionQueryResponse.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.GeneratedMessage.Builder<PartitionQueryResponse.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.GeneratedMessage.Builder<PartitionQueryResponse.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public PartitionQueryResponse.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<PartitionQueryResponse.Builder>

    • mergeFrom

      public PartitionQueryResponse.Builder mergeFrom(PartitionQueryResponse other)

    • isInitialized

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

    • mergeFrom

      public PartitionQueryResponse.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<PartitionQueryResponse.Builder>
      Throws:
      IOException

    • getPartitionsList

      public List<Cursor> getPartitionsList()
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitionsList in interface PartitionQueryResponseOrBuilder

    • getPartitionsCount

      public int getPartitionsCount()
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitionsCount in interface PartitionQueryResponseOrBuilder

    • getPartitions

      public Cursor getPartitions(int index)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitions in interface PartitionQueryResponseOrBuilder

    • setPartitions

      public PartitionQueryResponse.Builder setPartitions(int index, Cursor value)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • setPartitions

      public PartitionQueryResponse.Builder setPartitions(int index, Cursor.Builder builderForValue)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • addPartitions

      public PartitionQueryResponse.Builder addPartitions(Cursor value)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • addPartitions

      public PartitionQueryResponse.Builder addPartitions(int index, Cursor value)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • addPartitions

      public PartitionQueryResponse.Builder addPartitions(Cursor.Builder builderForValue)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • addPartitions

      public PartitionQueryResponse.Builder addPartitions(int index, Cursor.Builder builderForValue)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • addAllPartitions

      public PartitionQueryResponse.Builder addAllPartitions(Iterable<? extends Cursor> values)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • clearPartitions

      public PartitionQueryResponse.Builder clearPartitions()
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • removePartitions

      public PartitionQueryResponse.Builder removePartitions(int index)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • getPartitionsBuilder

      public Cursor.Builder getPartitionsBuilder(int index)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • getPartitionsOrBuilder

      public CursorOrBuilder getPartitionsOrBuilder(int index)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitionsOrBuilder in interface PartitionQueryResponseOrBuilder

    • getPartitionsOrBuilderList

      public List<? extends CursorOrBuilder> getPartitionsOrBuilderList()
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitionsOrBuilderList in interface PartitionQueryResponseOrBuilder

    • addPartitionsBuilder

      public Cursor.Builder addPartitionsBuilder()
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • addPartitionsBuilder

      public Cursor.Builder addPartitionsBuilder(int index)
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • getPartitionsBuilderList

      public List<Cursor.Builder> getPartitionsBuilderList()
       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, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;

    • getNextPageToken

      public String getNextPageToken()
       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.
      string next_page_token = 2;
      Specified by:
      getNextPageToken in interface PartitionQueryResponseOrBuilder
      Returns:
      The nextPageToken.

    • getNextPageTokenBytes

      public com.google.protobuf.ByteString getNextPageTokenBytes()
       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.
      string next_page_token = 2;
      Specified by:
      getNextPageTokenBytes in interface PartitionQueryResponseOrBuilder
      Returns:
      The bytes for nextPageToken.

    • setNextPageToken

      public PartitionQueryResponse.Builder setNextPageToken(String value)
       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.
      string next_page_token = 2;
      Parameters:
      value - The nextPageToken to set.
      Returns:
      This builder for chaining.

    • clearNextPageToken

      public PartitionQueryResponse.Builder clearNextPageToken()
       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.
      string next_page_token = 2;
      Returns:
      This builder for chaining.

    • setNextPageTokenBytes

      public PartitionQueryResponse.Builder setNextPageTokenBytes(com.google.protobuf.ByteString value)
       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.
      string next_page_token = 2;
      Parameters:
      value - The bytes for nextPageToken to set.
      Returns:
      This builder for chaining.