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
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
PARTITION_COUNT_FIELD_NUMBER
public static final int PARTITION_COUNT_FIELD_NUMBER
Field Value
STRUCTURED_QUERY_FIELD_NUMBER
public static final int STRUCTURED_QUERY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PartitionQueryRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PartitionQueryRequest.Builder newBuilder()
Returns
newBuilder(PartitionQueryRequest prototype)
public static PartitionQueryRequest.Builder newBuilder(PartitionQueryRequest prototype)
Parameter
Returns
public static PartitionQueryRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PartitionQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PartitionQueryRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PartitionQueryRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PartitionQueryRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PartitionQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PartitionQueryRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PartitionQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PartitionQueryRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PartitionQueryRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public PartitionQueryRequest getDefaultInstanceForType()
Returns
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;
| 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;
| 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;
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];
| 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];
getParserForType()
public Parser<PartitionQueryRequest> getParserForType()
Returns
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;
| Type | Description |
| long | The partitionCount.
|
getQueryTypeCase()
public PartitionQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
getSerializedSize()
public int getSerializedSize()
Returns
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;
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
| boolean | Whether the structuredQuery field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PartitionQueryRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PartitionQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PartitionQueryRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
