Class ListDocumentsRequest (3.21.4)

public final class ListDocumentsRequest extends GeneratedMessageV3 implements ListDocumentsRequestOrBuilder

The request for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsRequest

Static Fields

COLLECTION_ID_FIELD_NUMBER

public static final int COLLECTION_ID_FIELD_NUMBER
Field Value
Type Description
int

MASK_FIELD_NUMBER

public static final int MASK_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int

SHOW_MISSING_FIELD_NUMBER

public static final int SHOW_MISSING_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListDocumentsRequest getDefaultInstance()
Returns
Type Description
ListDocumentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListDocumentsRequest.Builder newBuilder()
Returns
Type Description
ListDocumentsRequest.Builder

newBuilder(ListDocumentsRequest prototype)

public static ListDocumentsRequest.Builder newBuilder(ListDocumentsRequest prototype)
Parameter
Name Description
prototype ListDocumentsRequest
Returns
Type Description
ListDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListDocumentsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListDocumentsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListDocumentsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListDocumentsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListDocumentsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListDocumentsRequest> parser()
Returns
Type Description
Parser<ListDocumentsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCollectionId()

public 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 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 ListDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
Type Description
ListDocumentsRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public ListDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
ListDocumentsRequest

getMask()

public 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 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 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 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 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 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 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 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 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.

getParserForType()

public Parser<ListDocumentsRequest> getParserForType()
Returns
Type Description
Parser<ListDocumentsRequest>
Overrides

getReadTime()

public 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 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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShowMissing()

public 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 ByteString getTransaction()

Perform the read as part of an already active transaction.

bytes transaction = 8;

Returns
Type Description
ByteString

The transaction.

hasMask()

public 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListDocumentsRequest.Builder newBuilderForType()
Returns
Type Description
ListDocumentsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListDocumentsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListDocumentsRequest.Builder toBuilder()
Returns
Type Description
ListDocumentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException