Class ListDocumentsResponse.Builder (3.13.2)

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

The response for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.firestore.v1.Document>
Returns
TypeDescription
ListDocumentsResponse.Builder

addDocuments(Document value)

public ListDocumentsResponse.Builder addDocuments(Document value)

The Documents found.

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
ListDocumentsResponse.Builder

addDocuments(Document.Builder builderForValue)

public ListDocumentsResponse.Builder addDocuments(Document.Builder builderForValue)

The Documents found.

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

Parameter
NameDescription
builderForValueDocument.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueDocument
Returns
TypeDescription
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
NameDescription
indexint
builderForValueDocument.Builder
Returns
TypeDescription
ListDocumentsResponse.Builder

addDocumentsBuilder()

public Document.Builder addDocumentsBuilder()

The Documents found.

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

Returns
TypeDescription
Document.Builder

addDocumentsBuilder(int index)

public Document.Builder addDocumentsBuilder(int index)

The Documents found.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListDocumentsResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

build()

public ListDocumentsResponse build()
Returns
TypeDescription
ListDocumentsResponse

buildPartial()

public ListDocumentsResponse buildPartial()
Returns
TypeDescription
ListDocumentsResponse

clear()

public ListDocumentsResponse.Builder clear()
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

clearDocuments()

public ListDocumentsResponse.Builder clearDocuments()

The Documents found.

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

Returns
TypeDescription
ListDocumentsResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ListDocumentsResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

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
TypeDescription
ListDocumentsResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListDocumentsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

clone()

public ListDocumentsResponse.Builder clone()
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

getDefaultInstanceForType()

public ListDocumentsResponse getDefaultInstanceForType()
Returns
TypeDescription
ListDocumentsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocuments(int index)

public Document getDocuments(int index)

The Documents found.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Document

getDocumentsBuilder(int index)

public Document.Builder getDocumentsBuilder(int index)

The Documents found.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Builder

getDocumentsBuilderList()

public List<Document.Builder> getDocumentsBuilderList()

The Documents found.

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

Returns
TypeDescription
List<Builder>

getDocumentsCount()

public int getDocumentsCount()

The Documents found.

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

Returns
TypeDescription
int

getDocumentsList()

public List<Document> getDocumentsList()

The Documents found.

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

Returns
TypeDescription
List<Document>

getDocumentsOrBuilder(int index)

public DocumentOrBuilder getDocumentsOrBuilder(int index)

The Documents found.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DocumentOrBuilder

getDocumentsOrBuilderList()

public List<? extends DocumentOrBuilder> getDocumentsOrBuilderList()

The Documents found.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for nextPageToken.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListDocumentsResponse other)

public ListDocumentsResponse.Builder mergeFrom(ListDocumentsResponse other)
Parameter
NameDescription
otherListDocumentsResponse
Returns
TypeDescription
ListDocumentsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDocumentsResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListDocumentsResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

removeDocuments(int index)

public ListDocumentsResponse.Builder removeDocuments(int index)

The Documents found.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
valueDocument
Returns
TypeDescription
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
NameDescription
indexint
builderForValueDocument.Builder
Returns
TypeDescription
ListDocumentsResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ListDocumentsResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

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
NameDescription
valueString

The nextPageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for nextPageToken to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides