Interface AggregationQuery.Aggregation.CountOrBuilder (2.18.5)

public static interface AggregationQuery.Aggregation.CountOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getUpTo()

public abstract Int64Value getUpTo()

Optional. Optional constraint on the maximum number of entities to count.

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

Unspecified is interpreted as no bound.

If a zero value is provided, a count result of zero should always be expected.

High-Level Example:

<code><code> AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); </code></code>

Requires:

  • Must be non-negative 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 entities to count.

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

Unspecified is interpreted as no bound.

If a zero value is provided, a count result of zero should always be expected.

High-Level Example:

<code><code> AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); </code></code>

Requires:

  • Must be non-negative 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 entities to count.

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

Unspecified is interpreted as no bound.

If a zero value is provided, a count result of zero should always be expected.

High-Level Example:

<code><code> AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); </code></code>

Requires:

  • Must be non-negative when present.

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

Returns
TypeDescription
boolean

Whether the upTo field is set.