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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StructuredAggregationQuery.Aggregation.Count.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public StructuredAggregationQuery.Aggregation.Count build()
buildPartial()
public StructuredAggregationQuery.Aggregation.Count buildPartial()
clear()
public StructuredAggregationQuery.Aggregation.Count.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public StructuredAggregationQuery.Aggregation.Count.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public StructuredAggregationQuery.Aggregation.Count.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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];
clone()
public StructuredAggregationQuery.Aggregation.Count.Builder clone()
Overrides
getDefaultInstanceForType()
public StructuredAggregationQuery.Aggregation.Count getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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];
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];
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];
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 |
|---|
| Type | Description |
boolean | Whether the upTo field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(StructuredAggregationQuery.Aggregation.Count other)
public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(StructuredAggregationQuery.Aggregation.Count other)
public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StructuredAggregationQuery.Aggregation.Count.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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];
setField(Descriptors.FieldDescriptor field, Object value)
public StructuredAggregationQuery.Aggregation.Count.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StructuredAggregationQuery.Aggregation.Count.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final StructuredAggregationQuery.Aggregation.Count.Builder setUnknownFields(UnknownFieldSet unknownFields)
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];
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 |
|---|
| Name | Description |
builderForValue | Builder
|
