public static final class PartitionQueryRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder> implements PartitionQueryRequestOrBuilder
The request for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].Protobuf type
google.firestore.v1.PartitionQueryRequest| Modifier and Type | Method and Description |
|---|---|
PartitionQueryRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PartitionQueryRequest |
build() |
PartitionQueryRequest |
buildPartial() |
PartitionQueryRequest.Builder |
clear() |
PartitionQueryRequest.Builder |
clearConsistencySelector() |
PartitionQueryRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
PartitionQueryRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
PartitionQueryRequest.Builder |
clearPageSize()
The maximum number of partitions to return in this call, subject to
`partition_count`.
|
PartitionQueryRequest.Builder |
clearPageToken()
The `next_page_token` value returned from a previous call to
PartitionQuery that may be used to get an additional set of results.
|
PartitionQueryRequest.Builder |
clearParent()
Required.
|
PartitionQueryRequest.Builder |
clearPartitionCount()
The desired maximum number of partition points.
|
PartitionQueryRequest.Builder |
clearQueryType() |
PartitionQueryRequest.Builder |
clearReadTime()
Reads documents as they were at the given time.
|
PartitionQueryRequest.Builder |
clearStructuredQuery()
A structured query.
|
PartitionQueryRequest.Builder |
clone() |
PartitionQueryRequest.ConsistencySelectorCase |
getConsistencySelectorCase() |
PartitionQueryRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
int |
getPageSize()
The maximum number of partitions to return in this call, subject to
`partition_count`.
|
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.
|
com.google.protobuf.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.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
long |
getPartitionCount()
The desired maximum number of partition points.
|
PartitionQueryRequest.QueryTypeCase |
getQueryTypeCase() |
com.google.protobuf.Timestamp |
getReadTime()
Reads documents as they were at the given time.
|
com.google.protobuf.Timestamp.Builder |
getReadTimeBuilder()
Reads documents as they were at the given time.
|
com.google.protobuf.TimestampOrBuilder |
getReadTimeOrBuilder()
Reads documents as they were at the given time.
|
StructuredQuery |
getStructuredQuery()
A structured query.
|
StructuredQuery.Builder |
getStructuredQueryBuilder()
A structured query.
|
StructuredQueryOrBuilder |
getStructuredQueryOrBuilder()
A structured query.
|
boolean |
hasReadTime()
Reads documents as they were at the given time.
|
boolean |
hasStructuredQuery()
A structured query.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
PartitionQueryRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
PartitionQueryRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
PartitionQueryRequest.Builder |
mergeFrom(PartitionQueryRequest other) |
PartitionQueryRequest.Builder |
mergeReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time.
|
PartitionQueryRequest.Builder |
mergeStructuredQuery(StructuredQuery value)
A structured query.
|
PartitionQueryRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
PartitionQueryRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PartitionQueryRequest.Builder |
setPageSize(int value)
The maximum number of partitions to return in this call, subject to
`partition_count`.
|
PartitionQueryRequest.Builder |
setPageToken(String value)
The `next_page_token` value returned from a previous call to
PartitionQuery that may be used to get an additional set of results.
|
PartitionQueryRequest.Builder |
setPageTokenBytes(com.google.protobuf.ByteString value)
The `next_page_token` value returned from a previous call to
PartitionQuery that may be used to get an additional set of results.
|
PartitionQueryRequest.Builder |
setParent(String value)
Required.
|
PartitionQueryRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
PartitionQueryRequest.Builder |
setPartitionCount(long value)
The desired maximum number of partition points.
|
PartitionQueryRequest.Builder |
setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
Reads documents as they were at the given time.
|
PartitionQueryRequest.Builder |
setReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time.
|
PartitionQueryRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
PartitionQueryRequest.Builder |
setStructuredQuery(StructuredQuery.Builder builderForValue)
A structured query.
|
PartitionQueryRequest.Builder |
setStructuredQuery(StructuredQuery value)
A structured query.
|
PartitionQueryRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic PartitionQueryRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic PartitionQueryRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic PartitionQueryRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest.Builder mergeFrom(PartitionQueryRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public PartitionQueryRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartitionQueryRequest.Builder>IOExceptionpublic PartitionQueryRequest.QueryTypeCase getQueryTypeCase()
getQueryTypeCase in interface PartitionQueryRequestOrBuilderpublic PartitionQueryRequest.Builder clearQueryType()
public PartitionQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
getConsistencySelectorCase in interface PartitionQueryRequestOrBuilderpublic PartitionQueryRequest.Builder clearConsistencySelector()
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];getParent in interface PartitionQueryRequestOrBuilderpublic com.google.protobuf.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];getParentBytes in interface PartitionQueryRequestOrBuilderpublic PartitionQueryRequest.Builder setParent(String value)
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];value - The parent to set.public PartitionQueryRequest.Builder clearParent()
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];public PartitionQueryRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
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];value - The bytes for parent to set.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;hasStructuredQuery in interface PartitionQueryRequestOrBuilderpublic 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;getStructuredQuery in interface PartitionQueryRequestOrBuilderpublic PartitionQueryRequest.Builder setStructuredQuery(StructuredQuery value)
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;public PartitionQueryRequest.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)
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;public PartitionQueryRequest.Builder mergeStructuredQuery(StructuredQuery value)
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;public PartitionQueryRequest.Builder clearStructuredQuery()
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;public StructuredQuery.Builder getStructuredQueryBuilder()
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;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;getStructuredQueryOrBuilder in interface PartitionQueryRequestOrBuilderpublic 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;getPartitionCount in interface PartitionQueryRequestOrBuilderpublic PartitionQueryRequest.Builder setPartitionCount(long value)
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;value - The partitionCount to set.public PartitionQueryRequest.Builder clearPartitionCount()
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;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;getPageToken in interface PartitionQueryRequestOrBuilderpublic com.google.protobuf.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;getPageTokenBytes in interface PartitionQueryRequestOrBuilderpublic PartitionQueryRequest.Builder setPageToken(String value)
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;value - The pageToken to set.public PartitionQueryRequest.Builder clearPageToken()
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;public PartitionQueryRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
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;value - The bytes for pageToken to set.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;getPageSize in interface PartitionQueryRequestOrBuilderpublic PartitionQueryRequest.Builder setPageSize(int value)
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;value - The pageSize to set.public PartitionQueryRequest.Builder clearPageSize()
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;public boolean hasReadTime()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 6;hasReadTime in interface PartitionQueryRequestOrBuilderpublic com.google.protobuf.Timestamp getReadTime()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 6;getReadTime in interface PartitionQueryRequestOrBuilderpublic PartitionQueryRequest.Builder setReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 6;public PartitionQueryRequest.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 6;public PartitionQueryRequest.Builder mergeReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 6;public PartitionQueryRequest.Builder clearReadTime()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 6;public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 6;public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 6;getReadTimeOrBuilder in interface PartitionQueryRequestOrBuilderpublic final PartitionQueryRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>public final PartitionQueryRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PartitionQueryRequest.Builder>Copyright © 2023 Google LLC. All rights reserved.