Firestore v1 API - Class ListDocumentsRequest (3.1.0)

Version 3.1.0

• 3.9.0 (latest)
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.0
• 2.3.0

public sealed class ListDocumentsRequest : IMessage<ListDocumentsRequest>, IEquatable<ListDocumentsRequest>, IDeepCloneable<ListDocumentsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Firestore v1 API class ListDocumentsRequest.

The request for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

Inheritance

object > ListDocumentsRequest

Implements

IMessageListDocumentsRequest, IEquatableListDocumentsRequest, IDeepCloneableListDocumentsRequest, IBufferMessage, IMessage, IPageRequest

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.FirestoreV1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

ListDocumentsRequest()

public ListDocumentsRequest()

ListDocumentsRequest(ListDocumentsRequest)

public ListDocumentsRequest(ListDocumentsRequest other)

Parameter
Name	Description
other	ListDocumentsRequest

Properties

CollectionId

public string CollectionId { get; set; }

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

Property Value
Type	Description
string

ConsistencySelectorCase

public ListDocumentsRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }

Property Value
Type	Description
ListDocumentsRequestConsistencySelectorOneofCase

Mask

public DocumentMask Mask { get; set; }

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.

Property Value
Type	Description
DocumentMask

OrderBy

public string OrderBy { get; set; }

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

Property Value
Type	Description
string

PageSize

public int PageSize { get; set; }

The maximum number of documents to return.

Property Value
Type	Description
int

PageToken

public string PageToken { get; set; }

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

Property Value
Type	Description
string

Parent

public string Parent { get; set; }

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

Property Value
Type	Description
string

ReadTime

public Timestamp ReadTime { get; set; }

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

Property Value
Type	Description
Timestamp

ShowMissing

public bool ShowMissing { get; set; }

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.v1.Document.create_time], or [Document.update_time][google.firestore.v1.Document.update_time] set.

Requests with show_missing may not specify where or order_by.

Property Value
Type	Description
bool

Transaction

public ByteString Transaction { get; set; }

Reads documents in a transaction.

Property Value
Type	Description
ByteString