Class PartitionQueryResponse (3.22.0)

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()
Returns
Type Description
PartitionQueryResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PartitionQueryResponse.Builder newBuilder()
Returns
Type Description
PartitionQueryResponse.Builder

newBuilder(PartitionQueryResponse prototype)

public static PartitionQueryResponse.Builder newBuilder(PartitionQueryResponse prototype)
Parameter
Name Description
prototype PartitionQueryResponse
Returns
Type Description
PartitionQueryResponse.Builder

parseDelimitedFrom(InputStream input)

public static PartitionQueryResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PartitionQueryResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PartitionQueryResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PartitionQueryResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PartitionQueryResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PartitionQueryResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PartitionQueryResponse> parser()
Returns
Type Description
Parser<PartitionQueryResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PartitionQueryResponse getDefaultInstanceForType()
Returns
Type Description
PartitionQueryResponse

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()
Returns
Type Description
Parser<PartitionQueryResponse>
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, 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

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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PartitionQueryResponse.Builder newBuilderForType()
Returns
Type Description
PartitionQueryResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PartitionQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PartitionQueryResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PartitionQueryResponse.Builder toBuilder()
Returns
Type Description
PartitionQueryResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException