RunQueryRequest.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>
    - - com.google.firestore.v1beta1.RunQueryRequest.Builder

All Implemented Interfaces:: RunQueryRequestOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: RunQueryRequest

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

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

Protobuf type google.firestore.v1beta1.RunQueryRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RunQueryRequest.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`RunQueryRequest`	`build()`
`RunQueryRequest`	`buildPartial()`
`RunQueryRequest.Builder`	`clear()`
`RunQueryRequest.Builder`	`clearConsistencySelector()`
`RunQueryRequest.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`RunQueryRequest.Builder`	`clearNewTransaction()` Starts a new transaction and reads the documents.
`RunQueryRequest.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`RunQueryRequest.Builder`	`clearParent()` The parent resource name.
`RunQueryRequest.Builder`	`clearQueryType()`
`RunQueryRequest.Builder`	`clearReadTime()` Reads documents as they were at the given time.
`RunQueryRequest.Builder`	`clearStructuredQuery()` A structured query.
`RunQueryRequest.Builder`	`clearTransaction()` Reads documents in a transaction.
`RunQueryRequest.Builder`	`clone()`
`RunQueryRequest.ConsistencySelectorCase`	`getConsistencySelectorCase()`
`RunQueryRequest`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`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.
`java.lang.String`	`getParent()` The parent resource name.
`ByteString`	`getParentBytes()` The parent resource name.
`RunQueryRequest.QueryTypeCase`	`getQueryTypeCase()`
`Timestamp`	`getReadTime()` Reads documents as they were at the given time.
`Timestamp.Builder`	`getReadTimeBuilder()` Reads documents as they were at the given time.
`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.
`ByteString`	`getTransaction()` Reads documents in a 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.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`RunQueryRequest.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`RunQueryRequest.Builder`	`mergeFrom(Message other)`
`RunQueryRequest.Builder`	`mergeFrom(RunQueryRequest other)`
`RunQueryRequest.Builder`	`mergeNewTransaction(TransactionOptions value)` Starts a new transaction and reads the documents.
`RunQueryRequest.Builder`	`mergeReadTime(Timestamp value)` Reads documents as they were at the given time.
`RunQueryRequest.Builder`	`mergeStructuredQuery(StructuredQuery value)` A structured query.
`RunQueryRequest.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`RunQueryRequest.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.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(java.lang.String value)` The parent resource name.
`RunQueryRequest.Builder`	`setParentBytes(ByteString value)` The parent resource name.
`RunQueryRequest.Builder`	`setReadTime(Timestamp.Builder builderForValue)` Reads documents as they were at the given time.
`RunQueryRequest.Builder`	`setReadTime(Timestamp value)` Reads documents as they were at the given time.
`RunQueryRequest.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`RunQueryRequest.Builder`	`setStructuredQuery(StructuredQuery.Builder builderForValue)` A structured query.
`RunQueryRequest.Builder`	`setStructuredQuery(StructuredQuery value)` A structured query.
`RunQueryRequest.Builder`	`setTransaction(ByteString value)` Reads documents in a transaction.
`RunQueryRequest.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, 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.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

clear
```
public RunQueryRequest.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

getDefaultInstanceForType
```
public RunQueryRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public RunQueryRequest build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public RunQueryRequest buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public RunQueryRequest.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

setField

public RunQueryRequest.Builder setField(Descriptors.FieldDescriptor field,
                                        java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

clearField
```
public RunQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

clearOneof
```
public RunQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

setRepeatedField

public RunQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                                int index,
                                                java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

addRepeatedField

public RunQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                java.lang.Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

mergeFrom
```
public RunQueryRequest.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<RunQueryRequest.Builder>

mergeFrom

public RunQueryRequest.Builder mergeFrom(RunQueryRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<RunQueryRequest.Builder>

mergeFrom

public RunQueryRequest.Builder mergeFrom(CodedInputStream input,
                                         ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<RunQueryRequest.Builder>
Throws:: java.io.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 java.lang.String getParent()

 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;

Specified by:: getParent in interface RunQueryRequestOrBuilder

getParentBytes

public ByteString getParentBytes()

 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;

Specified by:: getParentBytes in interface RunQueryRequestOrBuilder

setParent

public RunQueryRequest.Builder setParent(java.lang.String value)

 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;

clearParent

public RunQueryRequest.Builder clearParent()

 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;

setParentBytes

public RunQueryRequest.Builder setParentBytes(ByteString value)

 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;

hasStructuredQuery
```
public boolean hasStructuredQuery()
```
```
 A structured query.
 
```
.google.firestore.v1beta1.StructuredQuery structured_query = 2;
Specified by:

hasStructuredQuery in interface RunQueryRequestOrBuilder

getStructuredQuery
```
public StructuredQuery getStructuredQuery()
```
```
 A structured query.
 
```
.google.firestore.v1beta1.StructuredQuery structured_query = 2;
Specified by:

getStructuredQuery in interface RunQueryRequestOrBuilder

setStructuredQuery

public RunQueryRequest.Builder setStructuredQuery(StructuredQuery value)

 A structured query.

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

setStructuredQuery

public RunQueryRequest.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)

 A structured query.

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

mergeStructuredQuery

public RunQueryRequest.Builder mergeStructuredQuery(StructuredQuery value)

 A structured query.

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

clearStructuredQuery

public RunQueryRequest.Builder clearStructuredQuery()

 A structured query.

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

getStructuredQueryBuilder

public StructuredQuery.Builder getStructuredQueryBuilder()

 A structured query.

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

getStructuredQueryOrBuilder
```
public StructuredQueryOrBuilder getStructuredQueryOrBuilder()
```
```
 A structured query.
 
```
.google.firestore.v1beta1.StructuredQuery structured_query = 2;
Specified by:

getStructuredQueryOrBuilder in interface RunQueryRequestOrBuilder

getTransaction
```
public ByteString getTransaction()
```
```
 Reads documents in a transaction.
 
```
bytes transaction = 5;
Specified by:

getTransaction in interface RunQueryRequestOrBuilder

setTransaction

public RunQueryRequest.Builder setTransaction(ByteString value)

 Reads documents in a transaction.

bytes transaction = 5;

clearTransaction

public RunQueryRequest.Builder clearTransaction()

 Reads documents in a transaction.

bytes transaction = 5;