Interface ListDocumentsRequestOrBuilder (3.20.0)

public interface ListDocumentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCollectionId()

public abstract String getCollectionId()

Optional. The collection ID, relative to parent, to list.

For example: chatrooms or messages.

This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.

string collection_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The collectionId.

getCollectionIdBytes()

public abstract ByteString getCollectionIdBytes()

Optional. The collection ID, relative to parent, to list.

For example: chatrooms or messages.

This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.

string collection_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for collectionId.

getConsistencySelectorCase()

public abstract ListDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()

Returns
Type	Description
`ListDocumentsRequest.ConsistencySelectorCase`

getMask()

public abstract DocumentMask getMask()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DocumentMask`	The mask.

getMaskOrBuilder()

public abstract DocumentMaskOrBuilder getMaskOrBuilder()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DocumentMaskOrBuilder`

getOrderBy()

public abstract String getOrderBy()

Optional. The optional ordering of the documents to return.

For example: priority desc, name desc.

This mirrors the ORDER BY used in Firestore queries but in a string representation. When absent, documents are ordered based on name ASC.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

Optional. The optional ordering of the documents to return.

For example: priority desc, name desc.

This mirrors the ORDER BY used in Firestore queries but in a string representation. When absent, documents are ordered based on name ASC.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of documents to return in a single response.

Firestore may return fewer than this value.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. A page token, received from a previous ListDocuments response.

Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of page_size) must match the values set in the request that generated the page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. A page token, received from a previous ListDocuments response.

Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of page_size) must match the values set in the request that generated the page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
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];

Returns
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];

Returns
Type	Description
`ByteString`	The bytes for parent.

getReadTime()

public abstract Timestamp getReadTime()

Perform the read at the provided time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 10;

Returns
Type	Description
`Timestamp`	The readTime.

getReadTimeOrBuilder()

public abstract TimestampOrBuilder getReadTimeOrBuilder()

Perform the read at the provided time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 10;

Returns
Type	Description
`TimestampOrBuilder`

getShowMissing()

public abstract boolean getShowMissing()

If the list should show missing documents.

A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, create_time, or update_time set.

Requests with show_missing may not specify where or order_by.

bool show_missing = 12;

Returns
Type	Description
`boolean`	The showMissing.

getTransaction()

public abstract ByteString getTransaction()

Perform the read as part of an already active transaction.

bytes transaction = 8;

Returns
Type	Description
`ByteString`	The transaction.

hasMask()

public abstract boolean hasMask()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the mask field is set.

hasReadTime()

public abstract boolean hasReadTime()

Perform the read at the provided time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 10;

Returns
Type	Description
`boolean`	Whether the readTime field is set.

hasTransaction()

public abstract boolean hasTransaction()

Perform the read as part of an already active transaction.

bytes transaction = 8;

Returns
Type	Description
`boolean`	Whether the transaction field is set.