Class RunAggregationQueryRequest (3.11.0)

public final class RunAggregationQueryRequest extends GeneratedMessageV3 implements RunAggregationQueryRequestOrBuilder

The request for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryRequest

Static Fields

NEW_TRANSACTION_FIELD_NUMBER

public static final int NEW_TRANSACTION_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STRUCTURED_AGGREGATION_QUERY_FIELD_NUMBER

public static final int STRUCTURED_AGGREGATION_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RunAggregationQueryRequest getDefaultInstance()
Returns
TypeDescription
RunAggregationQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RunAggregationQueryRequest.Builder newBuilder()
Returns
TypeDescription
RunAggregationQueryRequest.Builder

newBuilder(RunAggregationQueryRequest prototype)

public static RunAggregationQueryRequest.Builder newBuilder(RunAggregationQueryRequest prototype)
Parameter
NameDescription
prototypeRunAggregationQueryRequest
Returns
TypeDescription
RunAggregationQueryRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunAggregationQueryRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RunAggregationQueryRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunAggregationQueryRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunAggregationQueryRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RunAggregationQueryRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RunAggregationQueryRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunAggregationQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunAggregationQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RunAggregationQueryRequest> parser()
Returns
TypeDescription
Parser<RunAggregationQueryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getConsistencySelectorCase()

public RunAggregationQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
TypeDescription
RunAggregationQueryRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public RunAggregationQueryRequest getDefaultInstanceForType()
Returns
TypeDescription
RunAggregationQueryRequest

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<RunAggregationQueryRequest> getParserForType()
Returns
TypeDescription
Parser<RunAggregationQueryRequest>
Overrides

getQueryTypeCase()

public RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
TypeDescription
RunAggregationQueryRequest.QueryTypeCase

getReadTime()

public Timestamp getReadTime()

Executes the query at the given timestamp. Requires:

  • Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Returns
TypeDescription
Timestamp

The readTime.

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Executes the query at the given timestamp. Requires:

  • Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Returns
TypeDescription
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStructuredAggregationQuery()

public StructuredAggregationQuery getStructuredAggregationQuery()

An aggregation query.

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

Returns
TypeDescription
StructuredAggregationQuery

The structuredAggregationQuery.

getStructuredAggregationQueryOrBuilder()

public StructuredAggregationQueryOrBuilder getStructuredAggregationQueryOrBuilder()

An aggregation query.

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

Returns
TypeDescription
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
TypeDescription
ByteString

The transaction.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
boolean

Whether the newTransaction field is set.

hasReadTime()

public boolean hasReadTime()

Executes the query at the given timestamp. Requires:

  • Cannot be more than 270 seconds in the past.

.google.protobuf.Timestamp read_time = 6;

Returns
TypeDescription
boolean

Whether the readTime field is set.

hasStructuredAggregationQuery()

public boolean hasStructuredAggregationQuery()

An aggregation query.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the transaction field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RunAggregationQueryRequest.Builder newBuilderForType()
Returns
TypeDescription
RunAggregationQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunAggregationQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RunAggregationQueryRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RunAggregationQueryRequest.Builder toBuilder()
Returns
TypeDescription
RunAggregationQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException