Package com.google.firestore.v1

Class StructuredAggregationQuery.Aggregation.Count.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count.Builder
All Implemented Interfaces:
StructuredAggregationQuery.Aggregation.CountOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StructuredAggregationQuery.Aggregation.Count
public static final class StructuredAggregationQuery.Aggregation.Count.Builder extends com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder> 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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

    • clear

      public StructuredAggregationQuery.Aggregation.Count.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

    • getDefaultInstanceForType

      public StructuredAggregationQuery.Aggregation.Count getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

    • mergeFrom

      public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(StructuredAggregationQuery.Aggregation.Count other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>

    • mergeFrom

      public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredAggregationQuery.Aggregation.Count.Builder>
      Throws:
      IOException

    • 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.

    • setUpTo

      public StructuredAggregationQuery.Aggregation.Count.Builder setUpTo(com.google.protobuf.Int64Value value)
       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];

    • setUpTo

      public StructuredAggregationQuery.Aggregation.Count.Builder setUpTo(com.google.protobuf.Int64Value.Builder builderForValue)
       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];

    • mergeUpTo

      public StructuredAggregationQuery.Aggregation.Count.Builder mergeUpTo(com.google.protobuf.Int64Value value)
       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];

    • clearUpTo

      public StructuredAggregationQuery.Aggregation.Count.Builder clearUpTo()
       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];

    • getUpToBuilder

      public com.google.protobuf.Int64Value.Builder getUpToBuilder()
       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];

    • 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