Class AggregationQuery (2.23.0)

public final class AggregationQuery extends GeneratedMessageV3 implements AggregationQueryOrBuilder

Datastore query for running an aggregation over a Query.

Protobuf type google.datastore.v1.AggregationQuery

Static Fields

AGGREGATIONS_FIELD_NUMBER

public static final int AGGREGATIONS_FIELD_NUMBER
Field Value
Type Description
int

NESTED_QUERY_FIELD_NUMBER

public static final int NESTED_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AggregationQuery getDefaultInstance()
Returns
Type Description
AggregationQuery

getDescriptor()

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

newBuilder()

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

newBuilder(AggregationQuery prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAggregations(int index)

public AggregationQuery.Aggregation getAggregations(int index)

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

Requires:

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

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

Parameter
Name Description
index int
Returns
Type Description
AggregationQuery.Aggregation

getAggregationsCount()

public int getAggregationsCount()

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

Requires:

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

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

Returns
Type Description
int

getAggregationsList()

public List<AggregationQuery.Aggregation> getAggregationsList()

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

Requires:

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

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

Returns
Type Description
List<Aggregation>

getAggregationsOrBuilder(int index)

public AggregationQuery.AggregationOrBuilder getAggregationsOrBuilder(int index)

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

Requires:

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

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

Parameter
Name Description
index int
Returns
Type Description
AggregationQuery.AggregationOrBuilder

getAggregationsOrBuilderList()

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

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

Requires:

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

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

Returns
Type Description
List<? extends com.google.datastore.v1.AggregationQuery.AggregationOrBuilder>

getDefaultInstanceForType()

public AggregationQuery getDefaultInstanceForType()
Returns
Type Description
AggregationQuery

getNestedQuery()

public Query getNestedQuery()

Nested query for aggregation

.google.datastore.v1.Query nested_query = 1;

Returns
Type Description
Query

The nestedQuery.

getNestedQueryOrBuilder()

public QueryOrBuilder getNestedQueryOrBuilder()

Nested query for aggregation

.google.datastore.v1.Query nested_query = 1;

Returns
Type Description
QueryOrBuilder

getParserForType()

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

getQueryTypeCase()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasNestedQuery()

public boolean hasNestedQuery()

Nested query for aggregation

.google.datastore.v1.Query nested_query = 1;

Returns
Type Description
boolean

Whether the nestedQuery 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 AggregationQuery.Builder newBuilderForType()
Returns
Type Description
AggregationQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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