com.google.firestore.v1

Interface ListDocumentsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListDocumentsRequest, ListDocumentsRequest.Builder

public interface ListDocumentsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getCollectionId() Optional.
com.google.protobuf.ByteString	getCollectionIdBytes() Optional.
ListDocumentsRequest.ConsistencySelectorCase	getConsistencySelectorCase()
DocumentMask	getMask() Optional.
DocumentMaskOrBuilder	getMaskOrBuilder() Optional.
String	getOrderBy() Optional.
com.google.protobuf.ByteString	getOrderByBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Timestamp	getReadTime() Perform the read at the provided time.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() Perform the read at the provided time.
boolean	getShowMissing() If the list should show missing documents.
com.google.protobuf.ByteString	getTransaction() Perform the read as part of an already active transaction.
boolean	hasMask() Optional.
boolean	hasReadTime() Perform the read at the provided time.
boolean	hasTransaction() Perform the read as part of an already active transaction.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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:

The parent.

getParentBytes

com.google.protobuf.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:

The bytes for parent.

getCollectionId

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:

The collectionId.

getCollectionIdBytes

com.google.protobuf.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:

The bytes for collectionId.

getPageSize

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:

The pageSize.

getPageToken

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:

The pageToken.

getPageTokenBytes

com.google.protobuf.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:

The bytes for pageToken.

getOrderBy

String getOrderBy()

 Optional. The optional ordering of the documents to return.
 For example: `priority desc, __name__ desc`.
 This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.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:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 Optional. The optional ordering of the documents to return.
 For example: `priority desc, __name__ desc`.
 This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.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:

The bytes for orderBy.

hasMask

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:

Whether the mask field is set.

getMask

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:

The mask.

getMaskOrBuilder

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

hasTransaction

boolean hasTransaction()

 Perform the read as part of an already active transaction.
 

bytes transaction = 8;

Returns:

Whether the transaction field is set.

getTransaction

com.google.protobuf.ByteString getTransaction()

 Perform the read as part of an already active transaction.
 

bytes transaction = 8;

Returns:

The transaction.

hasReadTime

boolean hasReadTime()

 Perform the read at the provided time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 10;

Returns:

Whether the readTime field is set.

getReadTime

com.google.protobuf.Timestamp getReadTime()

 Perform the read at the provided time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 10;

Returns:

The readTime.

getReadTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()

 Perform the read at the provided time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 10;

getShowMissing

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`][google.firestore.v1.Document.create_time], or
 [`update_time`][google.firestore.v1.Document.update_time] set.
 Requests with `show_missing` may not specify `where` or `order_by`.
 

bool show_missing = 12;

Returns:

The showMissing.

getConsistencySelectorCase

ListDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()