public static final class PartitionQueryResponse.Builder extends GeneratedMessageV3.Builder<PartitionQueryResponse.Builder> implements PartitionQueryResponseOrBuilderThe response for Firestore.PartitionQuery.
Protobuf type google.firestore.v1.PartitionQueryResponse
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PartitionQueryResponse.BuilderImplements
PartitionQueryResponseOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.firestore.v1.Cursor> |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
Cursor |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Cursor.Builder |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Cursor |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Cursor.Builder |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Cursor.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PartitionQueryResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
build()
public PartitionQueryResponse build()| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse |
|
buildPartial()
public PartitionQueryResponse buildPartial()| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse |
|
clear()
public PartitionQueryResponse.Builder clear()| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public PartitionQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
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 | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PartitionQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
clone()
public PartitionQueryResponse.Builder clone()| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
getDefaultInstanceForType()
public PartitionQueryResponse getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.firestore.v1.CursorOrBuilder> |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PartitionQueryResponse other)
public PartitionQueryResponse.Builder mergeFrom(PartitionQueryResponse other)| Parameter | |
|---|---|
| Name | Description |
other |
PartitionQueryResponse |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PartitionQueryResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PartitionQueryResponse.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PartitionQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public PartitionQueryResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe nextPageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for nextPageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Cursor |
| Returns | |
|---|---|
| Type | Description |
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, or that the query is not yet supported for partitioning.
repeated .google.firestore.v1.Cursor partitions = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Cursor.Builder |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PartitionQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final PartitionQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryResponse.Builder |
|