Class StructuredAggregationQuery.Aggregation.Count.Builder (3.20.0)

public static final class StructuredAggregationQuery.Aggregation.Count.Builder extends GeneratedMessageV3.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StructuredAggregationQuery.Aggregation.Count.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

build()

public StructuredAggregationQuery.Aggregation.Count build()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count

buildPartial()

public StructuredAggregationQuery.Aggregation.Count buildPartial()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count

clear()

public StructuredAggregationQuery.Aggregation.Count.Builder clear()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public StructuredAggregationQuery.Aggregation.Count.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredAggregationQuery.Aggregation.Count.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

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:

<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
StructuredAggregationQuery.Aggregation.Count.Builder

clone()

public StructuredAggregationQuery.Aggregation.Count.Builder clone()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

getDefaultInstanceForType()

public StructuredAggregationQuery.Aggregation.Count getDefaultInstanceForType()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getUpTo()

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

getUpToBuilder()

public 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:

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

getUpToOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StructuredAggregationQuery.Aggregation.Count other)

public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(StructuredAggregationQuery.Aggregation.Count other)
Parameter
NameDescription
otherStructuredAggregationQuery.Aggregation.Count
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredAggregationQuery.Aggregation.Count.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

mergeUpTo(Int64Value value)

public StructuredAggregationQuery.Aggregation.Count.Builder mergeUpTo(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:

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

Parameter
NameDescription
valueInt64Value
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StructuredAggregationQuery.Aggregation.Count.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

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

public StructuredAggregationQuery.Aggregation.Count.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredAggregationQuery.Aggregation.Count.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder
Overrides

setUpTo(Int64Value value)

public StructuredAggregationQuery.Aggregation.Count.Builder setUpTo(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:

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

Parameter
NameDescription
valueInt64Value
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder

setUpTo(Int64Value.Builder builderForValue)

public StructuredAggregationQuery.Aggregation.Count.Builder setUpTo(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:

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count.Builder