public static final class ListDocumentsResponse.Builder extends GeneratedMessage.Builder<ListDocumentsResponse.Builder> implements ListDocumentsResponseOrBuilderThe response for Firestore.ListDocuments.
Protobuf type google.firestore.v1.ListDocumentsResponse
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListDocumentsResponse.BuilderImplements
ListDocumentsResponseOrBuilderStatic 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 |
|
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 |
|
clearDocuments()
public ListDocumentsResponse.Builder clearDocuments()The Documents found.
repeated .google.firestore.v1.Document documents = 1;
| Returns | |
|---|---|
| Type | Description |
ListDocumentsResponse.Builder |
|
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. |
getDefaultInstanceForType()
public ListDocumentsResponse getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListDocumentsResponse |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListDocumentsResponse.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListDocumentsResponse.Builder |
|
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 |
|
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 |
StringThe 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 |
ByteStringThe bytes for nextPageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListDocumentsResponse.Builder |
This builder for chaining. |