Class StructuredAggregationQuery.Aggregation.Count (3.5.0)

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

Implements

StructuredAggregationQuery.Aggregation.CountOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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()

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

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

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count.Builder

newBuilder(StructuredAggregationQuery.Aggregation.Count prototype)

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

Parameter

Name	Description
prototype	`StructuredAggregationQuery.Aggregation.Count`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count.Builder

parseDelimitedFrom(InputStream input)

public static StructuredAggregationQuery.Aggregation.Count parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	`InputStream`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`InputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(byte[] data)

Parameter

Name	Description
data	`byte[]`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`byte[]`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteString data)

Parameter

Name	Description
data	`ByteString`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`ByteString`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(CodedInputStream input)

Parameter

Name	Description
input	`CodedInputStream`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(InputStream input)

Parameter

Name	Description
input	`InputStream`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`InputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteBuffer data)

Parameter

Name	Description
data	`ByteBuffer`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Count parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`ByteBuffer`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

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

Returns

Type	Description
Parser<Count>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	`Object`

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public StructuredAggregationQuery.Aggregation.Count getDefaultInstanceForType()

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count

getParserForType()

public Parser<StructuredAggregationQuery.Aggregation.Count> getParserForType()

Returns

Type	Description
Parser<Count>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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.

getUpToOrBuilder()

public Int64ValueOrBuilder getUpToOrBuilder()

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()

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()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public StructuredAggregationQuery.Aggregation.Count.Builder newBuilderForType()

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredAggregationQuery.Aggregation.Count.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	`BuilderParent`

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	`UnusedPrivateParameter`

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public StructuredAggregationQuery.Aggregation.Count.Builder toBuilder()

Returns

Type	Description
StructuredAggregationQuery.Aggregation.Count.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException