com.google.firestore.v1

Class RunQueryRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

com.google.firestore.v1.RunQueryRequest.Builder

All Implemented Interfaces:

RunQueryRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RunQueryRequest

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

 The request for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
 

Protobuf type google.firestore.v1.RunQueryRequest

Method Summary

Modifier and Type	Method and Description
RunQueryRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunQueryRequest	build()
RunQueryRequest	buildPartial()
RunQueryRequest.Builder	clear()
RunQueryRequest.Builder	clearConsistencySelector()
RunQueryRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RunQueryRequest.Builder	clearNewTransaction() Starts a new transaction and reads the documents.
RunQueryRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RunQueryRequest.Builder	clearParent() Required.
RunQueryRequest.Builder	clearQueryType()
RunQueryRequest.Builder	clearReadTime() Reads documents as they were at the given time.
RunQueryRequest.Builder	clearStructuredQuery() A structured query.
RunQueryRequest.Builder	clearTransaction() Run the query within an already active transaction.
RunQueryRequest.Builder	clone()
RunQueryRequest.ConsistencySelectorCase	getConsistencySelectorCase()
RunQueryRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
TransactionOptions	getNewTransaction() Starts a new transaction and reads the documents.
TransactionOptions.Builder	getNewTransactionBuilder() Starts a new transaction and reads the documents.
TransactionOptionsOrBuilder	getNewTransactionOrBuilder() Starts a new transaction and reads the documents.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
RunQueryRequest.QueryTypeCase	getQueryTypeCase()
com.google.protobuf.Timestamp	getReadTime() Reads documents as they were at the given time.
com.google.protobuf.Timestamp.Builder	getReadTimeBuilder() Reads documents as they were at the given time.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() Reads documents as they were at the given time.
StructuredQuery	getStructuredQuery() A structured query.
StructuredQuery.Builder	getStructuredQueryBuilder() A structured query.
StructuredQueryOrBuilder	getStructuredQueryOrBuilder() A structured query.
com.google.protobuf.ByteString	getTransaction() Run the query within an already active transaction.
boolean	hasNewTransaction() Starts a new transaction and reads the documents.
boolean	hasReadTime() Reads documents as they were at the given time.
boolean	hasStructuredQuery() A structured query.
boolean	hasTransaction() Run the query within an already active transaction.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RunQueryRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RunQueryRequest.Builder	mergeFrom(com.google.protobuf.Message other)
RunQueryRequest.Builder	mergeFrom(RunQueryRequest other)
RunQueryRequest.Builder	mergeNewTransaction(TransactionOptions value) Starts a new transaction and reads the documents.
RunQueryRequest.Builder	mergeReadTime(com.google.protobuf.Timestamp value) Reads documents as they were at the given time.
RunQueryRequest.Builder	mergeStructuredQuery(StructuredQuery value) A structured query.
RunQueryRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RunQueryRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunQueryRequest.Builder	setNewTransaction(TransactionOptions.Builder builderForValue) Starts a new transaction and reads the documents.
RunQueryRequest.Builder	setNewTransaction(TransactionOptions value) Starts a new transaction and reads the documents.
RunQueryRequest.Builder	setParent(String value) Required.
RunQueryRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.
RunQueryRequest.Builder	setReadTime(com.google.protobuf.Timestamp.Builder builderForValue) Reads documents as they were at the given time.
RunQueryRequest.Builder	setReadTime(com.google.protobuf.Timestamp value) Reads documents as they were at the given time.
RunQueryRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RunQueryRequest.Builder	setStructuredQuery(StructuredQuery.Builder builderForValue) A structured query.
RunQueryRequest.Builder	setStructuredQuery(StructuredQuery value) A structured query.
RunQueryRequest.Builder	setTransaction(com.google.protobuf.ByteString value) Run the query within an already active transaction.
RunQueryRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

clear

public RunQueryRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

getDefaultInstanceForType

public RunQueryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RunQueryRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RunQueryRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RunQueryRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

setField

public RunQueryRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

clearField

public RunQueryRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

clearOneof

public RunQueryRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

setRepeatedField

public RunQueryRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

addRepeatedField

public RunQueryRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

mergeFrom

public RunQueryRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunQueryRequest.Builder>

mergeFrom

public RunQueryRequest.Builder mergeFrom(RunQueryRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

mergeFrom

public RunQueryRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunQueryRequest.Builder>

Throws:

IOException

getQueryTypeCase

public RunQueryRequest.QueryTypeCase getQueryTypeCase()

Specified by:

getQueryTypeCase in interface RunQueryRequestOrBuilder

clearQueryType

public RunQueryRequest.Builder clearQueryType()

getConsistencySelectorCase

public RunQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()

Specified by:

getConsistencySelectorCase in interface RunQueryRequestOrBuilder

clearConsistencySelector

public RunQueryRequest.Builder clearConsistencySelector()

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];

Specified by:

getParent in interface RunQueryRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.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];

Specified by:

getParentBytes in interface RunQueryRequestOrBuilder

Returns:

The bytes for parent.

setParent

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];

Parameters:

value - The parent to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setParentBytes

public RunQueryRequest.Builder setParentBytes(com.google.protobuf.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];

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

hasStructuredQuery

public boolean hasStructuredQuery()

 A structured query.
 

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

Specified by:

hasStructuredQuery in interface RunQueryRequestOrBuilder

Returns:

Whether the structuredQuery field is set.

getStructuredQuery

public StructuredQuery getStructuredQuery()

 A structured query.
 

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

Specified by:

getStructuredQuery in interface RunQueryRequestOrBuilder

Returns:

The structuredQuery.

setStructuredQuery

public RunQueryRequest.Builder setStructuredQuery(StructuredQuery value)

 A structured query.
 

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

setStructuredQuery

public RunQueryRequest.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)

 A structured query.
 

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

mergeStructuredQuery

public RunQueryRequest.Builder mergeStructuredQuery(StructuredQuery value)

 A structured query.
 

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

clearStructuredQuery

public RunQueryRequest.Builder clearStructuredQuery()

 A structured query.
 

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

getStructuredQueryBuilder

public StructuredQuery.Builder getStructuredQueryBuilder()

 A structured query.
 

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

getStructuredQueryOrBuilder

public StructuredQueryOrBuilder getStructuredQueryOrBuilder()

 A structured query.
 

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

Specified by:

getStructuredQueryOrBuilder in interface RunQueryRequestOrBuilder

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;

Specified by:

hasTransaction in interface RunQueryRequestOrBuilder

Returns:

Whether the transaction field is set.

getTransaction

public com.google.protobuf.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;

Specified by:

getTransaction in interface RunQueryRequestOrBuilder

Returns:

The transaction.

setTransaction

public RunQueryRequest.Builder setTransaction(com.google.protobuf.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;

Parameters:

value - The transaction to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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;

Specified by:

hasNewTransaction in interface RunQueryRequestOrBuilder

Returns:

Whether the newTransaction field is set.

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;

Specified by:

getNewTransaction in interface RunQueryRequestOrBuilder

Returns:

The newTransaction.

setNewTransaction

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;

setNewTransaction

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;

mergeNewTransaction

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;

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;

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;

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;

Specified by:

getNewTransactionOrBuilder in interface RunQueryRequestOrBuilder

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;

Specified by:

hasReadTime in interface RunQueryRequestOrBuilder

Returns:

Whether the readTime field is set.

getReadTime

public com.google.protobuf.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;

Specified by:

getReadTime in interface RunQueryRequestOrBuilder

Returns:

The readTime.

setReadTime

public RunQueryRequest.Builder setReadTime(com.google.protobuf.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;

setReadTime

public RunQueryRequest.Builder setReadTime(com.google.protobuf.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;

mergeReadTime

public RunQueryRequest.Builder mergeReadTime(com.google.protobuf.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;

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;

getReadTimeBuilder

public com.google.protobuf.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;

getReadTimeOrBuilder

public com.google.protobuf.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;

Specified by:

getReadTimeOrBuilder in interface RunQueryRequestOrBuilder

setUnknownFields

public final RunQueryRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>

mergeUnknownFields

public final RunQueryRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>