Class AggregationQuery.Aggregation.Count.Builder (2.20.2)

public static final class AggregationQuery.Aggregation.Count.Builder extends GeneratedMessageV3.Builder<AggregationQuery.Aggregation.Count.Builder> implements AggregationQuery.Aggregation.CountOrBuilder

Count of entities that match the query.

The COUNT(*) aggregation function operates on the entire entity so it does not require a field reference.

Protobuf type google.datastore.v1.AggregationQuery.Aggregation.Count

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AggregationQuery.Aggregation.Count.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

build()

public AggregationQuery.Aggregation.Count build()
Returns
Type Description
AggregationQuery.Aggregation.Count

buildPartial()

public AggregationQuery.Aggregation.Count buildPartial()
Returns
Type Description
AggregationQuery.Aggregation.Count

clear()

public AggregationQuery.Aggregation.Count.Builder clear()
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AggregationQuery.Aggregation.Count.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AggregationQuery.Aggregation.Count.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

clearUpTo()

public AggregationQuery.Aggregation.Count.Builder clearUpTo()

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
Type Description
AggregationQuery.Aggregation.Count.Builder

clone()

public AggregationQuery.Aggregation.Count.Builder clone()
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

getDefaultInstanceForType()

public AggregationQuery.Aggregation.Count getDefaultInstanceForType()
Returns
Type Description
AggregationQuery.Aggregation.Count

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getUpTo()

public 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
Type Description
Int64Value

The upTo.

getUpToBuilder()

public Int64Value.Builder getUpToBuilder()

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
Type Description
Builder

getUpToOrBuilder()

public 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
Type Description
Int64ValueOrBuilder

hasUpTo()

public 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
Type Description
boolean

Whether the upTo field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AggregationQuery.Aggregation.Count other)

public AggregationQuery.Aggregation.Count.Builder mergeFrom(AggregationQuery.Aggregation.Count other)
Parameter
Name Description
other AggregationQuery.Aggregation.Count
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AggregationQuery.Aggregation.Count.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AggregationQuery.Aggregation.Count.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AggregationQuery.Aggregation.Count.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

mergeUpTo(Int64Value value)

public AggregationQuery.Aggregation.Count.Builder mergeUpTo(Int64Value value)

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

Parameter
Name Description
value Int64Value
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AggregationQuery.Aggregation.Count.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AggregationQuery.Aggregation.Count.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AggregationQuery.Aggregation.Count.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder
Overrides

setUpTo(Int64Value value)

public AggregationQuery.Aggregation.Count.Builder setUpTo(Int64Value value)

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

Parameter
Name Description
value Int64Value
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder

setUpTo(Int64Value.Builder builderForValue)

public AggregationQuery.Aggregation.Count.Builder setUpTo(Int64Value.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AggregationQuery.Aggregation.Count.Builder