public final class PartitionQueryResponse extends GeneratedMessageV3 implements PartitionQueryResponseOrBuilder
The response for
Firestore.PartitionQuery.
Protobuf type google.firestore.v1.PartitionQueryResponse
Static Fields
NEXT_PAGE_TOKEN_FIELD_NUMBER
public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARTITIONS_FIELD_NUMBER
public static final int PARTITIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static PartitionQueryResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PartitionQueryResponse.Builder newBuilder()
newBuilder(PartitionQueryResponse prototype)
public static PartitionQueryResponse.Builder newBuilder(PartitionQueryResponse prototype)
public static PartitionQueryResponse parseDelimitedFrom(InputStream input)
public static PartitionQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PartitionQueryResponse parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PartitionQueryResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryResponse parseFrom(CodedInputStream input)
public static PartitionQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryResponse parseFrom(InputStream input)
public static PartitionQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PartitionQueryResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PartitionQueryResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public PartitionQueryResponse getDefaultInstanceForType()
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.
|
getParserForType()
public Parser<PartitionQueryResponse> getParserForType()
Overrides
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| 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.
repeated .google.firestore.v1.Cursor partitions = 1;
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.firestore.v1.CursorOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PartitionQueryResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PartitionQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public PartitionQueryResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
