Send feedback
Class RunQueryRequest (3.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.10.0keyboard_arrow_down
public final class RunQueryRequest extends GeneratedMessageV3 implements RunQueryRequestOrBuilder
The request for Firestore.RunQuery .
Protobuf type google.firestore.v1.RunQueryRequest
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_QUERY_FIELD_NUMBER
public static final int STRUCTURED_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 RunQueryRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static RunQueryRequest . Builder newBuilder ()
newBuilder(RunQueryRequest prototype)
public static RunQueryRequest . Builder newBuilder ( RunQueryRequest prototype )
public static RunQueryRequest parseDelimitedFrom ( InputStream input )
public static RunQueryRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static RunQueryRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunQueryRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static RunQueryRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunQueryRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static RunQueryRequest parseFrom ( CodedInputStream input )
public static RunQueryRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static RunQueryRequest parseFrom ( InputStream input )
public static RunQueryRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static RunQueryRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunQueryRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<RunQueryRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getConsistencySelectorCase()
public RunQueryRequest . ConsistencySelectorCase getConsistencySelectorCase ()
getDefaultInstanceForType()
public RunQueryRequest getDefaultInstanceForType ()
getNewTransaction()
public TransactionOptions getNewTransaction ()
Starts a new transaction and reads the documents.
Defaults to a read-only transaction.
The new transaction ID will be returned as the first response in the
stream.
.google.firestore.v1.TransactionOptions new_transaction = 6;
getNewTransactionOrBuilder()
public TransactionOptionsOrBuilder getNewTransactionOrBuilder ()
Starts a new transaction and reads the documents.
Defaults to a read-only transaction.
The new transaction ID will be returned as the first response in the
stream.
.google.firestore.v1.TransactionOptions new_transaction = 6;
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<RunQueryRequest> getParserForType ()
Overrides
getQueryTypeCase()
public RunQueryRequest . QueryTypeCase getQueryTypeCase ()
getReadTime()
public Timestamp getReadTime ()
Reads documents as they were at the given time.
This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;
Returns
Type Description
Timestamp The readTime.
getReadTimeOrBuilder()
public TimestampOrBuilder getReadTimeOrBuilder ()
Reads documents as they were at the given time.
This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getStructuredQuery()
public StructuredQuery getStructuredQuery ()
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
getStructuredQueryOrBuilder()
public StructuredQueryOrBuilder getStructuredQueryOrBuilder ()
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
getTransaction()
public ByteString getTransaction ()
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 5;
Returns
Type Description
ByteString The transaction.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hasNewTransaction()
public boolean hasNewTransaction ()
Starts a new transaction and reads the documents.
Defaults to a read-only transaction.
The new transaction ID will be returned as the first response in the
stream.
.google.firestore.v1.TransactionOptions new_transaction = 6;
Returns
Type Description
boolean Whether the newTransaction field is set.
hasReadTime()
public boolean hasReadTime ()
Reads documents as they were at the given time.
This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;
Returns
Type Description
boolean Whether the readTime field is set.
hasStructuredQuery()
public boolean hasStructuredQuery ()
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Returns
Type Description
boolean Whether the structuredQuery field is set.
hasTransaction()
public boolean hasTransaction ()
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 5;
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 RunQueryRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunQueryRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public RunQueryRequest . 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-05-30 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-05-30 UTC."],[],[]]
