Package com.google.firestore.v1

Class RunAggregationQueryRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.RunAggregationQueryRequest
All Implemented Interfaces:
RunAggregationQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class RunAggregationQueryRequest extends com.google.protobuf.GeneratedMessageV3 implements RunAggregationQueryRequestOrBuilder
 The request for
 [Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].
Protobuf type google.firestore.v1.RunAggregationQueryRequest
See Also:

  • Field Details

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:

    • STRUCTURED_AGGREGATION_QUERY_FIELD_NUMBER

      public static final int STRUCTURED_AGGREGATION_QUERY_FIELD_NUMBER
      See Also:

    • TRANSACTION_FIELD_NUMBER

      public static final int TRANSACTION_FIELD_NUMBER
      See Also:

    • NEW_TRANSACTION_FIELD_NUMBER

      public static final int NEW_TRANSACTION_FIELD_NUMBER
      See Also:

    • READ_TIME_FIELD_NUMBER

      public static final int READ_TIME_FIELD_NUMBER
      See Also:

    • EXPLAIN_OPTIONS_FIELD_NUMBER

      public static final int EXPLAIN_OPTIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getQueryTypeCase

      public RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()
      Specified by:
      getQueryTypeCase in interface RunAggregationQueryRequestOrBuilder

    • getConsistencySelectorCase

      public RunAggregationQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
      Specified by:
      getConsistencySelectorCase in interface RunAggregationQueryRequestOrBuilder

    • 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];
      Specified by:
      getParent in interface RunAggregationQueryRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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];
      Specified by:
      getParentBytes in interface RunAggregationQueryRequestOrBuilder
      Returns:
      The bytes for parent.

    • hasStructuredAggregationQuery

      public boolean hasStructuredAggregationQuery()
       An aggregation query.
      .google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
      Specified by:
      hasStructuredAggregationQuery in interface RunAggregationQueryRequestOrBuilder
      Returns:
      Whether the structuredAggregationQuery field is set.

    • getStructuredAggregationQuery

      public StructuredAggregationQuery getStructuredAggregationQuery()
       An aggregation query.
      .google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
      Specified by:
      getStructuredAggregationQuery in interface RunAggregationQueryRequestOrBuilder
      Returns:
      The structuredAggregationQuery.

    • getStructuredAggregationQueryOrBuilder

      public StructuredAggregationQueryOrBuilder getStructuredAggregationQueryOrBuilder()
       An aggregation query.
      .google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
      Specified by:
      getStructuredAggregationQueryOrBuilder in interface RunAggregationQueryRequestOrBuilder

    • 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;
      Specified by:
      hasTransaction in interface RunAggregationQueryRequestOrBuilder
      Returns:
      Whether the transaction field is set.

    • getTransaction

      public 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;
      Specified by:
      getTransaction in interface RunAggregationQueryRequestOrBuilder
      Returns:
      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;
      Specified by:
      hasNewTransaction in interface RunAggregationQueryRequestOrBuilder
      Returns:
      Whether the newTransaction field is set.

    • 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;
      Specified by:
      getNewTransaction in interface RunAggregationQueryRequestOrBuilder
      Returns:
      The newTransaction.

    • 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;
      Specified by:
      getNewTransactionOrBuilder in interface RunAggregationQueryRequestOrBuilder

    • hasReadTime

      public boolean hasReadTime()
       Executes the query at the given timestamp.

 This must be a microsecond precision timestamp within the past one hour,
 or if Point-in-Time Recovery is enabled, can additionally be a whole
 minute timestamp within the past 7 days.
      .google.protobuf.Timestamp read_time = 6;
      Specified by:
      hasReadTime in interface RunAggregationQueryRequestOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       Executes the query at the given timestamp.

 This must be a microsecond precision timestamp within the past one hour,
 or if Point-in-Time Recovery is enabled, can additionally be a whole
 minute timestamp within the past 7 days.
      .google.protobuf.Timestamp read_time = 6;
      Specified by:
      getReadTime in interface RunAggregationQueryRequestOrBuilder
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       Executes the query at the given timestamp.

 This must be a microsecond precision timestamp within the past one hour,
 or if Point-in-Time Recovery is enabled, can additionally be a whole
 minute timestamp within the past 7 days.
      .google.protobuf.Timestamp read_time = 6;
      Specified by:
      getReadTimeOrBuilder in interface RunAggregationQueryRequestOrBuilder

    • hasExplainOptions

      public boolean hasExplainOptions()
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.firestore.v1.ExplainOptions explain_options = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasExplainOptions in interface RunAggregationQueryRequestOrBuilder
      Returns:
      Whether the explainOptions field is set.

    • getExplainOptions

      public ExplainOptions getExplainOptions()
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.firestore.v1.ExplainOptions explain_options = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExplainOptions in interface RunAggregationQueryRequestOrBuilder
      Returns:
      The explainOptions.

    • getExplainOptionsOrBuilder

      public ExplainOptionsOrBuilder getExplainOptionsOrBuilder()
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.firestore.v1.ExplainOptions explain_options = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExplainOptionsOrBuilder in interface RunAggregationQueryRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunAggregationQueryRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunAggregationQueryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunAggregationQueryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RunAggregationQueryRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RunAggregationQueryRequest.Builder newBuilder()

    • newBuilder

      public static RunAggregationQueryRequest.Builder newBuilder(RunAggregationQueryRequest prototype)

    • toBuilder

      public RunAggregationQueryRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RunAggregationQueryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RunAggregationQueryRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RunAggregationQueryRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<RunAggregationQueryRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public RunAggregationQueryRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder