public static final class RunQueryRequest.Builder extends GeneratedMessageV3.Builder<RunQueryRequest.Builder> implements RunQueryRequestOrBuilderThe 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()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RunQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| RunQueryRequest.Builder |
build()
public RunQueryRequest build()| Type | Description |
| RunQueryRequest |
buildPartial()
public RunQueryRequest buildPartial()| Type | Description |
| RunQueryRequest |
clear()
public RunQueryRequest.Builder clear()| Type | Description |
| RunQueryRequest.Builder |
clearConsistencySelector()
public RunQueryRequest.Builder clearConsistencySelector()| Type | Description |
| RunQueryRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public RunQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| 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;
| Type | Description |
| RunQueryRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public RunQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| 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];
| Type | Description |
| RunQueryRequest.Builder | This builder for chaining. |
clearQueryType()
public RunQueryRequest.Builder clearQueryType()| Type | Description |
| RunQueryRequest.Builder |
clearReadTime()
public RunQueryRequest.Builder clearReadTime()Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;
| Type | Description |
| RunQueryRequest.Builder |
clearStructuredQuery()
public RunQueryRequest.Builder clearStructuredQuery()A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
| 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;
| Type | Description |
| RunQueryRequest.Builder | This builder for chaining. |
clone()
public RunQueryRequest.Builder clone()| Type | Description |
| RunQueryRequest.Builder |
getConsistencySelectorCase()
public RunQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()| Type | Description |
| RunQueryRequest.ConsistencySelectorCase |
getDefaultInstanceForType()
public RunQueryRequest getDefaultInstanceForType()| Type | Description |
| RunQueryRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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;
| 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;
| 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;
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for parent. |
getQueryTypeCase()
public RunQueryRequest.QueryTypeCase getQueryTypeCase()| Type | Description |
| RunQueryRequest.QueryTypeCase |
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;
| Type | Description |
| Timestamp | The readTime. |
getReadTimeBuilder()
public Timestamp.Builder getReadTimeBuilder()Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;
| Type | Description |
| Builder |
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;
| Type | Description |
| TimestampOrBuilder |
getStructuredQuery()
public StructuredQuery getStructuredQuery()A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
| Type | Description |
| StructuredQuery | The structuredQuery. |
getStructuredQueryBuilder()
public StructuredQuery.Builder getStructuredQueryBuilder()A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
| Type | Description |
| StructuredQuery.Builder |
getStructuredQueryOrBuilder()
public StructuredQueryOrBuilder getStructuredQueryOrBuilder()A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
| 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;
| Type | Description |
| ByteString | The transaction. |
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;
| 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;
| Type | Description |
| boolean | Whether the readTime field is set. |
hasStructuredQuery()
public boolean hasStructuredQuery()A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
| 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;
| Type | Description |
| boolean | Whether the transaction field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(RunQueryRequest other)
public RunQueryRequest.Builder mergeFrom(RunQueryRequest other)| Name | Description |
| other | RunQueryRequest |
| Type | Description |
| RunQueryRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RunQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| RunQueryRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public RunQueryRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| 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;
| Name | Description |
| value | TransactionOptions |
| Type | Description |
| RunQueryRequest.Builder |
mergeReadTime(Timestamp value)
public RunQueryRequest.Builder mergeReadTime(Timestamp value)Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;
| Name | Description |
| value | Timestamp |
| Type | Description |
| RunQueryRequest.Builder |
mergeStructuredQuery(StructuredQuery value)
public RunQueryRequest.Builder mergeStructuredQuery(StructuredQuery value)A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
| Name | Description |
| value | StructuredQuery |
| Type | Description |
| RunQueryRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RunQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| RunQueryRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public RunQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| 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;
| Name | Description |
| value | TransactionOptions |
| 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;
| Name | Description |
| builderForValue | TransactionOptions.Builder |
| 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];
| Name | Description |
| value | StringThe parent to set. |
| 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];
| Name | Description |
| value | ByteStringThe bytes for parent to set. |
| 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 may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;
| Name | Description |
| value | Timestamp |
| 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 may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 7;
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| RunQueryRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RunQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| RunQueryRequest.Builder |
setStructuredQuery(StructuredQuery value)
public RunQueryRequest.Builder setStructuredQuery(StructuredQuery value)A structured query.
.google.firestore.v1.StructuredQuery structured_query = 2;
| Name | Description |
| value | StructuredQuery |
| 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;
| Name | Description |
| builderForValue | StructuredQuery.Builder |
| 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;
| Name | Description |
| value | ByteStringThe transaction to set. |
| Type | Description |
| RunQueryRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RunQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| RunQueryRequest.Builder |