public static final class StructuredAggregationQuery.Aggregation extends GeneratedMessageV3 implements StructuredAggregationQuery.AggregationOrBuilderDefines an aggregation that produces a single result.
Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StructuredAggregationQuery.AggregationStatic Fields
ALIAS_FIELD_NUMBER
public static final int ALIAS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
COUNT_FIELD_NUMBER
public static final int COUNT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static StructuredAggregationQuery.Aggregation getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static StructuredAggregationQuery.Aggregation.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Builder | |
newBuilder(StructuredAggregationQuery.Aggregation prototype)
public static StructuredAggregationQuery.Aggregation.Builder newBuilder(StructuredAggregationQuery.Aggregation prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | StructuredAggregationQuery.Aggregation |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Builder | |
parseDelimitedFrom(InputStream input)
public static StructuredAggregationQuery.Aggregation parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery.Aggregation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static StructuredAggregationQuery.Aggregation parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery.Aggregation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
public static StructuredAggregationQuery.Aggregation parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery.Aggregation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
public static StructuredAggregationQuery.Aggregation parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery.Aggregation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
public static StructuredAggregationQuery.Aggregation parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery.Aggregation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
public static StructuredAggregationQuery.Aggregation parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery.Aggregation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
public static Parser<StructuredAggregationQuery.Aggregation> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Aggregation> | |
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getAlias()
public String 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;
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Count | The count. |
getCountOrBuilder()
public StructuredAggregationQuery.Aggregation.CountOrBuilder getCountOrBuilder()Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.CountOrBuilder | |
getDefaultInstanceForType()
public StructuredAggregationQuery.Aggregation getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation | |
getOperatorCase()
public StructuredAggregationQuery.Aggregation.OperatorCase getOperatorCase()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.OperatorCase | |
getParserForType()
public Parser<StructuredAggregationQuery.Aggregation> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Aggregation> | |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Returns | |
|---|---|
| Type | Description |
UnknownFieldSet | |
hasCount()
public boolean hasCount()Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the count field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
public StructuredAggregationQuery.Aggregation.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredAggregationQuery.Aggregation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public StructuredAggregationQuery.Aggregation.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
StructuredAggregationQuery.Aggregation.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |