public static final class StructuredAggregationQuery.Aggregation.Count.Builder extends GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Count.Builder> implements StructuredAggregationQuery.Aggregation.CountOrBuilderCount 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StructuredAggregationQuery.Aggregation.Count.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StructuredAggregationQuery.Aggregation.Count.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
build()
public StructuredAggregationQuery.Aggregation.Count build()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count |
|
buildPartial()
public StructuredAggregationQuery.Aggregation.Count buildPartial()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count |
|
clear()
public StructuredAggregationQuery.Aggregation.Count.Builder clear()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public StructuredAggregationQuery.Aggregation.Count.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public StructuredAggregationQuery.Aggregation.Count.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
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 | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
clone()
public StructuredAggregationQuery.Aggregation.Count.Builder clone()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
getDefaultInstanceForType()
public StructuredAggregationQuery.Aggregation.Count getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the upTo field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(StructuredAggregationQuery.Aggregation.Count other)
public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(StructuredAggregationQuery.Aggregation.Count other)| Parameter | |
|---|---|
| Name | Description |
other |
StructuredAggregationQuery.Aggregation.Count |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public StructuredAggregationQuery.Aggregation.Count.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StructuredAggregationQuery.Aggregation.Count.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
Int64Value |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public StructuredAggregationQuery.Aggregation.Count.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StructuredAggregationQuery.Aggregation.Count.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final StructuredAggregationQuery.Aggregation.Count.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
Int64Value |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count.Builder |
|