Class PartitionQueryRequest (3.26.5)

public final class PartitionQueryRequest extends GeneratedMessageV3 implements PartitionQueryRequestOrBuilder

The request for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PARTITION_COUNT_FIELD_NUMBER

public static final int PARTITION_COUNT_FIELD_NUMBER
Field Value
Type Description
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int

STRUCTURED_QUERY_FIELD_NUMBER

public static final int STRUCTURED_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PartitionQueryRequest getDefaultInstance()
Returns
Type Description
PartitionQueryRequest

getDescriptor()

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

newBuilder()

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

newBuilder(PartitionQueryRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getConsistencySelectorCase()

public PartitionQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
Type Description
PartitionQueryRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public PartitionQueryRequest getDefaultInstanceForType()
Returns
Type Description
PartitionQueryRequest

getPageSize()

public int getPageSize()

The maximum number of partitions to return in this call, subject to partition_count.

For example, if partition_count = 10 and page_size = 8, the first call to PartitionQuery will return up to 8 partitions and a next_page_token if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified in partition_count.

int32 page_size = 5;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

The next_page_token value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets.

For example, two subsequent calls using a page_token may return:

  • cursor B, cursor M, cursor Q
  • cursor A, cursor U, cursor W

    To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The next_page_token value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets.

For example, two subsequent calls using a page_token may return:

  • cursor B, cursor M, cursor Q
  • cursor A, cursor U, cursor W

    To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents. Document resource names are not supported; only database resource names can be specified.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents. Document resource names are not supported; only database resource names can be specified.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<PartitionQueryRequest> getParserForType()
Returns
Type Description
Parser<PartitionQueryRequest>
Overrides

getPartitionCount()

public long getPartitionCount()

The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer.

For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available.

int64 partition_count = 3;

Returns
Type Description
long

The partitionCount.

getQueryTypeCase()

public PartitionQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
Type Description
PartitionQueryRequest.QueryTypeCase

getReadTime()

public Timestamp getReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 6;

Returns
Type Description
Timestamp

The readTime.

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 6;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStructuredQuery()

public StructuredQuery getStructuredQuery()

A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.

.google.firestore.v1.StructuredQuery structured_query = 2;

Returns
Type Description
StructuredQuery

The structuredQuery.

getStructuredQueryOrBuilder()

public StructuredQueryOrBuilder getStructuredQueryOrBuilder()

A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.

.google.firestore.v1.StructuredQuery structured_query = 2;

Returns
Type Description
StructuredQueryOrBuilder

hasReadTime()

public boolean hasReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 6;

Returns
Type Description
boolean

Whether the readTime field is set.

hasStructuredQuery()

public boolean hasStructuredQuery()

A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.

.google.firestore.v1.StructuredQuery structured_query = 2;

Returns
Type Description
boolean

Whether the structuredQuery field is set.

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 PartitionQueryRequest.Builder newBuilderForType()
Returns
Type Description
PartitionQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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