Send feedback
Class RunAggregationQueryResponse (3.21.3)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.21.3 keyboard_arrow_down
public final class RunAggregationQueryResponse extends GeneratedMessageV3 implements RunAggregationQueryResponseOrBuilder
The response for
Firestore.RunAggregationQuery .
Protobuf type google.firestore.v1.RunAggregationQueryResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EXPLAIN_METRICS_FIELD_NUMBER
public static final int EXPLAIN_METRICS_FIELD_NUMBER
Field Value
Type Description
int
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int
RESULT_FIELD_NUMBER
public static final int RESULT_FIELD_NUMBER
Field Value
Type Description
int
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static RunAggregationQueryResponse getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static RunAggregationQueryResponse . Builder newBuilder ()
newBuilder(RunAggregationQueryResponse prototype)
public static RunAggregationQueryResponse . Builder newBuilder ( RunAggregationQueryResponse prototype )
public static RunAggregationQueryResponse parseDelimitedFrom ( InputStream input )
public static RunAggregationQueryResponse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static RunAggregationQueryResponse parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunAggregationQueryResponse parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static RunAggregationQueryResponse parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunAggregationQueryResponse parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static RunAggregationQueryResponse parseFrom ( CodedInputStream input )
public static RunAggregationQueryResponse parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static RunAggregationQueryResponse parseFrom ( InputStream input )
public static RunAggregationQueryResponse parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static RunAggregationQueryResponse parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunAggregationQueryResponse parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<RunAggregationQueryResponse> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public RunAggregationQueryResponse getDefaultInstanceForType ()
getExplainMetrics()
public ExplainMetrics getExplainMetrics ()
Query explain metrics. This is only present when the
RunAggregationQueryRequest.explain_options
is provided, and it is sent only once with the last response in the stream.
.google.firestore.v1.ExplainMetrics explain_metrics = 10;
getExplainMetricsOrBuilder()
public ExplainMetricsOrBuilder getExplainMetricsOrBuilder ()
Query explain metrics. This is only present when the
RunAggregationQueryRequest.explain_options
is provided, and it is sent only once with the last response in the stream.
.google.firestore.v1.ExplainMetrics explain_metrics = 10;
getParserForType()
public Parser<RunAggregationQueryResponse> getParserForType ()
Overrides
getReadTime()
public Timestamp getReadTime ()
The time at which the aggregate result was computed. This is always
monotonically increasing; in this case, the previous AggregationResult in
the result stream are guaranteed not to have changed between their
read_time and this one.
If the query returns no results, a response with read_time and no
result will be sent, and this represents the time at which the query
was run.
.google.protobuf.Timestamp read_time = 3;
Returns
Type Description
Timestamp The readTime.
getReadTimeOrBuilder()
public TimestampOrBuilder getReadTimeOrBuilder ()
The time at which the aggregate result was computed. This is always
monotonically increasing; in this case, the previous AggregationResult in
the result stream are guaranteed not to have changed between their
read_time and this one.
If the query returns no results, a response with read_time and no
result will be sent, and this represents the time at which the query
was run.
.google.protobuf.Timestamp read_time = 3;
getResult()
public AggregationResult getResult ()
A single aggregation result.
Not present when reporting partial progress.
.google.firestore.v1.AggregationResult result = 1;
getResultOrBuilder()
public AggregationResultOrBuilder getResultOrBuilder ()
A single aggregation result.
Not present when reporting partial progress.
.google.firestore.v1.AggregationResult result = 1;
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getTransaction()
public ByteString getTransaction ()
The transaction that was started as part of this request.
Only present on the first response when the request requested to start
a new transaction.
bytes transaction = 2;
Returns
Type Description
ByteString The transaction.
hasExplainMetrics()
public boolean hasExplainMetrics ()
Query explain metrics. This is only present when the
RunAggregationQueryRequest.explain_options
is provided, and it is sent only once with the last response in the stream.
.google.firestore.v1.ExplainMetrics explain_metrics = 10;
Returns
Type Description
boolean Whether the explainMetrics field is set.
hasReadTime()
public boolean hasReadTime ()
The time at which the aggregate result was computed. This is always
monotonically increasing; in this case, the previous AggregationResult in
the result stream are guaranteed not to have changed between their
read_time and this one.
If the query returns no results, a response with read_time and no
result will be sent, and this represents the time at which the query
was run.
.google.protobuf.Timestamp read_time = 3;
Returns
Type Description
boolean Whether the readTime field is set.
hasResult()
public boolean hasResult ()
A single aggregation result.
Not present when reporting partial progress.
.google.firestore.v1.AggregationResult result = 1;
Returns
Type Description
boolean Whether the result field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public RunAggregationQueryResponse . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunAggregationQueryResponse . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public RunAggregationQueryResponse . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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 2025-01-27 UTC.
Need to tell us more?
[[["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 2025-01-27 UTC."],[],[]]
