ListDocumentsResponse.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<ListDocumentsResponse.Builder>
    - - com.google.firestore.v1.ListDocumentsResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListDocumentsResponse.Builder`	`addAllDocuments(Iterable<? extends Document> values)` The Documents found.
`ListDocumentsResponse.Builder`	`addDocuments(Document.Builder builderForValue)` The Documents found.
`ListDocumentsResponse.Builder`	`addDocuments(Document value)` The Documents found.
`ListDocumentsResponse.Builder`	`addDocuments(int index, Document.Builder builderForValue)` The Documents found.
`ListDocumentsResponse.Builder`	`addDocuments(int index, Document value)` The Documents found.
`Document.Builder`	`addDocumentsBuilder()` The Documents found.
`Document.Builder`	`addDocumentsBuilder(int index)` The Documents found.
`ListDocumentsResponse.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListDocumentsResponse`	`build()`
`ListDocumentsResponse`	`buildPartial()`
`ListDocumentsResponse.Builder`	`clear()`
`ListDocumentsResponse.Builder`	`clearDocuments()` The Documents found.
`ListDocumentsResponse.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListDocumentsResponse.Builder`	`clearNextPageToken()` A token to retrieve the next page of documents.
`ListDocumentsResponse.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListDocumentsResponse.Builder`	`clone()`
`ListDocumentsResponse`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`Document`	`getDocuments(int index)` The Documents found.
`Document.Builder`	`getDocumentsBuilder(int index)` The Documents found.
`List<Document.Builder>`	`getDocumentsBuilderList()` The Documents found.
`int`	`getDocumentsCount()` The Documents found.
`List<Document>`	`getDocumentsList()` The Documents found.
`DocumentOrBuilder`	`getDocumentsOrBuilder(int index)` The Documents found.
`List<? extends DocumentOrBuilder>`	`getDocumentsOrBuilderList()` The Documents found.
`String`	`getNextPageToken()` A token to retrieve the next page of documents.
`com.google.protobuf.ByteString`	`getNextPageTokenBytes()` A token to retrieve the next page of documents.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListDocumentsResponse.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListDocumentsResponse.Builder`	`mergeFrom(ListDocumentsResponse other)`
`ListDocumentsResponse.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListDocumentsResponse.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListDocumentsResponse.Builder`	`removeDocuments(int index)` The Documents found.
`ListDocumentsResponse.Builder`	`setDocuments(int index, Document.Builder builderForValue)` The Documents found.
`ListDocumentsResponse.Builder`	`setDocuments(int index, Document value)` The Documents found.
`ListDocumentsResponse.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListDocumentsResponse.Builder`	`setNextPageToken(String value)` A token to retrieve the next page of documents.
`ListDocumentsResponse.Builder`	`setNextPageTokenBytes(com.google.protobuf.ByteString value)` A token to retrieve the next page of documents.
`ListDocumentsResponse.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - clear
```
public ListDocumentsResponse.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<ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - getDefaultInstanceForType
```
public ListDocumentsResponse getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public ListDocumentsResponse build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public ListDocumentsResponse buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - setField
```
public ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - clearField
```
public ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - clearOneof
```
public ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - setRepeatedField
```
public ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - addRepeatedField
```
public ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - mergeFrom
```
public ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - mergeFrom
```
public ListDocumentsResponse.Builder mergeFrom(ListDocumentsResponse other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsResponse.Builder>
  - mergeFrom
```
public ListDocumentsResponse.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<ListDocumentsResponse.Builder>
    
    Throws:
    
    IOException
  - getDocumentsList
```
public List<Document> getDocumentsList()
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
    Specified by:
    
    getDocumentsList in interface ListDocumentsResponseOrBuilder
  - getDocumentsCount
```
public int getDocumentsCount()
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
    Specified by:
    
    getDocumentsCount in interface ListDocumentsResponseOrBuilder
  - getDocuments
```
public Document getDocuments(int index)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
    Specified by:
    
    getDocuments in interface ListDocumentsResponseOrBuilder
  - setDocuments
```
public ListDocumentsResponse.Builder setDocuments(int index,
                                                  Document value)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - setDocuments
```
public ListDocumentsResponse.Builder setDocuments(int index,
                                                  Document.Builder builderForValue)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - addDocuments
```
public ListDocumentsResponse.Builder addDocuments(Document value)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - addDocuments
```
public ListDocumentsResponse.Builder addDocuments(int index,
                                                  Document value)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - addDocuments
```
public ListDocumentsResponse.Builder addDocuments(Document.Builder builderForValue)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - addDocuments
```
public ListDocumentsResponse.Builder addDocuments(int index,
                                                  Document.Builder builderForValue)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - addAllDocuments
```
public ListDocumentsResponse.Builder addAllDocuments(Iterable<? extends Document> values)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - clearDocuments
```
public ListDocumentsResponse.Builder clearDocuments()
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - removeDocuments
```
public ListDocumentsResponse.Builder removeDocuments(int index)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - getDocumentsBuilder
```
public Document.Builder getDocumentsBuilder(int index)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - getDocumentsOrBuilder
```
public DocumentOrBuilder getDocumentsOrBuilder(int index)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
    Specified by:
    
    getDocumentsOrBuilder in interface ListDocumentsResponseOrBuilder
  - getDocumentsOrBuilderList
```
public List<? extends DocumentOrBuilder> getDocumentsOrBuilderList()
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
    Specified by:
    
    getDocumentsOrBuilderList in interface ListDocumentsResponseOrBuilder
  - addDocumentsBuilder
```
public Document.Builder addDocumentsBuilder()
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - addDocumentsBuilder
```
public Document.Builder addDocumentsBuilder(int index)
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - getDocumentsBuilderList
```
public List<Document.Builder> getDocumentsBuilderList()
```
```
 The Documents found.
 
```
    repeated .google.firestore.v1.Document documents = 1;
  - getNextPageToken
```
public String getNextPageToken()
```
```
 A token to retrieve the next page of documents.
 If this field is omitted, there are no subsequent pages.
 
```
    string next_page_token = 2;
    Specified by:
    
    getNextPageToken in interface ListDocumentsResponseOrBuilder
    
    Returns:
    
    The nextPageToken.
  - getNextPageTokenBytes
```
public com.google.protobuf.ByteString getNextPageTokenBytes()
```
```
 A token to retrieve the next page of documents.
 If this field is omitted, there are no subsequent pages.
 
```
    string next_page_token = 2;
    Specified by:
    
    getNextPageTokenBytes in interface ListDocumentsResponseOrBuilder
    
    Returns:
    
    The bytes for nextPageToken.
  - setNextPageToken
```
public ListDocumentsResponse.Builder setNextPageToken(String value)
```
```
 A token to retrieve the next page of documents.
 If this field is omitted, there are no subsequent pages.
 
```
    string next_page_token = 2;
    Parameters:
    
    value - The nextPageToken to set.
    
    Returns:
    
    This builder for chaining.
  - clearNextPageToken
```
public ListDocumentsResponse.Builder clearNextPageToken()
```
```
 A token to retrieve the next page of documents.
 If this field is omitted, there are no subsequent pages.
 
```
    string next_page_token = 2;
    Returns:
    
    This builder for chaining.
  - setNextPageTokenBytes
```
public ListDocumentsResponse.Builder setNextPageTokenBytes(com.google.protobuf.ByteString value)
```
```
 A token to retrieve the next page of documents.
 If this field is omitted, there are no subsequent pages.
 
```
    string next_page_token = 2;
    Parameters:
    
    value - The bytes for nextPageToken to set.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final ListDocumentsResponse.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<ListDocumentsResponse.Builder>
  - mergeUnknownFields
```
public final ListDocumentsResponse.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<ListDocumentsResponse.Builder>

Class ListDocumentsResponse.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getDocumentsList

getDocumentsCount

getDocuments

setDocuments

setDocuments

addDocuments

addDocuments

addDocuments

addDocuments

addAllDocuments

clearDocuments

removeDocuments

getDocumentsBuilder

getDocumentsOrBuilder

getDocumentsOrBuilderList

addDocumentsBuilder

addDocumentsBuilder

getDocumentsBuilderList

getNextPageToken

getNextPageTokenBytes

setNextPageToken

clearNextPageToken

setNextPageTokenBytes

setUnknownFields

mergeUnknownFields