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