public static final class RunQueryRequest.Builder extends GeneratedMessageV3.Builder<RunQueryRequest.Builder> implements RunQueryRequestOrBuilder
The request for Firestore.RunQuery.
Protobuf type google.firestore.v1.RunQueryRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunQueryRequest.BuilderImplements
RunQueryRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RunQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
build()
public RunQueryRequest build()
Returns | |
---|---|
Type | Description |
RunQueryRequest |
buildPartial()
public RunQueryRequest buildPartial()
Returns | |
---|---|
Type | Description |
RunQueryRequest |
clear()
public RunQueryRequest.Builder clear()
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
clearConsistencySelector()
public RunQueryRequest.Builder clearConsistencySelector()
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
clearExplainOptions()
public RunQueryRequest.Builder clearExplainOptions()
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 |
RunQueryRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public RunQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
clearNewTransaction()
public RunQueryRequest.Builder clearNewTransaction()
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 |
RunQueryRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public RunQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
clearParent()
public RunQueryRequest.Builder clearParent()
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 |
RunQueryRequest.Builder |
This builder for chaining. |
clearQueryType()
public RunQueryRequest.Builder clearQueryType()
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
clearReadTime()
public RunQueryRequest.Builder clearReadTime()
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 |
RunQueryRequest.Builder |
clearStructuredQuery()
public RunQueryRequest.Builder clearStructuredQuery()
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
clearTransaction()
public RunQueryRequest.Builder clearTransaction()
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 |
RunQueryRequest.Builder |
This builder for chaining. |
clone()
public RunQueryRequest.Builder clone()
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
getConsistencySelectorCase()
public RunQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns | |
---|---|
Type | Description |
RunQueryRequest.ConsistencySelectorCase |
getDefaultInstanceForType()
public RunQueryRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
RunQueryRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getExplainOptions()
public 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. |
getExplainOptionsBuilder()
public ExplainOptions.Builder getExplainOptionsBuilder()
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.Builder |
getExplainOptionsOrBuilder()
public 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 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. |
getNewTransactionBuilder()
public TransactionOptions.Builder getNewTransactionBuilder()
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.Builder |
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 | |
---|---|
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. |
getQueryTypeCase()
public RunQueryRequest.QueryTypeCase getQueryTypeCase()
Returns | |
---|---|
Type | Description |
RunQueryRequest.QueryTypeCase |
getReadTime()
public 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. |
getReadTimeBuilder()
public Timestamp.Builder getReadTimeBuilder()
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 |
Builder |
getReadTimeOrBuilder()
public 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 StructuredQuery getStructuredQuery()
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Returns | |
---|---|
Type | Description |
StructuredQuery |
The structuredQuery. |
getStructuredQueryBuilder()
public StructuredQuery.Builder getStructuredQueryBuilder()
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Returns | |
---|---|
Type | Description |
StructuredQuery.Builder |
getStructuredQueryOrBuilder()
public StructuredQueryOrBuilder getStructuredQueryOrBuilder()
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Returns | |
---|---|
Type | Description |
StructuredQueryOrBuilder |
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. |
hasExplainOptions()
public 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeExplainOptions(ExplainOptions value)
public RunQueryRequest.Builder mergeExplainOptions(ExplainOptions value)
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];
Parameter | |
---|---|
Name | Description |
value |
ExplainOptions |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
mergeFrom(RunQueryRequest other)
public RunQueryRequest.Builder mergeFrom(RunQueryRequest other)
Parameter | |
---|---|
Name | Description |
other |
RunQueryRequest |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RunQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public RunQueryRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
mergeNewTransaction(TransactionOptions value)
public RunQueryRequest.Builder mergeNewTransaction(TransactionOptions value)
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;
Parameter | |
---|---|
Name | Description |
value |
TransactionOptions |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
mergeReadTime(Timestamp value)
public RunQueryRequest.Builder mergeReadTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
mergeStructuredQuery(StructuredQuery value)
public RunQueryRequest.Builder mergeStructuredQuery(StructuredQuery value)
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Parameter | |
---|---|
Name | Description |
value |
StructuredQuery |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RunQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setExplainOptions(ExplainOptions value)
public RunQueryRequest.Builder setExplainOptions(ExplainOptions value)
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];
Parameter | |
---|---|
Name | Description |
value |
ExplainOptions |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setExplainOptions(ExplainOptions.Builder builderForValue)
public RunQueryRequest.Builder setExplainOptions(ExplainOptions.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
ExplainOptions.Builder |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public RunQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setNewTransaction(TransactionOptions value)
public RunQueryRequest.Builder setNewTransaction(TransactionOptions value)
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;
Parameter | |
---|---|
Name | Description |
value |
TransactionOptions |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setNewTransaction(TransactionOptions.Builder builderForValue)
public RunQueryRequest.Builder setNewTransaction(TransactionOptions.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
TransactionOptions.Builder |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setParent(String value)
public RunQueryRequest.Builder setParent(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public RunQueryRequest.Builder setParentBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
This builder for chaining. |
setReadTime(Timestamp value)
public RunQueryRequest.Builder setReadTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setReadTime(Timestamp.Builder builderForValue)
public RunQueryRequest.Builder setReadTime(Timestamp.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RunQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setStructuredQuery(StructuredQuery value)
public RunQueryRequest.Builder setStructuredQuery(StructuredQuery value)
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Parameter | |
---|---|
Name | Description |
value |
StructuredQuery |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setStructuredQuery(StructuredQuery.Builder builderForValue)
public RunQueryRequest.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)
A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
Parameter | |
---|---|
Name | Description |
builderForValue |
StructuredQuery.Builder |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
setTransaction(ByteString value)
public RunQueryRequest.Builder setTransaction(ByteString value)
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 5;
Parameter | |
---|---|
Name | Description |
value |
ByteString The transaction to set. |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RunQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |