Class RunAggregationQueryRequest (3.28.0)

public final class RunAggregationQueryRequest extends GeneratedMessageV3 implements RunAggregationQueryRequestOrBuilder

The request for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryRequest

Static Fields

EXPLAIN_OPTIONS_FIELD_NUMBER

public static final int EXPLAIN_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

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()
Returns
Type Description
RunAggregationQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RunAggregationQueryRequest.Builder newBuilder()
Returns
Type Description
RunAggregationQueryRequest.Builder

newBuilder(RunAggregationQueryRequest prototype)

public static RunAggregationQueryRequest.Builder newBuilder(RunAggregationQueryRequest prototype)
Parameter
Name Description
prototype RunAggregationQueryRequest
Returns
Type Description
RunAggregationQueryRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunAggregationQueryRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RunAggregationQueryRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunAggregationQueryRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunAggregationQueryRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RunAggregationQueryRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RunAggregationQueryRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAggregationQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RunAggregationQueryRequest> parser()
Returns
Type Description
Parser<RunAggregationQueryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConsistencySelectorCase()

public RunAggregationQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
Type Description
RunAggregationQueryRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public RunAggregationQueryRequest getDefaultInstanceForType()
Returns
Type Description
RunAggregationQueryRequest

getExplainOptions()

public ExplainOptions getExplainOptions()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.firestore.v1.ExplainOptions explain_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExplainOptions

The explainOptions.

getExplainOptionsOrBuilder()

public ExplainOptionsOrBuilder getExplainOptionsOrBuilder()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.firestore.v1.ExplainOptions explain_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExplainOptionsOrBuilder

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;

Returns
Type Description
TransactionOptions

The newTransaction.

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;

Returns
Type Description
TransactionOptionsOrBuilder

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()
Returns
Type Description
Parser<RunAggregationQueryRequest>
Overrides

getQueryTypeCase()

public RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
Type Description
RunAggregationQueryRequest.QueryTypeCase

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;

Returns
Type Description
Timestamp

The readTime.

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;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStructuredAggregationQuery()

public StructuredAggregationQuery getStructuredAggregationQuery()

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Returns
Type Description
StructuredAggregationQuery

The structuredAggregationQuery.

getStructuredAggregationQueryOrBuilder()

public StructuredAggregationQueryOrBuilder getStructuredAggregationQueryOrBuilder()

An aggregation query.

.google.firestore.v1.StructuredAggregationQuery structured_aggregation_query = 2;

Returns
Type Description
StructuredAggregationQueryOrBuilder

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;

Returns
Type Description
ByteString

The transaction.

hasExplainOptions()

public boolean hasExplainOptions()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.firestore.v1.ExplainOptions explain_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the explainOptions field is set.

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RunAggregationQueryRequest.Builder newBuilderForType()
Returns
Type Description
RunAggregationQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunAggregationQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RunAggregationQueryRequest.Builder toBuilder()
Returns
Type Description
RunAggregationQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException