Class PartitionQueryRequest.Builder (3.0.21)

public static final class PartitionQueryRequest.Builder extends GeneratedMessageV3.Builder<PartitionQueryRequest.Builder> implements PartitionQueryRequestOrBuilder

The request for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PartitionQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides

build()

public PartitionQueryRequest build()
Returns
TypeDescription
PartitionQueryRequest

buildPartial()

public PartitionQueryRequest buildPartial()
Returns
TypeDescription
PartitionQueryRequest

clear()

public PartitionQueryRequest.Builder clear()
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PartitionQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PartitionQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
PartitionQueryRequest.Builder

This builder for chaining.

clearQueryType()

public PartitionQueryRequest.Builder clearQueryType()
Returns
TypeDescription
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
TypeDescription
PartitionQueryRequest.Builder

clone()

public PartitionQueryRequest.Builder clone()
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides

getDefaultInstanceForType()

public PartitionQueryRequest getDefaultInstanceForType()
Returns
TypeDescription
PartitionQueryRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
long

The partitionCount.

getQueryTypeCase()

public PartitionQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
TypeDescription
PartitionQueryRequest.QueryTypeCase

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
TypeDescription
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
TypeDescription
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
TypeDescription
StructuredQueryOrBuilder

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
TypeDescription
boolean

Whether the structuredQuery field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PartitionQueryRequest other)

public PartitionQueryRequest.Builder mergeFrom(PartitionQueryRequest other)
Parameter
NameDescription
otherPartitionQueryRequest
Returns
TypeDescription
PartitionQueryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PartitionQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PartitionQueryRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides

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
NameDescription
valueStructuredQuery
Returns
TypeDescription
PartitionQueryRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PartitionQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public PartitionQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides

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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
valuelong

The partitionCount to set.

Returns
TypeDescription
PartitionQueryRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PartitionQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides

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
NameDescription
valueStructuredQuery
Returns
TypeDescription
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
NameDescription
builderForValueStructuredQuery.Builder
Returns
TypeDescription
PartitionQueryRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PartitionQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PartitionQueryRequest.Builder
Overrides