public static final class ListDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder> implements ListDocumentsRequestOrBuilder
The request for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].Protobuf type
google.firestore.v1.ListDocumentsRequest| Modifier and Type | Method and Description |
|---|---|
ListDocumentsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
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(com.google.protobuf.Descriptors.FieldDescriptor field) |
ListDocumentsRequest.Builder |
clearMask()
The fields to return.
|
ListDocumentsRequest.Builder |
clearOneof(com.google.protobuf.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() |
String |
getCollectionId()
The collection ID, relative to `parent`, to list.
|
com.google.protobuf.ByteString |
getCollectionIdBytes()
The collection ID, relative to `parent`, to list.
|
ListDocumentsRequest.ConsistencySelectorCase |
getConsistencySelectorCase() |
ListDocumentsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
DocumentMask |
getMask()
The fields to return.
|
DocumentMask.Builder |
getMaskBuilder()
The fields to return.
|
DocumentMaskOrBuilder |
getMaskOrBuilder()
The fields to return.
|
String |
getOrderBy()
The order to sort results by.
|
com.google.protobuf.ByteString |
getOrderByBytes()
The order to sort results by.
|
int |
getPageSize()
The maximum number of documents to return.
|
String |
getPageToken()
The `next_page_token` value returned from a previous List request, if any.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
The `next_page_token` value returned from a previous List request, if any.
|
String |
getParent()
The parent resource name.
|
com.google.protobuf.ByteString |
getParentBytes()
The parent resource name.
|
com.google.protobuf.Timestamp |
getReadTime()
Reads documents as they were at the given time.
|
com.google.protobuf.Timestamp.Builder |
getReadTimeBuilder()
Reads documents as they were at the given time.
|
com.google.protobuf.TimestampOrBuilder |
getReadTimeOrBuilder()
Reads documents as they were at the given time.
|
boolean |
getShowMissing()
If the list should show missing documents.
|
com.google.protobuf.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 com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ListDocumentsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ListDocumentsRequest.Builder |
mergeFrom(ListDocumentsRequest other) |
ListDocumentsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ListDocumentsRequest.Builder |
mergeMask(DocumentMask value)
The fields to return.
|
ListDocumentsRequest.Builder |
mergeReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time.
|
ListDocumentsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ListDocumentsRequest.Builder |
setCollectionId(String value)
The collection ID, relative to `parent`, to list.
|
ListDocumentsRequest.Builder |
setCollectionIdBytes(com.google.protobuf.ByteString value)
The collection ID, relative to `parent`, to list.
|
ListDocumentsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListDocumentsRequest.Builder |
setMask(DocumentMask.Builder builderForValue)
The fields to return.
|
ListDocumentsRequest.Builder |
setMask(DocumentMask value)
The fields to return.
|
ListDocumentsRequest.Builder |
setOrderBy(String value)
The order to sort results by.
|
ListDocumentsRequest.Builder |
setOrderByBytes(com.google.protobuf.ByteString value)
The order to sort results by.
|
ListDocumentsRequest.Builder |
setPageSize(int value)
The maximum number of documents to return.
|
ListDocumentsRequest.Builder |
setPageToken(String value)
The `next_page_token` value returned from a previous List request, if any.
|
ListDocumentsRequest.Builder |
setPageTokenBytes(com.google.protobuf.ByteString value)
The `next_page_token` value returned from a previous List request, if any.
|
ListDocumentsRequest.Builder |
setParent(String value)
The parent resource name.
|
ListDocumentsRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
The parent resource name.
|
ListDocumentsRequest.Builder |
setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
Reads documents as they were at the given time.
|
ListDocumentsRequest.Builder |
setReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time.
|
ListDocumentsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ListDocumentsRequest.Builder |
setShowMissing(boolean value)
If the list should show missing documents.
|
ListDocumentsRequest.Builder |
setTransaction(com.google.protobuf.ByteString value)
Reads documents in a transaction.
|
ListDocumentsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ListDocumentsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ListDocumentsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ListDocumentsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDocumentsRequest.Builder>IOExceptionpublic ListDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()
getConsistencySelectorCase in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder clearConsistencySelector()
public 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;getParent in interface ListDocumentsRequestOrBuilderpublic com.google.protobuf.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;getParentBytes in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder setParent(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;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;public ListDocumentsRequest.Builder setParentBytes(com.google.protobuf.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;public String getCollectionId()
The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
string collection_id = 2;getCollectionId in interface ListDocumentsRequestOrBuilderpublic com.google.protobuf.ByteString getCollectionIdBytes()
The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
string collection_id = 2;getCollectionIdBytes in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder setCollectionId(String value)
The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
string collection_id = 2;public ListDocumentsRequest.Builder clearCollectionId()
The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
string collection_id = 2;public ListDocumentsRequest.Builder setCollectionIdBytes(com.google.protobuf.ByteString value)
The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
string collection_id = 2;public int getPageSize()
The maximum number of documents to return.
int32 page_size = 3;getPageSize in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder setPageSize(int value)
The maximum number of documents to return.
int32 page_size = 3;public ListDocumentsRequest.Builder clearPageSize()
The maximum number of documents to return.
int32 page_size = 3;public String getPageToken()
The `next_page_token` value returned from a previous List request, if any.
string page_token = 4;getPageToken in interface ListDocumentsRequestOrBuilderpublic com.google.protobuf.ByteString getPageTokenBytes()
The `next_page_token` value returned from a previous List request, if any.
string page_token = 4;getPageTokenBytes in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder setPageToken(String value)
The `next_page_token` value returned from a previous List request, if any.
string page_token = 4;public ListDocumentsRequest.Builder clearPageToken()
The `next_page_token` value returned from a previous List request, if any.
string page_token = 4;public ListDocumentsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
The `next_page_token` value returned from a previous List request, if any.
string page_token = 4;public String getOrderBy()
The order to sort results by. For example: `priority desc, name`.
string order_by = 6;getOrderBy in interface ListDocumentsRequestOrBuilderpublic com.google.protobuf.ByteString getOrderByBytes()
The order to sort results by. For example: `priority desc, name`.
string order_by = 6;getOrderByBytes in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder setOrderBy(String value)
The order to sort results by. For example: `priority desc, name`.
string order_by = 6;public ListDocumentsRequest.Builder clearOrderBy()
The order to sort results by. For example: `priority desc, name`.
string order_by = 6;public ListDocumentsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
The order to sort results by. For example: `priority desc, name`.
string order_by = 6;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.v1.DocumentMask mask = 7;hasMask in interface ListDocumentsRequestOrBuilderpublic 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.v1.DocumentMask mask = 7;getMask in interface ListDocumentsRequestOrBuilderpublic 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.v1.DocumentMask mask = 7;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.v1.DocumentMask mask = 7;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.v1.DocumentMask mask = 7;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.v1.DocumentMask mask = 7;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.v1.DocumentMask mask = 7;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.v1.DocumentMask mask = 7;getMaskOrBuilder in interface ListDocumentsRequestOrBuilderpublic com.google.protobuf.ByteString getTransaction()
Reads documents in a transaction.
bytes transaction = 8;getTransaction in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder setTransaction(com.google.protobuf.ByteString value)
Reads documents in a transaction.
bytes transaction = 8;public ListDocumentsRequest.Builder clearTransaction()
Reads documents in a transaction.
bytes transaction = 8;public boolean hasReadTime()
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 10;hasReadTime in interface ListDocumentsRequestOrBuilderpublic com.google.protobuf.Timestamp getReadTime()
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 10;getReadTime in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder setReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 10;public ListDocumentsRequest.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 10;public ListDocumentsRequest.Builder mergeReadTime(com.google.protobuf.Timestamp value)
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 10;public ListDocumentsRequest.Builder clearReadTime()
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 10;public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 10;public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
Reads documents as they were at the given time. This may not be older than 60 seconds.
.google.protobuf.Timestamp read_time = 10;getReadTimeOrBuilder in interface ListDocumentsRequestOrBuilderpublic boolean getShowMissing()
If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, [Document.create_time][google.firestore.v1.Document.create_time], or [Document.update_time][google.firestore.v1.Document.update_time] set. Requests with `show_missing` may not specify `where` or `order_by`.
bool show_missing = 12;getShowMissing in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder setShowMissing(boolean value)
If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, [Document.create_time][google.firestore.v1.Document.create_time], or [Document.update_time][google.firestore.v1.Document.update_time] set. Requests with `show_missing` may not specify `where` or `order_by`.
bool show_missing = 12;public ListDocumentsRequest.Builder clearShowMissing()
If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, [Document.create_time][google.firestore.v1.Document.create_time], or [Document.update_time][google.firestore.v1.Document.update_time] set. Requests with `show_missing` may not specify `where` or `order_by`.
bool show_missing = 12;public final ListDocumentsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public final ListDocumentsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>Copyright © 2019 Google LLC. All rights reserved.