Class StructuredAggregationQuery (3.22.0)

public final class StructuredAggregationQuery extends GeneratedMessageV3 implements StructuredAggregationQueryOrBuilder

Firestore query for running an aggregation over a StructuredQuery.

Protobuf type google.firestore.v1.StructuredAggregationQuery

Static Fields

AGGREGATIONS_FIELD_NUMBER

public static final int AGGREGATIONS_FIELD_NUMBER
Field Value
Type Description
int

STRUCTURED_QUERY_FIELD_NUMBER

public static final int STRUCTURED_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StructuredAggregationQuery getDefaultInstance()
Returns
Type Description
StructuredAggregationQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StructuredAggregationQuery.Builder newBuilder()
Returns
Type Description
StructuredAggregationQuery.Builder

newBuilder(StructuredAggregationQuery prototype)

public static StructuredAggregationQuery.Builder newBuilder(StructuredAggregationQuery prototype)
Parameter
Name Description
prototype StructuredAggregationQuery
Returns
Type Description
StructuredAggregationQuery.Builder

parseDelimitedFrom(InputStream input)

public static StructuredAggregationQuery parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StructuredAggregationQuery parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StructuredAggregationQuery parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StructuredAggregationQuery parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StructuredAggregationQuery parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StructuredAggregationQuery parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StructuredAggregationQuery> parser()
Returns
Type Description
Parser<StructuredAggregationQuery>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAggregations(int index)

public StructuredAggregationQuery.Aggregation getAggregations(int index)

Optional. Series of aggregations to apply over the results of the structured_query.

Requires:

  • A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
StructuredAggregationQuery.Aggregation

getAggregationsCount()

public int getAggregationsCount()

Optional. Series of aggregations to apply over the results of the structured_query.

Requires:

  • A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAggregationsList()

public List<StructuredAggregationQuery.Aggregation> getAggregationsList()

Optional. Series of aggregations to apply over the results of the structured_query.

Requires:

  • A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Aggregation>

getAggregationsOrBuilder(int index)

public StructuredAggregationQuery.AggregationOrBuilder getAggregationsOrBuilder(int index)

Optional. Series of aggregations to apply over the results of the structured_query.

Requires:

  • A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
StructuredAggregationQuery.AggregationOrBuilder

getAggregationsOrBuilderList()

public List<? extends StructuredAggregationQuery.AggregationOrBuilder> getAggregationsOrBuilderList()

Optional. Series of aggregations to apply over the results of the structured_query.

Requires:

  • A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.firestore.v1.StructuredAggregationQuery.AggregationOrBuilder>

getDefaultInstanceForType()

public StructuredAggregationQuery getDefaultInstanceForType()
Returns
Type Description
StructuredAggregationQuery

getParserForType()

public Parser<StructuredAggregationQuery> getParserForType()
Returns
Type Description
Parser<StructuredAggregationQuery>
Overrides

getQueryTypeCase()

public StructuredAggregationQuery.QueryTypeCase getQueryTypeCase()
Returns
Type Description
StructuredAggregationQuery.QueryTypeCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStructuredQuery()

public StructuredQuery getStructuredQuery()

Nested structured query.

.google.firestore.v1.StructuredQuery structured_query = 1;

Returns
Type Description
StructuredQuery

The structuredQuery.

getStructuredQueryOrBuilder()

public StructuredQueryOrBuilder getStructuredQueryOrBuilder()

Nested structured query.

.google.firestore.v1.StructuredQuery structured_query = 1;

Returns
Type Description
StructuredQueryOrBuilder

hasStructuredQuery()

public boolean hasStructuredQuery()

Nested structured query.

.google.firestore.v1.StructuredQuery structured_query = 1;

Returns
Type Description
boolean

Whether the structuredQuery field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StructuredAggregationQuery.Builder newBuilderForType()
Returns
Type Description
StructuredAggregationQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredAggregationQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StructuredAggregationQuery.Builder toBuilder()
Returns
Type Description
StructuredAggregationQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException