Class RunAggregationQueryRequest.Builder (3.12.1)

public static final class RunAggregationQueryRequest.Builder extends GeneratedMessageV3.Builder<RunAggregationQueryRequest.Builder> implements RunAggregationQueryRequestOrBuilder

The request for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryRequest

Inheritance

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

Implements

RunAggregationQueryRequestOrBuilder

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 RunAggregationQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

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

build()

public RunAggregationQueryRequest build()

Returns
Type	Description
`RunAggregationQueryRequest`

buildPartial()

public RunAggregationQueryRequest buildPartial()

Returns
Type	Description
`RunAggregationQueryRequest`

clear()

public RunAggregationQueryRequest.Builder clear()

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConsistencySelector()

public RunAggregationQueryRequest.Builder clearConsistencySelector()

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

clearField(Descriptors.FieldDescriptor field)

public RunAggregationQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

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

clearNewTransaction()

public RunAggregationQueryRequest.Builder clearNewTransaction()

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public RunAggregationQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

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

clearParent()

public RunAggregationQueryRequest.Builder clearParent()

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

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

clearQueryType()

public RunAggregationQueryRequest.Builder clearQueryType()

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

clearReadTime()

public RunAggregationQueryRequest.Builder clearReadTime()

Executes the query at the given timestamp. Requires:

Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

clearStructuredAggregationQuery()

public RunAggregationQueryRequest.Builder clearStructuredAggregationQuery()

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

clearTransaction()

public RunAggregationQueryRequest.Builder clearTransaction()

Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in.

bytes transaction = 4;

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

clone()

public RunAggregationQueryRequest.Builder clone()

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getConsistencySelectorCase()

public RunAggregationQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()

Returns
Type	Description
`RunAggregationQueryRequest.ConsistencySelectorCase`

getDefaultInstanceForType()

public RunAggregationQueryRequest getDefaultInstanceForType()

Returns
Type	Description
`RunAggregationQueryRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getNewTransaction()

public TransactionOptions getNewTransaction()

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Returns
Type	Description
`TransactionOptions`	The newTransaction.

getNewTransactionBuilder()

public TransactionOptions.Builder getNewTransactionBuilder()

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Returns
Type	Description
`TransactionOptions.Builder`

getNewTransactionOrBuilder()

public TransactionOptionsOrBuilder getNewTransactionOrBuilder()

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Returns
Type	Description
`TransactionOptionsOrBuilder`

getParent()

public String getParent()

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The parent.

getParentBytes()

public ByteString getParentBytes()

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for parent.

getQueryTypeCase()

public RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()

Returns
Type	Description
`RunAggregationQueryRequest.QueryTypeCase`

getReadTime()

public Timestamp getReadTime()

Executes the query at the given timestamp. Requires:

Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`Timestamp`	The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

Executes the query at the given timestamp. Requires:

Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`Builder`

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Executes the query at the given timestamp. Requires:

Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`TimestampOrBuilder`

getStructuredAggregationQuery()

public StructuredAggregationQuery getStructuredAggregationQuery()

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Returns
Type	Description
`StructuredAggregationQuery`	The structuredAggregationQuery.

getStructuredAggregationQueryBuilder()

public StructuredAggregationQuery.Builder getStructuredAggregationQueryBuilder()

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Returns
Type	Description
`StructuredAggregationQuery.Builder`

getStructuredAggregationQueryOrBuilder()

public StructuredAggregationQueryOrBuilder getStructuredAggregationQueryOrBuilder()

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Returns
Type	Description
`StructuredAggregationQueryOrBuilder`

getTransaction()

public ByteString getTransaction()

Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in.

bytes transaction = 4;

Returns
Type	Description
`ByteString`	The transaction.

hasNewTransaction()

public boolean hasNewTransaction()

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Returns
Type	Description
`boolean`	Whether the newTransaction field is set.

hasReadTime()

public boolean hasReadTime()

Executes the query at the given timestamp. Requires:

Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`boolean`	Whether the readTime field is set.

hasStructuredAggregationQuery()

public boolean hasStructuredAggregationQuery()

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Returns
Type	Description
`boolean`	Whether the structuredAggregationQuery field is set.

hasTransaction()

public boolean hasTransaction()

Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in.

bytes transaction = 4;

Returns
Type	Description
`boolean`	Whether the transaction 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(RunAggregationQueryRequest other)

public RunAggregationQueryRequest.Builder mergeFrom(RunAggregationQueryRequest other)

Parameter
Name	Description
`other`	`RunAggregationQueryRequest`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunAggregationQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public RunAggregationQueryRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

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

mergeNewTransaction(TransactionOptions value)

public RunAggregationQueryRequest.Builder mergeNewTransaction(TransactionOptions value)

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Parameter
Name	Description
`value`	`TransactionOptions`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

mergeReadTime(Timestamp value)

public RunAggregationQueryRequest.Builder mergeReadTime(Timestamp value)

Executes the query at the given timestamp. Requires:

Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

mergeStructuredAggregationQuery(StructuredAggregationQuery value)

public RunAggregationQueryRequest.Builder mergeStructuredAggregationQuery(StructuredAggregationQuery value)

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Parameter
Name	Description
`value`	`StructuredAggregationQuery`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunAggregationQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

public RunAggregationQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

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

setNewTransaction(TransactionOptions value)

public RunAggregationQueryRequest.Builder setNewTransaction(TransactionOptions value)

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Parameter
Name	Description
`value`	`TransactionOptions`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

setNewTransaction(TransactionOptions.Builder builderForValue)

public RunAggregationQueryRequest.Builder setNewTransaction(TransactionOptions.Builder builderForValue)

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

.google.firestore.v1.TransactionOptions new_transaction = 5;

Parameter
Name	Description
`builderForValue`	`TransactionOptions.Builder`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

setParent(String value)

public RunAggregationQueryRequest.Builder setParent(String value)

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`String` The parent to set.

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

setParentBytes(ByteString value)

public RunAggregationQueryRequest.Builder setParentBytes(ByteString value)

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`ByteString` The bytes for parent to set.

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

setReadTime(Timestamp value)

public RunAggregationQueryRequest.Builder setReadTime(Timestamp value)

Executes the query at the given timestamp. Requires:

Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

setReadTime(Timestamp.Builder builderForValue)

public RunAggregationQueryRequest.Builder setReadTime(Timestamp.Builder builderForValue)

Executes the query at the given timestamp. Requires:

Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

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

setStructuredAggregationQuery(StructuredAggregationQuery value)

public RunAggregationQueryRequest.Builder setStructuredAggregationQuery(StructuredAggregationQuery value)

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Parameter
Name	Description
`value`	`StructuredAggregationQuery`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

setStructuredAggregationQuery(StructuredAggregationQuery.Builder builderForValue)

public RunAggregationQueryRequest.Builder setStructuredAggregationQuery(StructuredAggregationQuery.Builder builderForValue)

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Parameter
Name	Description
`builderForValue`	`StructuredAggregationQuery.Builder`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

setTransaction(ByteString value)

public RunAggregationQueryRequest.Builder setTransaction(ByteString value)

Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in.

bytes transaction = 4;

Parameter
Name	Description
`value`	`ByteString` The transaction to set.

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

setUnknownFields(UnknownFieldSet unknownFields)

public final RunAggregationQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RunAggregationQueryRequest.Builder`

Overrides

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