Class PartitionQueryResponse.Builder (3.2.0)

public static final class PartitionQueryResponse.Builder extends GeneratedMessageV3.Builder<PartitionQueryResponse.Builder> implements PartitionQueryResponseOrBuilder

The response for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllPartitions(Iterable<? extends Cursor> values)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameter
NameDescription
valuesIterable<? extends com.google.firestore.v1.Cursor>
Returns
TypeDescription
PartitionQueryResponse.Builder

addPartitions(Cursor value)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameter
NameDescription
valueCursor
Returns
TypeDescription
PartitionQueryResponse.Builder

addPartitions(Cursor.Builder builderForValue)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameter
NameDescription
builderForValueCursor.Builder
Returns
TypeDescription
PartitionQueryResponse.Builder

addPartitions(int index, Cursor value)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameters
NameDescription
indexint
valueCursor
Returns
TypeDescription
PartitionQueryResponse.Builder

addPartitions(int index, Cursor.Builder builderForValue)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameters
NameDescription
indexint
builderForValueCursor.Builder
Returns
TypeDescription
PartitionQueryResponse.Builder

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Returns
TypeDescription
Cursor.Builder

addPartitionsBuilder(int index)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Cursor.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PartitionQueryResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

build()

public PartitionQueryResponse build()
Returns
TypeDescription
PartitionQueryResponse

buildPartial()

public PartitionQueryResponse buildPartial()
Returns
TypeDescription
PartitionQueryResponse

clear()

public PartitionQueryResponse.Builder clear()
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PartitionQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PartitionQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Returns
TypeDescription
PartitionQueryResponse.Builder

clone()

public PartitionQueryResponse.Builder clone()
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

getDefaultInstanceForType()

public PartitionQueryResponse getDefaultInstanceForType()
Returns
TypeDescription
PartitionQueryResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getPartitions(int index)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Cursor

getPartitionsBuilder(int index)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Cursor.Builder

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Returns
TypeDescription
List<Builder>

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Returns
TypeDescription
int

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Returns
TypeDescription
List<Cursor>

getPartitionsOrBuilder(int index)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
CursorOrBuilder

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Returns
TypeDescription
List<? extends com.google.firestore.v1.CursorOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PartitionQueryResponse other)

public PartitionQueryResponse.Builder mergeFrom(PartitionQueryResponse other)
Parameter
NameDescription
otherPartitionQueryResponse
Returns
TypeDescription
PartitionQueryResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PartitionQueryResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PartitionQueryResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PartitionQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

removePartitions(int index)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
PartitionQueryResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PartitionQueryResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

setNextPageToken(String value)

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;

Parameter
NameDescription
valueString

The nextPageToken to set.

Returns
TypeDescription
PartitionQueryResponse.Builder

This builder for chaining.

setNextPageTokenBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for nextPageToken to set.

Returns
TypeDescription
PartitionQueryResponse.Builder

This builder for chaining.

setPartitions(int index, Cursor value)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameters
NameDescription
indexint
valueCursor
Returns
TypeDescription
PartitionQueryResponse.Builder

setPartitions(int index, Cursor.Builder builderForValue)

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.

repeated .google.firestore.v1.Cursor partitions = 1;

Parameters
NameDescription
indexint
builderForValueCursor.Builder
Returns
TypeDescription
PartitionQueryResponse.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PartitionQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PartitionQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides