ListDocumentsRequest.Builder (java API)

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

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

Enclosing class:: ListDocumentsRequest

public static final class ListDocumentsRequest.Builder
extends GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>
implements ListDocumentsRequestOrBuilder

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

Protobuf type google.firestore.v1beta1.ListDocumentsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListDocumentsRequest.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`ListDocumentsRequest`	`build()`
`ListDocumentsRequest`	`buildPartial()`
`ListDocumentsRequest.Builder`	`clear()`
`ListDocumentsRequest.Builder`	`clearCollectionId()` The collection ID, relative to `parent`, to list.
`ListDocumentsRequest.Builder`	`clearConsistencySelector()`
`ListDocumentsRequest.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`ListDocumentsRequest.Builder`	`clearMask()` The fields to return.
`ListDocumentsRequest.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`ListDocumentsRequest.Builder`	`clearOrderBy()` The order to sort results by.
`ListDocumentsRequest.Builder`	`clearPageSize()` The maximum number of documents to return.
`ListDocumentsRequest.Builder`	`clearPageToken()` The `next_page_token` value returned from a previous List request, if any.
`ListDocumentsRequest.Builder`	`clearParent()` The parent resource name.
`ListDocumentsRequest.Builder`	`clearReadTime()` Reads documents as they were at the given time.
`ListDocumentsRequest.Builder`	`clearShowMissing()` If the list should show missing documents.
`ListDocumentsRequest.Builder`	`clearTransaction()` Reads documents in a transaction.
`ListDocumentsRequest.Builder`	`clone()`
`java.lang.String`	`getCollectionId()` The collection ID, relative to `parent`, to list.
`ByteString`	`getCollectionIdBytes()` The collection ID, relative to `parent`, to list.
`ListDocumentsRequest.ConsistencySelectorCase`	`getConsistencySelectorCase()`
`ListDocumentsRequest`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`DocumentMask`	`getMask()` The fields to return.
`DocumentMask.Builder`	`getMaskBuilder()` The fields to return.
`DocumentMaskOrBuilder`	`getMaskOrBuilder()` The fields to return.
`java.lang.String`	`getOrderBy()` The order to sort results by.
`ByteString`	`getOrderByBytes()` The order to sort results by.
`int`	`getPageSize()` The maximum number of documents to return.
`java.lang.String`	`getPageToken()` The `next_page_token` value returned from a previous List request, if any.
`ByteString`	`getPageTokenBytes()` The `next_page_token` value returned from a previous List request, if any.
`java.lang.String`	`getParent()` The parent resource name.
`ByteString`	`getParentBytes()` The parent resource name.
`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.
`boolean`	`getShowMissing()` If the list should show missing documents.
`ByteString`	`getTransaction()` Reads documents in a transaction.
`boolean`	`hasMask()` The fields to return.
`boolean`	`hasReadTime()` Reads documents as they were at the given time.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListDocumentsRequest.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`ListDocumentsRequest.Builder`	`mergeFrom(ListDocumentsRequest other)`
`ListDocumentsRequest.Builder`	`mergeFrom(Message other)`
`ListDocumentsRequest.Builder`	`mergeMask(DocumentMask value)` The fields to return.
`ListDocumentsRequest.Builder`	`mergeReadTime(Timestamp value)` Reads documents as they were at the given time.
`ListDocumentsRequest.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`ListDocumentsRequest.Builder`	`setCollectionId(java.lang.String value)` The collection ID, relative to `parent`, to list.
`ListDocumentsRequest.Builder`	`setCollectionIdBytes(ByteString value)` The collection ID, relative to `parent`, to list.
`ListDocumentsRequest.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`ListDocumentsRequest.Builder`	`setMask(DocumentMask.Builder builderForValue)` The fields to return.
`ListDocumentsRequest.Builder`	`setMask(DocumentMask value)` The fields to return.
`ListDocumentsRequest.Builder`	`setOrderBy(java.lang.String value)` The order to sort results by.
`ListDocumentsRequest.Builder`	`setOrderByBytes(ByteString value)` The order to sort results by.
`ListDocumentsRequest.Builder`	`setPageSize(int value)` The maximum number of documents to return.
`ListDocumentsRequest.Builder`	`setPageToken(java.lang.String value)` The `next_page_token` value returned from a previous List request, if any.
`ListDocumentsRequest.Builder`	`setPageTokenBytes(ByteString value)` The `next_page_token` value returned from a previous List request, if any.
`ListDocumentsRequest.Builder`	`setParent(java.lang.String value)` The parent resource name.
`ListDocumentsRequest.Builder`	`setParentBytes(ByteString value)` The parent resource name.
`ListDocumentsRequest.Builder`	`setReadTime(Timestamp.Builder builderForValue)` Reads documents as they were at the given time.
`ListDocumentsRequest.Builder`	`setReadTime(Timestamp value)` Reads documents as they were at the given time.
`ListDocumentsRequest.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`ListDocumentsRequest.Builder`	`setShowMissing(boolean value)` If the list should show missing documents.
`ListDocumentsRequest.Builder`	`setTransaction(ByteString value)` Reads documents in a transaction.
`ListDocumentsRequest.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<ListDocumentsRequest.Builder>

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

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<ListDocumentsRequest.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<ListDocumentsRequest.Builder>

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

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

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

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

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

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

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

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

setField

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

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

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

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

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

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

setRepeatedField

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

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

addRepeatedField

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

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

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

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ListDocumentsRequest.Builder>

mergeFrom

public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)

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

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

mergeFrom

public ListDocumentsRequest.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<ListDocumentsRequest.Builder>
Throws:: java.io.IOException

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

getConsistencySelectorCase in interface ListDocumentsRequestOrBuilder

clearConsistencySelector

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

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 ListDocumentsRequestOrBuilder

setParent

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

getCollectionId

public java.lang.String getCollectionId()

 The collection ID, relative to `parent`, to list. For example: `chatrooms`
 or `messages`.

string collection_id = 2;

Specified by:: getCollectionId in interface ListDocumentsRequestOrBuilder

getCollectionIdBytes

public ByteString getCollectionIdBytes()

 The collection ID, relative to `parent`, to list. For example: `chatrooms`
 or `messages`.

string collection_id = 2;

Specified by:: getCollectionIdBytes in interface ListDocumentsRequestOrBuilder

setCollectionId

public ListDocumentsRequest.Builder setCollectionId(java.lang.String value)

 The collection ID, relative to `parent`, to list. For example: `chatrooms`
 or `messages`.

string collection_id = 2;

clearCollectionId

public ListDocumentsRequest.Builder clearCollectionId()

 The collection ID, relative to `parent`, to list. For example: `chatrooms`
 or `messages`.

string collection_id = 2;

setCollectionIdBytes

public ListDocumentsRequest.Builder setCollectionIdBytes(ByteString value)

 The collection ID, relative to `parent`, to list. For example: `chatrooms`
 or `messages`.

string collection_id = 2;

getPageSize
```
public int getPageSize()
```
```
 The maximum number of documents to return.
 
```
int32 page_size = 3;
Specified by:

getPageSize in interface ListDocumentsRequestOrBuilder

setPageSize

public ListDocumentsRequest.Builder setPageSize(int value)

 The maximum number of documents to return.

int32 page_size = 3;

clearPageSize

public ListDocumentsRequest.Builder clearPageSize()

 The maximum number of documents to return.

int32 page_size = 3;

getPageToken

public java.lang.String getPageToken()

 The `next_page_token` value returned from a previous List request, if any.

string page_token = 4;

Specified by:: getPageToken in interface ListDocumentsRequestOrBuilder

getPageTokenBytes

public ByteString getPageTokenBytes()

 The `next_page_token` value returned from a previous List request, if any.

string page_token = 4;

Specified by:: getPageTokenBytes in interface ListDocumentsRequestOrBuilder

setPageToken

public ListDocumentsRequest.Builder setPageToken(java.lang.String value)

 The `next_page_token` value returned from a previous List request, if any.

string page_token = 4;

clearPageToken

public ListDocumentsRequest.Builder clearPageToken()

 The `next_page_token` value returned from a previous List request, if any.

string page_token = 4;

setPageTokenBytes

public ListDocumentsRequest.Builder setPageTokenBytes(ByteString value)

 The `next_page_token` value returned from a previous List request, if any.

string page_token = 4;

getOrderBy

public java.lang.String getOrderBy()

 The order to sort results by. For example: `priority desc, name`.

string order_by = 6;

Specified by:: getOrderBy in interface ListDocumentsRequestOrBuilder

getOrderByBytes

public ByteString getOrderByBytes()

 The order to sort results by. For example: `priority desc, name`.

string order_by = 6;

Specified by:: getOrderByBytes in interface ListDocumentsRequestOrBuilder

setOrderBy

public ListDocumentsRequest.Builder setOrderBy(java.lang.String value)

 The order to sort results by. For example: `priority desc, name`.

string order_by = 6;

clearOrderBy

public ListDocumentsRequest.Builder clearOrderBy()

 The order to sort results by. For example: `priority desc, name`.

string order_by = 6;

setOrderByBytes

public ListDocumentsRequest.Builder setOrderByBytes(ByteString value)

 The order to sort results by. For example: `priority desc, name`.

string order_by = 6;

hasMask

public boolean hasMask()

 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.v1beta1.DocumentMask mask = 7;

Specified by:: hasMask in interface ListDocumentsRequestOrBuilder

getMask

public DocumentMask getMask()

 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.v1beta1.DocumentMask mask = 7;

Specified by:: getMask in interface ListDocumentsRequestOrBuilder

setMask

public ListDocumentsRequest.Builder setMask(DocumentMask value)

 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.v1beta1.DocumentMask mask = 7;

setMask

public ListDocumentsRequest.Builder setMask(DocumentMask.Builder builderForValue)

 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.v1beta1.DocumentMask mask = 7;

mergeMask

public ListDocumentsRequest.Builder mergeMask(DocumentMask value)

 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.v1beta1.DocumentMask mask = 7;

clearMask

public ListDocumentsRequest.Builder clearMask()

 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.v1beta1.DocumentMask mask = 7;

getMaskBuilder

public DocumentMask.Builder getMaskBuilder()

 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.v1beta1.DocumentMask mask = 7;

getMaskOrBuilder

public DocumentMaskOrBuilder getMaskOrBuilder()

 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.v1beta1.DocumentMask mask = 7;

Specified by:: getMaskOrBuilder in interface ListDocumentsRequestOrBuilder

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

getTransaction in interface ListDocumentsRequestOrBuilder

setTransaction

public ListDocumentsRequest.Builder setTransaction(ByteString value)

 Reads documents in a transaction.

bytes transaction = 8;

clearTransaction

public ListDocumentsRequest.Builder clearTransaction()

 Reads documents in a transaction.

bytes transaction = 8;