Class AggregationQuery.Builder (2.20.0)

public static final class AggregationQuery.Builder extends GeneratedMessageV3.Builder<AggregationQuery.Builder> implements AggregationQueryOrBuilder

Datastore query for running an aggregation over a Query.

Protobuf type google.datastore.v1.AggregationQuery

Static Methods

getDescriptor()

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

Methods

addAggregations(AggregationQuery.Aggregation value)

public AggregationQuery.Builder addAggregations(AggregationQuery.Aggregation value)

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
value AggregationQuery.Aggregation
Returns
Type Description
AggregationQuery.Builder

addAggregations(AggregationQuery.Aggregation.Builder builderForValue)

public AggregationQuery.Builder addAggregations(AggregationQuery.Aggregation.Builder builderForValue)

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
builderForValue AggregationQuery.Aggregation.Builder
Returns
Type Description
AggregationQuery.Builder

addAggregations(int index, AggregationQuery.Aggregation value)

public AggregationQuery.Builder addAggregations(int index, AggregationQuery.Aggregation value)

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];

Parameters
Name Description
index int
value AggregationQuery.Aggregation
Returns
Type Description
AggregationQuery.Builder

addAggregations(int index, AggregationQuery.Aggregation.Builder builderForValue)

public AggregationQuery.Builder addAggregations(int index, AggregationQuery.Aggregation.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AggregationQuery.Aggregation.Builder
Returns
Type Description
AggregationQuery.Builder

addAggregationsBuilder()

public AggregationQuery.Aggregation.Builder addAggregationsBuilder()

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
AggregationQuery.Aggregation.Builder

addAggregationsBuilder(int index)

public AggregationQuery.Aggregation.Builder addAggregationsBuilder(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.Builder

addAllAggregations(Iterable<? extends AggregationQuery.Aggregation> values)

public AggregationQuery.Builder addAllAggregations(Iterable<? extends AggregationQuery.Aggregation> values)

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
values Iterable<? extends com.google.datastore.v1.AggregationQuery.Aggregation>
Returns
Type Description
AggregationQuery.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AggregationQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AggregationQuery.Builder
Overrides

build()

public AggregationQuery build()
Returns
Type Description
AggregationQuery

buildPartial()

public AggregationQuery buildPartial()
Returns
Type Description
AggregationQuery

clear()

public AggregationQuery.Builder clear()
Returns
Type Description
AggregationQuery.Builder
Overrides

clearAggregations()

public AggregationQuery.Builder clearAggregations()

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
AggregationQuery.Builder

clearField(Descriptors.FieldDescriptor field)

public AggregationQuery.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AggregationQuery.Builder
Overrides

clearNestedQuery()

public AggregationQuery.Builder clearNestedQuery()

Nested query for aggregation

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

Returns
Type Description
AggregationQuery.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AggregationQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AggregationQuery.Builder
Overrides

clearQueryType()

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

clone()

public AggregationQuery.Builder clone()
Returns
Type Description
AggregationQuery.Builder
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

getAggregationsBuilder(int index)

public AggregationQuery.Aggregation.Builder getAggregationsBuilder(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.Builder

getAggregationsBuilderList()

public List<AggregationQuery.Aggregation.Builder> getAggregationsBuilderList()

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<Builder>

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getNestedQuery()

public Query getNestedQuery()

Nested query for aggregation

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

Returns
Type Description
Query

The nestedQuery.

getNestedQueryBuilder()

public Query.Builder getNestedQueryBuilder()

Nested query for aggregation

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

Returns
Type Description
Query.Builder

getNestedQueryOrBuilder()

public QueryOrBuilder getNestedQueryOrBuilder()

Nested query for aggregation

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

Returns
Type Description
QueryOrBuilder

getQueryTypeCase()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AggregationQuery other)

public AggregationQuery.Builder mergeFrom(AggregationQuery other)
Parameter
Name Description
other AggregationQuery
Returns
Type Description
AggregationQuery.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AggregationQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationQuery.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AggregationQuery.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AggregationQuery.Builder
Overrides

mergeNestedQuery(Query value)

public AggregationQuery.Builder mergeNestedQuery(Query value)

Nested query for aggregation

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

Parameter
Name Description
value Query
Returns
Type Description
AggregationQuery.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AggregationQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AggregationQuery.Builder
Overrides

removeAggregations(int index)

public AggregationQuery.Builder removeAggregations(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.Builder

setAggregations(int index, AggregationQuery.Aggregation value)

public AggregationQuery.Builder setAggregations(int index, AggregationQuery.Aggregation value)

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];

Parameters
Name Description
index int
value AggregationQuery.Aggregation
Returns
Type Description
AggregationQuery.Builder

setAggregations(int index, AggregationQuery.Aggregation.Builder builderForValue)

public AggregationQuery.Builder setAggregations(int index, AggregationQuery.Aggregation.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AggregationQuery.Aggregation.Builder
Returns
Type Description
AggregationQuery.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AggregationQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AggregationQuery.Builder
Overrides

setNestedQuery(Query value)

public AggregationQuery.Builder setNestedQuery(Query value)

Nested query for aggregation

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

Parameter
Name Description
value Query
Returns
Type Description
AggregationQuery.Builder

setNestedQuery(Query.Builder builderForValue)

public AggregationQuery.Builder setNestedQuery(Query.Builder builderForValue)

Nested query for aggregation

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

Parameter
Name Description
builderForValue Query.Builder
Returns
Type Description
AggregationQuery.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AggregationQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AggregationQuery.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AggregationQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AggregationQuery.Builder
Overrides