Interface ListDocumentsRequestOrBuilder (3.4.2)

Version 3.4.2

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public interface ListDocumentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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

Returns

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

Returns

Type	Description
ByteString	The bytes for collectionId.

getConsistencySelectorCase()

public abstract ListDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()

Returns

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;

Returns

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;

Returns

Type	Description
DocumentMaskOrBuilder

getOrderBy()

public abstract String getOrderBy()

The order to sort results by. For example: priority desc, name.

string order_by = 6;

Returns

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;

Returns

Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

The maximum number of documents to return.

int32 page_size = 3;

Returns

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;

Returns

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;

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()

Reads documents as they were at the given time. This may not be older than 270 seconds.

.google.protobuf.Timestamp read_time = 10;

Returns

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;

Returns

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;

Returns

Type	Description
boolean	The showMissing.

getTransaction()

public abstract ByteString getTransaction()

Reads documents in a transaction.

bytes transaction = 8;

Returns

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;

Returns

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;

Returns

Type	Description
boolean	Whether the readTime field is set.

hasTransaction()

public abstract boolean hasTransaction()

Reads documents in a transaction.

bytes transaction = 8;

Returns

Type	Description
boolean	Whether the transaction field is set.