Class RunAggregationQueryRequest (3.11.0)

Version 3.11.0

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public final class RunAggregationQueryRequest extends GeneratedMessageV3 implements RunAggregationQueryRequestOrBuilder

The request for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RunAggregationQueryRequest

Implements

RunAggregationQueryRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

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

AbstractMessage.equals(Object other)

getConsistencySelectorCase()

public RunAggregationQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()

Returns
Type	Description
RunAggregationQueryRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public RunAggregationQueryRequest getDefaultInstanceForType()

Returns
Type	Description
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
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

GeneratedMessageV3.getParserForType()

getQueryTypeCase()

public RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()

Returns
Type	Description
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
Type	Description
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
Type	Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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. Requires:

• Cannot be more than 270 seconds in the past.

.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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public RunAggregationQueryRequest.Builder toBuilder()

Returns
Type	Description
RunAggregationQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException