Class StructuredAggregationQuery (3.11.0)
Stay organized with collections
Save and categorize content based on your preferences.
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static StructuredAggregationQuery.Builder newBuilder()
newBuilder(StructuredAggregationQuery prototype)
public static StructuredAggregationQuery.Builder newBuilder(StructuredAggregationQuery prototype)
public static StructuredAggregationQuery parseDelimitedFrom(InputStream input)
public static StructuredAggregationQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static StructuredAggregationQuery parseFrom(byte[] data)
Parameter |
---|
Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static StructuredAggregationQuery parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom(CodedInputStream input)
public static StructuredAggregationQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom(InputStream input)
public static StructuredAggregationQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static StructuredAggregationQuery parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<StructuredAggregationQuery> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
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
|
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];
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
|
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()
getParserForType()
public Parser<StructuredAggregationQuery> getParserForType()
Overrides
getQueryTypeCase()
public StructuredAggregationQuery.QueryTypeCase getQueryTypeCase()
getSerializedSize()
public int getSerializedSize()
Returns |
---|
Type | Description |
int | |
Overrides
getStructuredQuery()
public StructuredQuery getStructuredQuery()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
getStructuredQueryOrBuilder()
public StructuredQueryOrBuilder getStructuredQueryOrBuilder()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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()
Returns |
---|
Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public StructuredAggregationQuery.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredAggregationQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public StructuredAggregationQuery.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-04 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-10-04 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-04 UTC."]]