public interface RunAggregationQueryRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getConsistencySelectorCase()
public abstract RunAggregationQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()| Type | Description |
RunAggregationQueryRequest.ConsistencySelectorCase |
getNewTransaction()
public abstract 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;
| Type | Description |
TransactionOptions |
The newTransaction. |
getNewTransactionOrBuilder()
public abstract 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;
| Type | Description |
TransactionOptionsOrBuilder |
getParent()
public abstract 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];
| Type | Description |
String |
The parent. |
getParentBytes()
public abstract 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];
| Type | Description |
ByteString |
The bytes for parent. |
getQueryTypeCase()
public abstract RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()| Type | Description |
RunAggregationQueryRequest.QueryTypeCase |
getReadTime()
public abstract 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;
| Type | Description |
Timestamp |
The readTime. |
getReadTimeOrBuilder()
public abstract 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;
| Type | Description |
TimestampOrBuilder |
getStructuredAggregationQuery()
public abstract StructuredAggregationQuery getStructuredAggregationQuery()An aggregation query.
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
| Type | Description |
StructuredAggregationQuery |
The structuredAggregationQuery. |
getStructuredAggregationQueryOrBuilder()
public abstract StructuredAggregationQueryOrBuilder getStructuredAggregationQueryOrBuilder()An aggregation query.
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
| Type | Description |
StructuredAggregationQueryOrBuilder |
getTransaction()
public abstract 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;
| Type | Description |
ByteString |
The transaction. |
hasNewTransaction()
public abstract 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;
| Type | Description |
boolean |
Whether the newTransaction field is set. |
hasReadTime()
public abstract 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;
| Type | Description |
boolean |
Whether the readTime field is set. |
hasStructuredAggregationQuery()
public abstract boolean hasStructuredAggregationQuery()An aggregation query.
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
| Type | Description |
boolean |
Whether the structuredAggregationQuery field is set. |
hasTransaction()
public abstract 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;
| Type | Description |
boolean |
Whether the transaction field is set. |