com.google.firestore.v1beta1

Interface ListDocumentsRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ListDocumentsRequest, ListDocumentsRequest.Builder

public interface ListDocumentsRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCollectionId() The collection ID, relative to `parent`, to list.
ByteString	getCollectionIdBytes() The collection ID, relative to `parent`, to list.
ListDocumentsRequest.ConsistencySelectorCase	getConsistencySelectorCase()
DocumentMask	getMask() The fields to return.
DocumentMaskOrBuilder	getMaskOrBuilder() The fields to return.
java.lang.String	getOrderBy() The order to sort results by.
ByteString	getOrderByBytes() The order to sort results by.
int	getPageSize() The maximum number of documents to return.
java.lang.String	getPageToken() The `next_page_token` value returned from a previous List request, if any.
ByteString	getPageTokenBytes() The `next_page_token` value returned from a previous List request, if any.
java.lang.String	getParent() The parent resource name.
ByteString	getParentBytes() The parent resource name.
Timestamp	getReadTime() Reads documents as they were at the given time.
TimestampOrBuilder	getReadTimeOrBuilder() Reads documents as they were at the given time.
boolean	getShowMissing() If the list should show missing documents.
ByteString	getTransaction() Reads documents in a transaction.
boolean	hasMask() The fields to return.
boolean	hasReadTime() Reads documents as they were at the given time.

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

java.lang.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;

getParentBytes

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;

getCollectionId

java.lang.String getCollectionId()

 The collection ID, relative to `parent`, to list. For example: `chatrooms`
 or `messages`.
 

string collection_id = 2;

getCollectionIdBytes

ByteString getCollectionIdBytes()

 The collection ID, relative to `parent`, to list. For example: `chatrooms`
 or `messages`.
 

string collection_id = 2;

getPageSize

int getPageSize()

 The maximum number of documents to return.
 

int32 page_size = 3;

getPageToken

java.lang.String getPageToken()

 The `next_page_token` value returned from a previous List request, if any.
 

string page_token = 4;

getPageTokenBytes

ByteString getPageTokenBytes()

 The `next_page_token` value returned from a previous List request, if any.
 

string page_token = 4;

getOrderBy

java.lang.String getOrderBy()

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

string order_by = 6;

getOrderByBytes

ByteString getOrderByBytes()

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

string order_by = 6;

hasMask

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.v1beta1.DocumentMask mask = 7;

getMask

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.v1beta1.DocumentMask mask = 7;

getMaskOrBuilder

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.v1beta1.DocumentMask mask = 7;

getTransaction

ByteString getTransaction()

 Reads documents in a transaction.
 

bytes transaction = 8;

hasReadTime

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;

getReadTime

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;

getReadTimeOrBuilder

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;

getShowMissing

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

bool show_missing = 12;

getConsistencySelectorCase

ListDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()