public static final class PartitionQueryRequest.Builder extends GeneratedMessageV3.Builder<PartitionQueryRequest.Builder> implements PartitionQueryRequestOrBuilderThe request for Firestore.PartitionQuery.
Protobuf type google.firestore.v1.PartitionQueryRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PartitionQueryRequest.BuilderImplements
PartitionQueryRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PartitionQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
build()
public PartitionQueryRequest build()| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest |
|
buildPartial()
public PartitionQueryRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest |
|
clear()
public PartitionQueryRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
clearConsistencySelector()
public PartitionQueryRequest.Builder clearConsistencySelector()| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public PartitionQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public PartitionQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
clearPageSize()
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;
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
clearPageToken()
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;
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
clearParent()
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];
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
clearPartitionCount()
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;
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
clearQueryType()
public PartitionQueryRequest.Builder clearQueryType()| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
clearReadTime()
public PartitionQueryRequest.Builder clearReadTime()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 |
PartitionQueryRequest.Builder |
|
clearStructuredQuery()
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;
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
clone()
public PartitionQueryRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
getConsistencySelectorCase()
public PartitionQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.ConsistencySelectorCase |
|
getDefaultInstanceForType()
public PartitionQueryRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
getReadTimeBuilder()
public Timestamp.Builder getReadTimeBuilder()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 |
Builder |
|
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 |
|
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. |
getStructuredQueryBuilder()
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;
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Builder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PartitionQueryRequest other)
public PartitionQueryRequest.Builder mergeFrom(PartitionQueryRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
PartitionQueryRequest |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PartitionQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PartitionQueryRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
mergeReadTime(Timestamp value)
public PartitionQueryRequest.Builder mergeReadTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
mergeStructuredQuery(StructuredQuery value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StructuredQuery |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PartitionQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public PartitionQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
setPageSize(int value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public PartitionQueryRequest.Builder setPageTokenBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
setParent(String value)
public 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public PartitionQueryRequest.Builder setParentBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
setPartitionCount(long value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe partitionCount to set. |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
This builder for chaining. |
setReadTime(Timestamp value)
public PartitionQueryRequest.Builder setReadTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
setReadTime(Timestamp.Builder builderForValue)
public PartitionQueryRequest.Builder setReadTime(Timestamp.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PartitionQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
setStructuredQuery(StructuredQuery value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StructuredQuery |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
setStructuredQuery(StructuredQuery.Builder builderForValue)
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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
StructuredQuery.Builder |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final PartitionQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PartitionQueryRequest.Builder |
|