Class PartitionQueryRequest.Builder (3.9.6)

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

The request for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PartitionQueryRequest.Builder

Implements

PartitionQueryRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public PartitionQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`PartitionQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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 may not be older than 270 seconds.

.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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getPageSize()

public int getPageSize()

int32 page_size = 5;

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public String getPageToken()

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()

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()

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 may not be older than 270 seconds.

.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 may not be older than 270 seconds.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`Builder`

getReadTimeOrBuilder()

public 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;

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 may not be older than 270 seconds.

.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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public PartitionQueryRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`PartitionQueryRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeReadTime(Timestamp value)

public PartitionQueryRequest.Builder mergeReadTime(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;

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setPageSize(int value)

public PartitionQueryRequest.Builder setPageSize(int value)

int32 page_size = 5;

Parameter
Name	Description
`value`	`int` The pageSize to set.

Returns
Type	Description
`PartitionQueryRequest.Builder`	This builder for chaining.

setPageToken(String value)

public PartitionQueryRequest.Builder setPageToken(String value)

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`	`String` The pageToken to set.

Returns
Type	Description
`PartitionQueryRequest.Builder`	This builder for chaining.

setPageTokenBytes(ByteString value)

public PartitionQueryRequest.Builder setPageTokenBytes(ByteString value)

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`	`ByteString` The 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`	`String` The 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`	`ByteString` The bytes for parent to set.

Returns
Type	Description
`PartitionQueryRequest.Builder`	This builder for chaining.

setPartitionCount(long value)

public PartitionQueryRequest.Builder setPartitionCount(long value)

int64 partition_count = 3;

Parameter
Name	Description
`value`	`long` The 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 may not be older than 270 seconds.

.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 may not be older than 270 seconds.

.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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)