com.google.firestore.v1

Interface RunQueryRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RunQueryRequest, RunQueryRequest.Builder

public interface RunQueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
RunQueryRequest.ConsistencySelectorCase	getConsistencySelectorCase()
TransactionOptions	getNewTransaction() Starts a new transaction and reads the documents.
TransactionOptionsOrBuilder	getNewTransactionOrBuilder() Starts a new transaction and reads the documents.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
RunQueryRequest.QueryTypeCase	getQueryTypeCase()
com.google.protobuf.Timestamp	getReadTime() Reads documents as they were at the given time.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() Reads documents as they were at the given time.
StructuredQuery	getStructuredQuery() A structured query.
StructuredQueryOrBuilder	getStructuredQueryOrBuilder() A structured query.
com.google.protobuf.ByteString	getTransaction() Run the query within an already active transaction.
boolean	hasNewTransaction() Starts a new transaction and reads the documents.
boolean	hasReadTime() Reads documents as they were at the given time.
boolean	hasStructuredQuery() A structured query.
boolean	hasTransaction() Run the query within an already active transaction.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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:

The parent.

getParentBytes

com.google.protobuf.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:

The bytes for parent.

hasStructuredQuery

boolean hasStructuredQuery()

 A structured query.
 

.google.firestore.v1.StructuredQuery structured_query = 2;

Returns:

Whether the structuredQuery field is set.

getStructuredQuery

StructuredQuery getStructuredQuery()

 A structured query.
 

.google.firestore.v1.StructuredQuery structured_query = 2;

Returns:

The structuredQuery.

getStructuredQueryOrBuilder

StructuredQueryOrBuilder getStructuredQueryOrBuilder()

 A structured query.
 

.google.firestore.v1.StructuredQuery structured_query = 2;

hasTransaction

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:

Whether the transaction field is set.

getTransaction

com.google.protobuf.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:

The transaction.

hasNewTransaction

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:

Whether the newTransaction field is set.

getNewTransaction

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:

The newTransaction.

getNewTransactionOrBuilder

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;

hasReadTime

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:

Whether the readTime field is set.

getReadTime

com.google.protobuf.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:

The readTime.

getReadTimeOrBuilder

com.google.protobuf.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;

getQueryTypeCase

RunQueryRequest.QueryTypeCase getQueryTypeCase()

getConsistencySelectorCase

RunQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()