Class ProjectsResource.DatabasesResource.DocumentsResource.ListRequest

Lists documents.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListDocumentsResponse>
FirestoreBaseServiceRequest<ListDocumentsResponse>
ProjectsResource.DatabasesResource.DocumentsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class ProjectsResource.DatabasesResource.DocumentsResource.ListRequest : FirestoreBaseServiceRequest<ListDocumentsResponse>, IClientServiceRequest<ListDocumentsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent, string collectionId)
Parameters
Type Name Description
IClientService service
string parent
string collectionId

Properties

CollectionId

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.

Declaration
[RequestParameter("collectionId", RequestParameterType.Path)]
public virtual string CollectionId { get; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MaskFieldPaths

The list of field paths in the mask. See Document.fields for a field path syntax reference.

Declaration
[RequestParameter("mask.fieldPaths", RequestParameterType.Query)]
public virtual Repeatable<string> MaskFieldPaths { get; set; }
Property Value
Type Description
Repeatable<string>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

OrderBy

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.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

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

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

ReadTime

object representation of ReadTimeRaw.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use ReadTimeDateTimeOffset instead.")]
public virtual object ReadTime { get; set; }
Property Value
Type Description
object

ReadTimeDateTimeOffset

Declaration
public virtual DateTimeOffset? ReadTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ReadTimeRaw

String representation of ReadTimeDateTimeOffset, formatted for inclusion in the HTTP request.

Declaration
[RequestParameter("readTime", RequestParameterType.Query)]
public virtual string ReadTimeRaw { get; }
Property Value
Type Description
string

Recursive

Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a collection_id, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with recursive may not specify show_missing.

Declaration
[RequestParameter("recursive", RequestParameterType.Query)]
public virtual bool? Recursive { get; set; }
Property Value
Type Description
bool?

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

ShowMissing

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.

Declaration
[RequestParameter("showMissing", RequestParameterType.Query)]
public virtual bool? ShowMissing { get; set; }
Property Value
Type Description
bool?

Transaction

Perform the read as part of an already active transaction.

Declaration
[RequestParameter("transaction", RequestParameterType.Query)]
public virtual string Transaction { get; set; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements