public static final class StructuredAggregationQuery.Aggregation.Builder extends GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Builder> implements StructuredAggregationQuery.AggregationOrBuilder
Defines an aggregation that produces a single result.
Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StructuredAggregationQuery.Aggregation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public StructuredAggregationQuery.Aggregation build()
buildPartial()
public StructuredAggregationQuery.Aggregation buildPartial()
clear()
public StructuredAggregationQuery.Aggregation.Builder clear()
Overrides
clearAlias()
public StructuredAggregationQuery.Aggregation.Builder clearAlias()
Optional. Optional name of the field to store the result of the
aggregation into.
If not provided, Firestore will pick a default name following the format
field_<incremental_id++>
. For example:
<code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2),
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*)
OVER (
...
);
</code></code><code>
becomes:
</code><code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2) AS field_1,
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*) AS field_2
OVER (
...
);
</code></code>
Requires:
- Must be unique across all aggregation aliases.
- Conform to document field name
limitations.
string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
clearCount()
public StructuredAggregationQuery.Aggregation.Builder clearCount()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
clearField(Descriptors.FieldDescriptor field)
public StructuredAggregationQuery.Aggregation.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public StructuredAggregationQuery.Aggregation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearOperator()
public StructuredAggregationQuery.Aggregation.Builder clearOperator()
clone()
public StructuredAggregationQuery.Aggregation.Builder clone()
Overrides
getAlias()
Optional. Optional name of the field to store the result of the
aggregation into.
If not provided, Firestore will pick a default name following the format
field_<incremental_id++>
. For example:
<code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2),
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*)
OVER (
...
);
</code></code><code>
becomes:
</code><code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2) AS field_1,
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*) AS field_2
OVER (
...
);
</code></code>
Requires:
- Must be unique across all aggregation aliases.
- Conform to document field name
limitations.
string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns |
---|
Type | Description |
String | The alias.
|
getAliasBytes()
public ByteString getAliasBytes()
Optional. Optional name of the field to store the result of the
aggregation into.
If not provided, Firestore will pick a default name following the format
field_<incremental_id++>
. For example:
<code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2),
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*)
OVER (
...
);
</code></code><code>
becomes:
</code><code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2) AS field_1,
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*) AS field_2
OVER (
...
);
</code></code>
Requires:
- Must be unique across all aggregation aliases.
- Conform to document field name
limitations.
string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns |
---|
Type | Description |
ByteString | The bytes for alias.
|
getCount()
public StructuredAggregationQuery.Aggregation.Count getCount()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
getCountBuilder()
public StructuredAggregationQuery.Aggregation.Count.Builder getCountBuilder()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
getCountOrBuilder()
public StructuredAggregationQuery.Aggregation.CountOrBuilder getCountOrBuilder()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
getDefaultInstanceForType()
public StructuredAggregationQuery.Aggregation getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getOperatorCase()
public StructuredAggregationQuery.Aggregation.OperatorCase getOperatorCase()
hasCount()
public boolean hasCount()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
Returns |
---|
Type | Description |
boolean | Whether the count field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeCount(StructuredAggregationQuery.Aggregation.Count value)
public StructuredAggregationQuery.Aggregation.Builder mergeCount(StructuredAggregationQuery.Aggregation.Count value)
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
mergeFrom(StructuredAggregationQuery.Aggregation other)
public StructuredAggregationQuery.Aggregation.Builder mergeFrom(StructuredAggregationQuery.Aggregation other)
public StructuredAggregationQuery.Aggregation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public StructuredAggregationQuery.Aggregation.Builder mergeFrom(Message other)
Parameter |
---|
Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StructuredAggregationQuery.Aggregation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setAlias(String value)
public StructuredAggregationQuery.Aggregation.Builder setAlias(String value)
Optional. Optional name of the field to store the result of the
aggregation into.
If not provided, Firestore will pick a default name following the format
field_<incremental_id++>
. For example:
<code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2),
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*)
OVER (
...
);
</code></code><code>
becomes:
</code><code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2) AS field_1,
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*) AS field_2
OVER (
...
);
</code></code>
Requires:
- Must be unique across all aggregation aliases.
- Conform to document field name
limitations.
string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
---|
Name | Description |
value | String
The alias to set.
|
setAliasBytes(ByteString value)
public StructuredAggregationQuery.Aggregation.Builder setAliasBytes(ByteString value)
Optional. Optional name of the field to store the result of the
aggregation into.
If not provided, Firestore will pick a default name following the format
field_<incremental_id++>
. For example:
<code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2),
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*)
OVER (
...
);
</code></code><code>
becomes:
</code><code><code>
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2) AS field_1,
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*) AS field_2
OVER (
...
);
</code></code>
Requires:
- Must be unique across all aggregation aliases.
- Conform to document field name
limitations.
string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
---|
Name | Description |
value | ByteString
The bytes for alias to set.
|
setCount(StructuredAggregationQuery.Aggregation.Count value)
public StructuredAggregationQuery.Aggregation.Builder setCount(StructuredAggregationQuery.Aggregation.Count value)
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
setCount(StructuredAggregationQuery.Aggregation.Count.Builder builderForValue)
public StructuredAggregationQuery.Aggregation.Builder setCount(StructuredAggregationQuery.Aggregation.Count.Builder builderForValue)
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
setField(Descriptors.FieldDescriptor field, Object value)
public StructuredAggregationQuery.Aggregation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StructuredAggregationQuery.Aggregation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final StructuredAggregationQuery.Aggregation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides