Class ListDocumentsResponse.Builder (3.26.3)

Version 3.26.3

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class ListDocumentsResponse.Builder extends GeneratedMessageV3.Builder<ListDocumentsResponse.Builder> implements ListDocumentsResponseOrBuilder

The response for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsResponse

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListDocumentsResponse.Builder

Implements

ListDocumentsResponseOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllDocuments(Iterable<? extends Document> values)

public ListDocumentsResponse.Builder addAllDocuments(Iterable<? extends Document> values)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.firestore.v1.Document>

Returns
Type	Description
ListDocumentsResponse.Builder

addDocuments(Document value)

public ListDocumentsResponse.Builder addDocuments(Document value)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
Name	Description
value	Document

Returns
Type	Description
ListDocumentsResponse.Builder

addDocuments(Document.Builder builderForValue)

public ListDocumentsResponse.Builder addDocuments(Document.Builder builderForValue)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
Name	Description
builderForValue	Document.Builder

Returns
Type	Description
ListDocumentsResponse.Builder

addDocuments(int index, Document value)

public ListDocumentsResponse.Builder addDocuments(int index, Document value)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameters
Name	Description
index	int
value	Document

Returns
Type	Description
ListDocumentsResponse.Builder

addDocuments(int index, Document.Builder builderForValue)

public ListDocumentsResponse.Builder addDocuments(int index, Document.Builder builderForValue)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameters
Name	Description
index	int
builderForValue	Document.Builder

Returns
Type	Description
ListDocumentsResponse.Builder

addDocumentsBuilder()

public Document.Builder addDocumentsBuilder()

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Returns
Type	Description
Document.Builder

addDocumentsBuilder(int index)

public Document.Builder addDocumentsBuilder(int index)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListDocumentsResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListDocumentsResponse build()

Returns
Type	Description
ListDocumentsResponse

buildPartial()

public ListDocumentsResponse buildPartial()

Returns
Type	Description
ListDocumentsResponse

clear()

public ListDocumentsResponse.Builder clear()

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDocuments()

public ListDocumentsResponse.Builder clearDocuments()

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Returns
Type	Description
ListDocumentsResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ListDocumentsResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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
Type	Description
ListDocumentsResponse.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListDocumentsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public ListDocumentsResponse.Builder clone()

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListDocumentsResponse getDefaultInstanceForType()

Returns
Type	Description
ListDocumentsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocuments(int index)

public Document getDocuments(int index)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Document

getDocumentsBuilder(int index)

public Document.Builder getDocumentsBuilder(int index)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Builder

getDocumentsBuilderList()

public List<Document.Builder> getDocumentsBuilderList()

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Returns
Type	Description
List<Builder>

getDocumentsCount()

public int getDocumentsCount()

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Returns
Type	Description
int

getDocumentsList()

public List<Document> getDocumentsList()

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Returns
Type	Description
List<Document>

getDocumentsOrBuilder(int index)

public DocumentOrBuilder getDocumentsOrBuilder(int index)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
DocumentOrBuilder

getDocumentsOrBuilderList()

public List<? extends DocumentOrBuilder> getDocumentsOrBuilderList()

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Returns
Type	Description
List<? extends com.google.firestore.v1.DocumentOrBuilder>

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;

Returns
Type	Description
String	The nextPageToken.

getNextPageTokenBytes()

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

Returns
Type	Description
ByteString	The bytes for nextPageToken.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListDocumentsResponse other)

public ListDocumentsResponse.Builder mergeFrom(ListDocumentsResponse other)

Parameter
Name	Description
other	ListDocumentsResponse

Returns
Type	Description
ListDocumentsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDocumentsResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListDocumentsResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeDocuments(int index)

public ListDocumentsResponse.Builder removeDocuments(int index)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ListDocumentsResponse.Builder

setDocuments(int index, Document value)

public ListDocumentsResponse.Builder setDocuments(int index, Document value)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameters
Name	Description
index	int
value	Document

Returns
Type	Description
ListDocumentsResponse.Builder

setDocuments(int index, Document.Builder builderForValue)

public ListDocumentsResponse.Builder setDocuments(int index, Document.Builder builderForValue)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameters
Name	Description
index	int
builderForValue	Document.Builder

Returns
Type	Description
ListDocumentsResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ListDocumentsResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setNextPageToken(String value)

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;

Parameter
Name	Description
value	String The nextPageToken to set.

Returns
Type	Description
ListDocumentsResponse.Builder	This builder for chaining.

setNextPageTokenBytes(ByteString value)

public ListDocumentsResponse.Builder setNextPageTokenBytes(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;

Parameter
Name	Description
value	ByteString The bytes for nextPageToken to set.

Returns
Type	Description
ListDocumentsResponse.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListDocumentsResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)