Class RunAggregationQueryRequest.Builder (3.9.4)

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

The request for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RunAggregationQueryRequest build()
Returns
TypeDescription
RunAggregationQueryRequest

buildPartial()

public RunAggregationQueryRequest buildPartial()
Returns
TypeDescription
RunAggregationQueryRequest

clear()

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

clearConsistencySelector()

public RunAggregationQueryRequest.Builder clearConsistencySelector()
Returns
TypeDescription
RunAggregationQueryRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

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

This builder for chaining.

clearQueryType()

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

clearStructuredAggregationQuery()

public RunAggregationQueryRequest.Builder clearStructuredAggregationQuery()

An aggregation query.

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

Returns
TypeDescription
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
TypeDescription
RunAggregationQueryRequest.Builder

This builder for chaining.

clone()

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

getConsistencySelectorCase()

public RunAggregationQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
TypeDescription
RunAggregationQueryRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public RunAggregationQueryRequest getDefaultInstanceForType()
Returns
TypeDescription
RunAggregationQueryRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

getParent()

public String getParent()

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

The parent.

getParentBytes()

public ByteString getParentBytes()

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

The bytes for parent.

getQueryTypeCase()

public RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getStructuredAggregationQuery()

public StructuredAggregationQuery getStructuredAggregationQuery()

An aggregation query.

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

Returns
TypeDescription
StructuredAggregationQuery

The structuredAggregationQuery.

getStructuredAggregationQueryBuilder()

public StructuredAggregationQuery.Builder getStructuredAggregationQueryBuilder()

An aggregation query.

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

Returns
TypeDescription
StructuredAggregationQuery.Builder

getStructuredAggregationQueryOrBuilder()

public StructuredAggregationQueryOrBuilder getStructuredAggregationQueryOrBuilder()

An aggregation query.

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

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

Whether the readTime field is set.

hasStructuredAggregationQuery()

public boolean hasStructuredAggregationQuery()

An aggregation query.

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

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

Whether the transaction field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RunAggregationQueryRequest other)

public RunAggregationQueryRequest.Builder mergeFrom(RunAggregationQueryRequest other)
Parameter
NameDescription
otherRunAggregationQueryRequest
Returns
TypeDescription
RunAggregationQueryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

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
NameDescription
valueTransactionOptions
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
RunAggregationQueryRequest.Builder

mergeStructuredAggregationQuery(StructuredAggregationQuery value)

public RunAggregationQueryRequest.Builder mergeStructuredAggregationQuery(StructuredAggregationQuery value)

An aggregation query.

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

Parameter
NameDescription
valueStructuredAggregationQuery
Returns
TypeDescription
RunAggregationQueryRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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
NameDescription
valueTransactionOptions
Returns
TypeDescription
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
NameDescription
builderForValueTransactionOptions.Builder
Returns
TypeDescription
RunAggregationQueryRequest.Builder

setParent(String value)

public RunAggregationQueryRequest.Builder setParent(String value)

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
RunAggregationQueryRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public RunAggregationQueryRequest.Builder setParentBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
RunAggregationQueryRequest.Builder

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

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

setStructuredAggregationQuery(StructuredAggregationQuery value)

public RunAggregationQueryRequest.Builder setStructuredAggregationQuery(StructuredAggregationQuery value)

An aggregation query.

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

Parameter
NameDescription
valueStructuredAggregationQuery
Returns
TypeDescription
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
NameDescription
builderForValueStructuredAggregationQuery.Builder
Returns
TypeDescription
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
NameDescription
valueByteString

The transaction to set.

Returns
TypeDescription
RunAggregationQueryRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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