ListDocumentsRequest.Builder (proto-google-cloud-firestore-v1 3.13.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>
    - - com.google.firestore.v1.ListDocumentsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ListDocumentsRequest
```
public static final class ListDocumentsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>
implements ListDocumentsRequestOrBuilder
```
```
 The request for
 [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].
 
```
Protobuf type google.firestore.v1.ListDocumentsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListDocumentsRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListDocumentsRequest`	`build()`
`ListDocumentsRequest`	`buildPartial()`
`ListDocumentsRequest.Builder`	`clear()`
`ListDocumentsRequest.Builder`	`clearCollectionId()` Optional.
`ListDocumentsRequest.Builder`	`clearConsistencySelector()`
`ListDocumentsRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListDocumentsRequest.Builder`	`clearMask()` Optional.
`ListDocumentsRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListDocumentsRequest.Builder`	`clearOrderBy()` Optional.
`ListDocumentsRequest.Builder`	`clearPageSize()` Optional.
`ListDocumentsRequest.Builder`	`clearPageToken()` Optional.
`ListDocumentsRequest.Builder`	`clearParent()` Required.
`ListDocumentsRequest.Builder`	`clearReadTime()` Perform the read at the provided time.
`ListDocumentsRequest.Builder`	`clearShowMissing()` If the list should show missing documents.
`ListDocumentsRequest.Builder`	`clearTransaction()` Perform the read as part of an already active transaction.
`ListDocumentsRequest.Builder`	`clone()`
`String`	`getCollectionId()` Optional.
`com.google.protobuf.ByteString`	`getCollectionIdBytes()` Optional.
`ListDocumentsRequest.ConsistencySelectorCase`	`getConsistencySelectorCase()`
`ListDocumentsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`DocumentMask`	`getMask()` Optional.
`DocumentMask.Builder`	`getMaskBuilder()` Optional.
`DocumentMaskOrBuilder`	`getMaskOrBuilder()` Optional.
`String`	`getOrderBy()` Optional.
`com.google.protobuf.ByteString`	`getOrderByBytes()` Optional.
`int`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` Optional.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`com.google.protobuf.Timestamp`	`getReadTime()` Perform the read at the provided time.
`com.google.protobuf.Timestamp.Builder`	`getReadTimeBuilder()` Perform the read at the provided time.
`com.google.protobuf.TimestampOrBuilder`	`getReadTimeOrBuilder()` Perform the read at the provided time.
`boolean`	`getShowMissing()` If the list should show missing documents.
`com.google.protobuf.ByteString`	`getTransaction()` Perform the read as part of an already active transaction.
`boolean`	`hasMask()` Optional.
`boolean`	`hasReadTime()` Perform the read at the provided time.
`boolean`	`hasTransaction()` Perform the read as part of an already active transaction.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListDocumentsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListDocumentsRequest.Builder`	`mergeFrom(ListDocumentsRequest other)`
`ListDocumentsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListDocumentsRequest.Builder`	`mergeMask(DocumentMask value)` Optional.
`ListDocumentsRequest.Builder`	`mergeReadTime(com.google.protobuf.Timestamp value)` Perform the read at the provided time.
`ListDocumentsRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListDocumentsRequest.Builder`	`setCollectionId(String value)` Optional.
`ListDocumentsRequest.Builder`	`setCollectionIdBytes(com.google.protobuf.ByteString value)` Optional.
`ListDocumentsRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListDocumentsRequest.Builder`	`setMask(DocumentMask.Builder builderForValue)` Optional.
`ListDocumentsRequest.Builder`	`setMask(DocumentMask value)` Optional.
`ListDocumentsRequest.Builder`	`setOrderBy(String value)` Optional.
`ListDocumentsRequest.Builder`	`setOrderByBytes(com.google.protobuf.ByteString value)` Optional.
`ListDocumentsRequest.Builder`	`setPageSize(int value)` Optional.
`ListDocumentsRequest.Builder`	`setPageToken(String value)` Optional.
`ListDocumentsRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` Optional.
`ListDocumentsRequest.Builder`	`setParent(String value)` Required.
`ListDocumentsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`ListDocumentsRequest.Builder`	`setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)` Perform the read at the provided time.
`ListDocumentsRequest.Builder`	`setReadTime(com.google.protobuf.Timestamp value)` Perform the read at the provided time.
`ListDocumentsRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ListDocumentsRequest.Builder`	`setShowMissing(boolean value)` If the list should show missing documents.
`ListDocumentsRequest.Builder`	`setTransaction(com.google.protobuf.ByteString value)` Perform the read as part of an already active transaction.
`ListDocumentsRequest.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<ListDocumentsRequest.Builder>

clear
```
public ListDocumentsRequest.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<ListDocumentsRequest.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<ListDocumentsRequest.Builder>

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

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

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

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

Specified by:

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

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

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

Specified by:

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

clone
```
public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

setField

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

clearField
```
public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

clearOneof
```
public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

setRepeatedField

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

addRepeatedField

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

mergeFrom
```
public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

mergeFrom

public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)

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

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom
```
public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

Throws:

IOException

getConsistencySelectorCase
```
public ListDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()
```
Specified by:

getConsistencySelectorCase in interface ListDocumentsRequestOrBuilder

clearConsistencySelector

public ListDocumentsRequest.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 ListDocumentsRequestOrBuilder
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 ListDocumentsRequestOrBuilder
Returns:: The bytes for parent.

setParent

public ListDocumentsRequest.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 ListDocumentsRequest.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 ListDocumentsRequest.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.

getCollectionId

public String getCollectionId()

 Optional. The collection ID, relative to `parent`, to list.
 For example: `chatrooms` or `messages`.
 This is optional, and when not provided, Firestore will list documents
 from all collections under the provided `parent`.

string collection_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getCollectionId in interface ListDocumentsRequestOrBuilder
Returns:: The collectionId.

getCollectionIdBytes

public com.google.protobuf.ByteString getCollectionIdBytes()

 Optional. The collection ID, relative to `parent`, to list.
 For example: `chatrooms` or `messages`.
 This is optional, and when not provided, Firestore will list documents
 from all collections under the provided `parent`.

string collection_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getCollectionIdBytes in interface ListDocumentsRequestOrBuilder
Returns:: The bytes for collectionId.

setCollectionId

public ListDocumentsRequest.Builder setCollectionId(String value)

 Optional. The collection ID, relative to `parent`, to list.
 For example: `chatrooms` or `messages`.
 This is optional, and when not provided, Firestore will list documents
 from all collections under the provided `parent`.

string collection_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The collectionId to set.
Returns:: This builder for chaining.

clearCollectionId

public ListDocumentsRequest.Builder clearCollectionId()

 Optional. The collection ID, relative to `parent`, to list.
 For example: `chatrooms` or `messages`.
 This is optional, and when not provided, Firestore will list documents
 from all collections under the provided `parent`.

string collection_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:: This builder for chaining.

setCollectionIdBytes

public ListDocumentsRequest.Builder setCollectionIdBytes(com.google.protobuf.ByteString value)

 Optional. The collection ID, relative to `parent`, to list.
 For example: `chatrooms` or `messages`.
 This is optional, and when not provided, Firestore will list documents
 from all collections under the provided `parent`.

string collection_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The bytes for collectionId to set.
Returns:: This builder for chaining.

getPageSize
```
public int getPageSize()
```
```
 Optional. The maximum number of documents to return in a single response.
 Firestore may return fewer than this value.
 
```
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getPageSize in interface ListDocumentsRequestOrBuilder

Returns:

The pageSize.

setPageSize

public ListDocumentsRequest.Builder setPageSize(int value)

 Optional. The maximum number of documents to return in a single response.
 Firestore may return fewer than this value.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The pageSize to set.
Returns:: This builder for chaining.

clearPageSize

public ListDocumentsRequest.Builder clearPageSize()

 Optional. The maximum number of documents to return in a single response.
 Firestore may return fewer than this value.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:: This builder for chaining.

getPageToken

public String getPageToken()

 Optional. A page token, received from a previous `ListDocuments` response.
 Provide this to retrieve the subsequent page. When paginating, all other
 parameters (with the exception of `page_size`) must match the values set
 in the request that generated the page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getPageToken in interface ListDocumentsRequestOrBuilder
Returns:: The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 Optional. A page token, received from a previous `ListDocuments` response.
 Provide this to retrieve the subsequent page. When paginating, all other
 parameters (with the exception of `page_size`) must match the values set
 in the request that generated the page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getPageTokenBytes in interface ListDocumentsRequestOrBuilder
Returns:: The bytes for pageToken.

setPageToken

public ListDocumentsRequest.Builder setPageToken(String value)

 Optional. A page token, received from a previous `ListDocuments` response.
 Provide this to retrieve the subsequent page. When paginating, all other
 parameters (with the exception of `page_size`) must match the values set
 in the request that generated the page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The pageToken to set.
Returns:: This builder for chaining.

clearPageToken

public ListDocumentsRequest.Builder clearPageToken()

 Optional. A page token, received from a previous `ListDocuments` response.
 Provide this to retrieve the subsequent page. When paginating, all other
 parameters (with the exception of `page_size`) must match the values set
 in the request that generated the page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:: This builder for chaining.

setPageTokenBytes

public ListDocumentsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 Optional. A page token, received from a previous `ListDocuments` response.
 Provide this to retrieve the subsequent page. When paginating, all other
 parameters (with the exception of `page_size`) must match the values set
 in the request that generated the page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The bytes for pageToken to set.
Returns:: This builder for chaining.

getOrderBy

public String getOrderBy()

 Optional. The optional ordering of the documents to return.
 For example: `priority desc, __name__ desc`.
 This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.order_by]
 used in Firestore queries but in a string representation. When absent,
 documents are ordered based on `__name__ ASC`.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getOrderBy in interface ListDocumentsRequestOrBuilder
Returns:: The orderBy.

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 Optional. The optional ordering of the documents to return.
 For example: `priority desc, __name__ desc`.
 This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.order_by]
 used in Firestore queries but in a string representation. When absent,
 documents are ordered based on `__name__ ASC`.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getOrderByBytes in interface ListDocumentsRequestOrBuilder
Returns:: The bytes for orderBy.

setOrderBy

public ListDocumentsRequest.Builder setOrderBy(String value)

 Optional. The optional ordering of the documents to return.
 For example: `priority desc, __name__ desc`.
 This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.order_by]
 used in Firestore queries but in a string representation. When absent,
 documents are ordered based on `__name__ ASC`.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The orderBy to set.
Returns:: This builder for chaining.

clearOrderBy

public ListDocumentsRequest.Builder clearOrderBy()

 Optional. The optional ordering of the documents to return.
 For example: `priority desc, __name__ desc`.
 This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.order_by]
 used in Firestore queries but in a string representation. When absent,
 documents are ordered based on `__name__ ASC`.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:: This builder for chaining.

setOrderByBytes

public ListDocumentsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)

 Optional. The optional ordering of the documents to return.
 For example: `priority desc, __name__ desc`.
 This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.order_by]
 used in Firestore queries but in a string representation. When absent,
 documents are ordered based on `__name__ ASC`.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The bytes for orderBy to set.
Returns:: This builder for chaining.

hasMask

public boolean hasMask()

 Optional. The fields to return. If not set, returns all fields.
 If a document has a field that is not present in this mask, that field
 will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: hasMask in interface ListDocumentsRequestOrBuilder
Returns:: Whether the mask field is set.

getMask

public DocumentMask getMask()

 Optional. The fields to return. If not set, returns all fields.
 If a document has a field that is not present in this mask, that field
 will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getMask in interface ListDocumentsRequestOrBuilder
Returns:: The mask.

setMask

public ListDocumentsRequest.Builder setMask(DocumentMask value)

 Optional. The fields to return. If not set, returns all fields.
 If a document has a field that is not present in this mask, that field
 will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 7 [(.google.api.field_behavior) = OPTIONAL];

setMask

public ListDocumentsRequest.Builder setMask(DocumentMask.Builder builderForValue)

 Optional. The fields to return. If not set, returns all fields.
 If a document has a field that is not present in this mask, that field
 will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 7 [(.google.api.field_behavior) = OPTIONAL];

mergeMask

public ListDocumentsRequest.Builder mergeMask(DocumentMask value)

 Optional. The fields to return. If not set, returns all fields.
 If a document has a field that is not present in this mask, that field
 will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 7 [(.google.api.field_behavior) = OPTIONAL];

clearMask

public ListDocumentsRequest.Builder clearMask()

 Optional. The fields to return. If not set, returns all fields.
 If a document has a field that is not present in this mask, that field
 will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 7 [(.google.api.field_behavior) = OPTIONAL];

getMaskBuilder

public DocumentMask.Builder getMaskBuilder()

 Optional. The fields to return. If not set, returns all fields.
 If a document has a field that is not present in this mask, that field
 will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 7 [(.google.api.field_behavior) = OPTIONAL];

getMaskOrBuilder

public DocumentMaskOrBuilder getMaskOrBuilder()

 Optional. The fields to return. If not set, returns all fields.
 If a document has a field that is not present in this mask, that field
 will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getMaskOrBuilder in interface ListDocumentsRequestOrBuilder

hasTransaction
```
public boolean hasTransaction()
```
```
 Perform the read as part of an already active transaction.
 
```
bytes transaction = 8;
Specified by:

hasTransaction in interface ListDocumentsRequestOrBuilder

Returns:

Whether the transaction field is set.

getTransaction
```
public com.google.protobuf.ByteString getTransaction()
```
```
 Perform the read as part of an already active transaction.
 
```
bytes transaction = 8;
Specified by:

getTransaction in interface ListDocumentsRequestOrBuilder

Returns:

The transaction.

setTransaction

public ListDocumentsRequest.Builder setTransaction(com.google.protobuf.ByteString value)

 Perform the read as part of an already active transaction.

bytes transaction = 8;

Parameters:: value - The transaction to set.
Returns:: This builder for chaining.

clearTransaction

public ListDocumentsRequest.Builder clearTransaction()

 Perform the read as part of an already active transaction.

bytes transaction = 8;

Returns:: This builder for chaining.

hasReadTime
```
public boolean hasReadTime()
```
```
 Perform the read at the provided time.
 This may not be older than 270 seconds.
 
```
.google.protobuf.Timestamp read_time = 10;
Specified by:

hasReadTime in interface ListDocumentsRequestOrBuilder

Returns:

Whether the readTime field is set.

getReadTime
```
public com.google.protobuf.Timestamp getReadTime()
```
```
 Perform the read at the provided time.
 This may not be older than 270 seconds.
 
```
.google.protobuf.Timestamp read_time = 10;
Specified by:

getReadTime in interface ListDocumentsRequestOrBuilder

Returns:

The readTime.