Interface StructuredAggregationQuery.Aggregation.CountOrBuilder (3.7.3)

Stay organized with collections Save and categorize content based on your preferences.
public static interface StructuredAggregationQuery.Aggregation.CountOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getUpTo()

public abstract 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: <code><code> AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); </code></code> Requires:

  • Must be greater than zero when present.

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Int64Value

The upTo.

getUpToOrBuilder()

public abstract 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: <code><code> AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); </code></code> Requires:

  • Must be greater than zero when present.

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Int64ValueOrBuilder

hasUpTo()

public abstract 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: <code><code> AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); </code></code> Requires:

  • Must be greater than zero when present.

.google.protobuf.Int64Value up_to = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the upTo field is set.