Class StructuredAggregationQuery.Aggregation.Count (3.14.4)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StructuredAggregationQuery.Aggregation.Count
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

Static Fields

UP_TO_FIELD_NUMBER

public static final int UP_TO_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StructuredAggregationQuery.Aggregation.Count getDefaultInstance()

getDescriptor()

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

newBuilder()

public static StructuredAggregationQuery.Aggregation.Count.Builder newBuilder()

newBuilder(StructuredAggregationQuery.Aggregation.Count prototype)

public static StructuredAggregationQuery.Aggregation.Count.Builder newBuilder(StructuredAggregationQuery.Aggregation.Count prototype)
Parameter
NameDescription
prototypeStructuredAggregationQuery.Aggregation.Count

parseDelimitedFrom(InputStream input)

public static StructuredAggregationQuery.Aggregation.Count parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StructuredAggregationQuery.Aggregation.Count> parser()
Returns
TypeDescription
Parser<Count>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public StructuredAggregationQuery.Aggregation.Count getDefaultInstanceForType()

getParserForType()

public Parser<StructuredAggregationQuery.Aggregation.Count> getParserForType()
Returns
TypeDescription
Parser<Count>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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.

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StructuredAggregationQuery.Aggregation.Count.Builder newBuilderForType()

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredAggregationQuery.Aggregation.Count.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StructuredAggregationQuery.Aggregation.Count.Builder toBuilder()

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException