Class RunQueryRequest.Builder (3.4.0)

public static final class RunQueryRequest.Builder extends GeneratedMessageV3.Builder<RunQueryRequest.Builder> implements RunQueryRequestOrBuilder

The request for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

build()

public RunQueryRequest build()
Returns
TypeDescription
RunQueryRequest

buildPartial()

public RunQueryRequest buildPartial()
Returns
TypeDescription
RunQueryRequest

clear()

public RunQueryRequest.Builder clear()
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

clearConsistencySelector()

public RunQueryRequest.Builder clearConsistencySelector()
Returns
TypeDescription
RunQueryRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public RunQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

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
TypeDescription
RunQueryRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RunQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

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
TypeDescription
RunQueryRequest.Builder

This builder for chaining.

clearQueryType()

public RunQueryRequest.Builder clearQueryType()
Returns
TypeDescription
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;

Returns
TypeDescription
RunQueryRequest.Builder

clearStructuredQuery()

public RunQueryRequest.Builder clearStructuredQuery()

A structured query.

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

Returns
TypeDescription
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
TypeDescription
RunQueryRequest.Builder

This builder for chaining.

clone()

public RunQueryRequest.Builder clone()
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

getConsistencySelectorCase()

public RunQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
TypeDescription
RunQueryRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public RunQueryRequest getDefaultInstanceForType()
Returns
TypeDescription
RunQueryRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getQueryTypeCase()

public RunQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
TimestampOrBuilder

getStructuredQuery()

public StructuredQuery getStructuredQuery()

A structured query.

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

Returns
TypeDescription
StructuredQuery

The structuredQuery.

getStructuredQueryBuilder()

public StructuredQuery.Builder getStructuredQueryBuilder()

A structured query.

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

Returns
TypeDescription
StructuredQuery.Builder

getStructuredQueryOrBuilder()

public StructuredQueryOrBuilder getStructuredQueryOrBuilder()

A structured query.

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

Returns
TypeDescription
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
TypeDescription
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;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the readTime field is set.

hasStructuredQuery()

public boolean hasStructuredQuery()

A structured query.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the transaction field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RunQueryRequest other)

public RunQueryRequest.Builder mergeFrom(RunQueryRequest other)
Parameter
NameDescription
otherRunQueryRequest
Returns
TypeDescription
RunQueryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RunQueryRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

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
NameDescription
valueTransactionOptions
Returns
TypeDescription
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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
RunQueryRequest.Builder

mergeStructuredQuery(StructuredQuery value)

public RunQueryRequest.Builder mergeStructuredQuery(StructuredQuery value)

A structured query.

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

Parameter
NameDescription
valueStructuredQuery
Returns
TypeDescription
RunQueryRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RunQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

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
NameDescription
valueTransactionOptions
Returns
TypeDescription
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
NameDescription
builderForValueTransactionOptions.Builder
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
RunQueryRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RunQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RunQueryRequest.Builder
Overrides

setStructuredQuery(StructuredQuery value)

public RunQueryRequest.Builder setStructuredQuery(StructuredQuery value)

A structured query.

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

Parameter
NameDescription
valueStructuredQuery
Returns
TypeDescription
RunQueryRequest.Builder

setStructuredQuery(StructuredQuery.Builder builderForValue)

public RunQueryRequest.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)

A structured query.

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

Parameter
NameDescription
builderForValueStructuredQuery.Builder
Returns
TypeDescription
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
NameDescription
valueByteString

The transaction to set.

Returns
TypeDescription
RunQueryRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RunQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunQueryRequest.Builder
Overrides