public static final class RunAggregationQueryRequest.Builder extends GeneratedMessageV3.Builder<RunAggregationQueryRequest.Builder> implements RunAggregationQueryRequestOrBuilderThe request for Firestore.RunAggregationQuery.
Protobuf type google.firestore.v1.RunAggregationQueryRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunAggregationQueryRequest.BuilderImplements
RunAggregationQueryRequestOrBuilderStatic 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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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() 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 |
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 | |
|---|---|
| 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 | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public RunAggregationQueryRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
RunAggregationQueryRequest.Builder | |
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 | |
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 | |
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) 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 | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe 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 | |
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 | ByteStringThe 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 | |