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
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
STRUCTURED_QUERY_FIELD_NUMBER
public static final int STRUCTURED_QUERY_FIELD_NUMBER
Field Value
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RunQueryRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RunQueryRequest.Builder newBuilder()
Returns
newBuilder(RunQueryRequest prototype)
public static RunQueryRequest.Builder newBuilder(RunQueryRequest prototype)
Parameter
Returns
public static RunQueryRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RunQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RunQueryRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RunQueryRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RunQueryRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RunQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RunQueryRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RunQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RunQueryRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RunQueryRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getConsistencySelectorCase()
public RunQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
getDefaultInstanceForType()
public RunQueryRequest getDefaultInstanceForType()
Returns
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;
Returns
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;
Returns
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
getParserForType()
public Parser<RunQueryRequest> getParserForType()
Returns
Overrides
getQueryTypeCase()
public RunQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
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
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;
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStructuredQuery()
public StructuredQuery getStructuredQuery()
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Returns
getStructuredQueryOrBuilder()
public StructuredQueryOrBuilder getStructuredQueryOrBuilder()
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Returns
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RunQueryRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RunQueryRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions