com.google.firestore.v1

Interface StructuredAggregationQuery.Aggregation.CountOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

StructuredAggregationQuery.Aggregation.Count, StructuredAggregationQuery.Aggregation.Count.Builder

Enclosing class:

StructuredAggregationQuery.Aggregation

public static interface StructuredAggregationQuery.Aggregation.CountOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Int64Value	getUpTo() Optional.
com.google.protobuf.Int64ValueOrBuilder	getUpToOrBuilder() Optional.
boolean	hasUpTo() Optional.

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

hasUpTo

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];

Returns:

Whether the upTo field is set.

getUpTo

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];

Returns:

The upTo.

getUpToOrBuilder

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];