public static final class StructuredAggregationQuery.Aggregation.Count extends GeneratedMessageV3 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 Fields
UP_TO_FIELD_NUMBER
public static final int UP_TO_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static StructuredAggregationQuery.Aggregation.Count getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static StructuredAggregationQuery.Aggregation.Count.Builder newBuilder()
Returns
newBuilder(StructuredAggregationQuery.Aggregation.Count prototype)
public static StructuredAggregationQuery.Aggregation.Count.Builder newBuilder(StructuredAggregationQuery.Aggregation.Count prototype)
Parameter
Returns
public static StructuredAggregationQuery.Aggregation.Count parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static StructuredAggregationQuery.Aggregation.Count parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static StructuredAggregationQuery.Aggregation.Count parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery.Aggregation.Count parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StructuredAggregationQuery.Aggregation.Count parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static StructuredAggregationQuery.Aggregation.Count parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StructuredAggregationQuery.Aggregation.Count parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static StructuredAggregationQuery.Aggregation.Count parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<StructuredAggregationQuery.Aggregation.Count> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public StructuredAggregationQuery.Aggregation.Count getDefaultInstanceForType()
Returns
getParserForType()
public Parser<StructuredAggregationQuery.Aggregation.Count> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
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];
| Type | Description |
| boolean | Whether the upTo field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public StructuredAggregationQuery.Aggregation.Count.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredAggregationQuery.Aggregation.Count.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public StructuredAggregationQuery.Aggregation.Count.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
