public interface ListDocumentsRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCollectionId()
public abstract String getCollectionId() Required. The collection ID, relative to parent, to list. For example: chatrooms
or messages.
string collection_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The collectionId. |
getCollectionIdBytes()
public abstract ByteString getCollectionIdBytes() Required. The collection ID, relative to parent, to list. For example: chatrooms
or messages.
string collection_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for collectionId. |
getConsistencySelectorCase()
public abstract ListDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()| Type | Description |
| ListDocumentsRequest.ConsistencySelectorCase |
getMask()
public abstract 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;
| Type | Description |
| DocumentMask | The mask. |
getMaskOrBuilder()
public abstract 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;
| Type | Description |
| DocumentMaskOrBuilder |
getOrderBy()
public abstract String getOrderBy() The order to sort results by. For example: priority desc, name.
string order_by = 6;
| Type | Description |
| String | The orderBy. |
getOrderByBytes()
public abstract ByteString getOrderByBytes() The order to sort results by. For example: priority desc, name.
string order_by = 6;
| Type | Description |
| ByteString | The bytes for orderBy. |
getPageSize()
public abstract int getPageSize()The maximum number of documents to return.
int32 page_size = 3;
| Type | Description |
| int | The pageSize. |
getPageToken()
public abstract String getPageToken() The next_page_token value returned from a previous List request, if any.
string page_token = 4;
| Type | Description |
| String | The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes() The next_page_token value returned from a previous List request, if any.
string page_token = 4;
| Type | Description |
| ByteString | The bytes for pageToken. |
getParent()
public abstract String getParent() Required. 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 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The parent. |
getParentBytes()
public abstract ByteString getParentBytes() Required. 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 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for parent. |
getReadTime()
public abstract Timestamp getReadTime()Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 10;
| Type | Description |
| Timestamp | The readTime. |
getReadTimeOrBuilder()
public abstract TimestampOrBuilder getReadTimeOrBuilder()Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 10;
| Type | Description |
| TimestampOrBuilder |
getShowMissing()
public abstract 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,
or Document.update_time set.
Requests with show_missing may not specify where or
order_by.
bool show_missing = 12;
| Type | Description |
| boolean | The showMissing. |
getTransaction()
public abstract ByteString getTransaction()Reads documents in a transaction.
bytes transaction = 8;
| Type | Description |
| ByteString | The transaction. |
hasMask()
public abstract 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;
| Type | Description |
| boolean | Whether the mask field is set. |
hasReadTime()
public abstract boolean hasReadTime()Reads documents as they were at the given time. This may not be older than 270 seconds.
.google.protobuf.Timestamp read_time = 10;
| Type | Description |
| boolean | Whether the readTime field is set. |
hasTransaction()
public abstract boolean hasTransaction()Reads documents in a transaction.
bytes transaction = 8;
| Type | Description |
| boolean | Whether the transaction field is set. |