Class RunQueryRequest.Builder (3.15.7)

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

Implements

RunQueryRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConsistencySelector()

public RunQueryRequest.Builder clearConsistencySelector()

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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()

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The parent.

getParentBytes()

public ByteString getParentBytes()

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.

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public RunQueryRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`RunQueryRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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)

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)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)