com.google.firestore.v1

Interface RunAggregationQueryRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RunAggregationQueryRequest, RunAggregationQueryRequest.Builder

public interface RunAggregationQueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
RunAggregationQueryRequest.ConsistencySelectorCase	getConsistencySelectorCase()
TransactionOptions	getNewTransaction() Starts a new transaction as part of the query, defaulting to read-only.
TransactionOptionsOrBuilder	getNewTransactionOrBuilder() Starts a new transaction as part of the query, defaulting to read-only.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
RunAggregationQueryRequest.QueryTypeCase	getQueryTypeCase()
com.google.protobuf.Timestamp	getReadTime() Executes the query at the given timestamp.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() Executes the query at the given timestamp.
StructuredAggregationQuery	getStructuredAggregationQuery() An aggregation query.
StructuredAggregationQueryOrBuilder	getStructuredAggregationQueryOrBuilder() An aggregation query.
com.google.protobuf.ByteString	getTransaction() Run the aggregation within an already active transaction.
boolean	hasNewTransaction() Starts a new transaction as part of the query, defaulting to read-only.
boolean	hasReadTime() Executes the query at the given timestamp.
boolean	hasStructuredAggregationQuery() An aggregation query.
boolean	hasTransaction() Run the aggregation within an already active transaction.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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:

The parent.

getParentBytes

com.google.protobuf.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:

The bytes for parent.

hasStructuredAggregationQuery

boolean hasStructuredAggregationQuery()

 An aggregation query.
 

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

Returns:

Whether the structuredAggregationQuery field is set.

getStructuredAggregationQuery

StructuredAggregationQuery getStructuredAggregationQuery()

 An aggregation query.
 

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

Returns:

The structuredAggregationQuery.

getStructuredAggregationQueryOrBuilder

StructuredAggregationQueryOrBuilder getStructuredAggregationQueryOrBuilder()

 An aggregation query.
 

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

hasTransaction

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:

Whether the transaction field is set.

getTransaction

com.google.protobuf.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:

The transaction.

hasNewTransaction

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:

Whether the newTransaction field is set.

getNewTransaction

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:

The newTransaction.

getNewTransactionOrBuilder

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;

hasReadTime

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:

Whether the readTime field is set.

getReadTime

com.google.protobuf.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:

The readTime.

getReadTimeOrBuilder

com.google.protobuf.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;

getQueryTypeCase

RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()

getConsistencySelectorCase

RunAggregationQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()