Class PartitionQueryResponse

public final class PartitionQueryResponse extends GeneratedMessageV3 implements PartitionQueryResponseOrBuilder

The response for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryResponse

Fields

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITIONS_FIELD_NUMBER

public static final int PARTITIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static PartitionQueryResponse getDefaultInstance()
Returns
TypeDescription
PartitionQueryResponse

getDefaultInstanceForType()

public PartitionQueryResponse getDefaultInstanceForType()
Returns
TypeDescription
PartitionQueryResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
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.

getParserForType()

public Parser<PartitionQueryResponse> getParserForType()
Returns
TypeDescription
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.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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.

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>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static PartitionQueryResponse.Builder newBuilder()
Returns
TypeDescription
PartitionQueryResponse.Builder

newBuilder(PartitionQueryResponse prototype)

public static PartitionQueryResponse.Builder newBuilder(PartitionQueryResponse prototype)
Parameter
NameDescription
prototypePartitionQueryResponse
Returns
TypeDescription
PartitionQueryResponse.Builder

newBuilderForType()

public PartitionQueryResponse.Builder newBuilderForType()
Returns
TypeDescription
PartitionQueryResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PartitionQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PartitionQueryResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static PartitionQueryResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PartitionQueryResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PartitionQueryResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PartitionQueryResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PartitionQueryResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PartitionQueryResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PartitionQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PartitionQueryResponse> parser()
Returns
TypeDescription
Parser<PartitionQueryResponse>

toBuilder()

public PartitionQueryResponse.Builder toBuilder()
Returns
TypeDescription
PartitionQueryResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException