Send feedback
Class RunAggregationQueryRequest (3.15.7)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.15.7 keyboard_arrow_down
public final class RunAggregationQueryRequest extends GeneratedMessageV3 implements RunAggregationQueryRequestOrBuilder
The request for
Firestore.RunAggregationQuery .
Protobuf type google.firestore.v1.RunAggregationQueryRequest
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
NEW_TRANSACTION_FIELD_NUMBER
public static final int NEW_TRANSACTION_FIELD_NUMBER
Field Value Type Description int
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value Type Description int
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value Type Description int
STRUCTURED_AGGREGATION_QUERY_FIELD_NUMBER
public static final int STRUCTURED_AGGREGATION_QUERY_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 RunAggregationQueryRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static RunAggregationQueryRequest . Builder newBuilder ()
newBuilder(RunAggregationQueryRequest prototype)
public static RunAggregationQueryRequest . Builder newBuilder ( RunAggregationQueryRequest prototype )
public static RunAggregationQueryRequest parseDelimitedFrom ( InputStream input )
public static RunAggregationQueryRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static RunAggregationQueryRequest parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunAggregationQueryRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static RunAggregationQueryRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunAggregationQueryRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static RunAggregationQueryRequest parseFrom ( CodedInputStream input )
public static RunAggregationQueryRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static RunAggregationQueryRequest parseFrom ( InputStream input )
public static RunAggregationQueryRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static RunAggregationQueryRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunAggregationQueryRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<RunAggregationQueryRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getConsistencySelectorCase()
public RunAggregationQueryRequest . ConsistencySelectorCase getConsistencySelectorCase ()
getDefaultInstanceForType()
public RunAggregationQueryRequest getDefaultInstanceForType ()
getNewTransaction()
public TransactionOptions getNewTransaction ()
Starts a new transaction as part of the query, defaulting to read-only.
The new transaction ID will be returned as the first response in the
stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;
getNewTransactionOrBuilder()
public TransactionOptionsOrBuilder getNewTransactionOrBuilder ()
Starts a new transaction as part of the query, defaulting to read-only.
The new transaction ID will be returned as the first response in the
stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;
getParent()
public String getParent ()
Required. The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documents or
projects/{project_id}/databases/{database_id}/documents/{document_path}.
For example:
projects/my-project/databases/my-database/documents or
projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
Returns Type Description String The parent.
getParentBytes()
public ByteString getParentBytes ()
Required. The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documents or
projects/{project_id}/databases/{database_id}/documents/{document_path}.
For example:
projects/my-project/databases/my-database/documents or
projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
Returns Type Description ByteString The bytes for parent.
getParserForType()
public Parser<RunAggregationQueryRequest> getParserForType ()
Overrides
getQueryTypeCase()
public RunAggregationQueryRequest . QueryTypeCase getQueryTypeCase ()
getReadTime()
public Timestamp getReadTime ()
Executes the query at the given timestamp.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
.google.protobuf.Timestamp read_time = 6;
getReadTimeOrBuilder()
public TimestampOrBuilder getReadTimeOrBuilder ()
Executes the query at the given timestamp.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
.google.protobuf.Timestamp read_time = 6;
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
getStructuredAggregationQuery()
public StructuredAggregationQuery getStructuredAggregationQuery ()
An aggregation query.
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
getStructuredAggregationQueryOrBuilder()
public StructuredAggregationQueryOrBuilder getStructuredAggregationQueryOrBuilder ()
An aggregation query.
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
getTransaction()
public ByteString getTransaction ()
Run the aggregation within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 4;
hasNewTransaction()
public boolean hasNewTransaction ()
Starts a new transaction as part of the query, defaulting to read-only.
The new transaction ID will be returned as the first response in the
stream.
.google.firestore.v1.TransactionOptions new_transaction = 5;
Returns Type Description boolean Whether the newTransaction field is set.
hasReadTime()
public boolean hasReadTime ()
Executes the query at the given timestamp.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
.google.protobuf.Timestamp read_time = 6;
Returns Type Description boolean Whether the readTime field is set.
hasStructuredAggregationQuery()
public boolean hasStructuredAggregationQuery ()
An aggregation query.
.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;
Returns Type Description boolean Whether the structuredAggregationQuery field is set.
hasTransaction()
public boolean hasTransaction ()
Run the aggregation within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 4;
Returns Type Description boolean Whether the transaction field is set.
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public RunAggregationQueryRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunAggregationQueryRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public RunAggregationQueryRequest . 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-28 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-28 UTC."],[],[]]
