Interface RunQueryRequestOrBuilder (3.22.0) 

public interface RunQueryRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConsistencySelectorCase()

public abstract RunQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
Type Description
RunQueryRequest.ConsistencySelectorCase

getExplainOptions()

public abstract ExplainOptions getExplainOptions()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.firestore.v1.ExplainOptions explain_options = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExplainOptions

The explainOptions.

getExplainOptionsOrBuilder()

public abstract ExplainOptionsOrBuilder getExplainOptionsOrBuilder()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.firestore.v1.ExplainOptions explain_options = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExplainOptionsOrBuilder

getNewTransaction()

public abstract 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
Type Description
TransactionOptions

The newTransaction.

getNewTransactionOrBuilder()

public abstract 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
Type Description
TransactionOptionsOrBuilder

getParent()

public abstract 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 abstract 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.

getQueryTypeCase()

public abstract RunQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
Type Description
RunQueryRequest.QueryTypeCase

getReadTime()

public abstract Timestamp getReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 7;

Returns
Type Description
Timestamp

The readTime.

getReadTimeOrBuilder()

public abstract TimestampOrBuilder getReadTimeOrBuilder()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 7;

Returns
Type Description
TimestampOrBuilder

getStructuredQuery()

public abstract StructuredQuery getStructuredQuery()

A structured query.

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

Returns
Type Description
StructuredQuery

The structuredQuery.

getStructuredQueryOrBuilder()

public abstract StructuredQueryOrBuilder getStructuredQueryOrBuilder()

A structured query.

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

Returns
Type Description
StructuredQueryOrBuilder

getTransaction()

public abstract 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.

hasExplainOptions()

public abstract boolean hasExplainOptions()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.firestore.v1.ExplainOptions explain_options = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the explainOptions field is set.

hasNewTransaction()

public abstract 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 abstract boolean hasReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 7;

Returns
Type Description
boolean

Whether the readTime field is set.

hasStructuredQuery()

public abstract boolean hasStructuredQuery()

A structured query.

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

Returns
Type Description
boolean

Whether the structuredQuery field is set.

hasTransaction()

public abstract 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.