Package com.google.firestore.v1

Class StructuredAggregationQuery.Aggregation.Count

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count
All Implemented Interfaces:
StructuredAggregationQuery.Aggregation.CountOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
StructuredAggregationQuery.Aggregation
public static final class StructuredAggregationQuery.Aggregation.Count extends com.google.protobuf.GeneratedMessageV3 implements StructuredAggregationQuery.Aggregation.CountOrBuilder
 Count of documents that match the query.

 The `COUNT(*)` aggregation function operates on the entire document
 so it does not require a field reference.
Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation.Count
See Also:

  • Field Details

  • 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

    • hasUpTo

      public boolean hasUpTo()
       Optional. Optional constraint on the maximum number of documents to
 count.

 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency, and cost.

 Unspecified is interpreted as no bound.

 High-Level Example:

 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```

 Requires:

 * Must be greater than zero when present.
      .google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasUpTo in interface StructuredAggregationQuery.Aggregation.CountOrBuilder
      Returns:
      Whether the upTo field is set.

    • getUpTo

      public com.google.protobuf.Int64Value getUpTo()
       Optional. Optional constraint on the maximum number of documents to
 count.

 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency, and cost.

 Unspecified is interpreted as no bound.

 High-Level Example:

 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```

 Requires:

 * Must be greater than zero when present.
      .google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUpTo in interface StructuredAggregationQuery.Aggregation.CountOrBuilder
      Returns:
      The upTo.

    • getUpToOrBuilder

      public com.google.protobuf.Int64ValueOrBuilder getUpToOrBuilder()
       Optional. Optional constraint on the maximum number of documents to
 count.

 This provides a way to set an upper bound on the number of documents
 to scan, limiting latency, and cost.

 Unspecified is interpreted as no bound.

 High-Level Example:

 ```
 AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
 ```

 Requires:

 * Must be greater than zero when present.
      .google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUpToOrBuilder in interface StructuredAggregationQuery.Aggregation.CountOrBuilder

    • 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 StructuredAggregationQuery.Aggregation.Count parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static StructuredAggregationQuery.Aggregation.Count parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static StructuredAggregationQuery.Aggregation.Count parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static StructuredAggregationQuery.Aggregation.Count parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static StructuredAggregationQuery.Aggregation.Count parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StructuredAggregationQuery.Aggregation.Count.Builder newBuilder()

    • newBuilder

      public static StructuredAggregationQuery.Aggregation.Count.Builder newBuilder(StructuredAggregationQuery.Aggregation.Count prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static StructuredAggregationQuery.Aggregation.Count getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StructuredAggregationQuery.Aggregation.Count> parser()

    • getParserForType

      public com.google.protobuf.Parser<StructuredAggregationQuery.Aggregation.Count> 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 StructuredAggregationQuery.Aggregation.Count getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder