Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
return. If unspecified, defaults to 100. The maximum allowed value is 1000.
Values above 1000 are set to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
A page token
[ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token],
received from a previous
[DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
[DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
Required. The parent branch resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Use default_branch as the branch ID, to list documents under the default
branch.
If the caller does not have permission to list
[Document][google.cloud.discoveryengine.v1.Document]s under this branch,
regardless of whether or not this branch exists, a PERMISSION_DENIED
error is returned.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003eListDocumentsRequest\u003c/code\u003e class is 1.6.0, and previous versions are also available, ranging from 1.0.0-beta06 to 1.5.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eListDocumentsRequest\u003c/code\u003e is a request message used within the Discovery Engine v1 API to retrieve a list of documents via the \u003ccode\u003eDocumentService.ListDocuments\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThis class inherits from \u003ccode\u003eobject\u003c/code\u003e and implements interfaces like \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e, and \u003ccode\u003eIPageRequest\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListDocumentsRequest\u003c/code\u003e class includes properties such as \u003ccode\u003ePageSize\u003c/code\u003e, \u003ccode\u003ePageToken\u003c/code\u003e, and \u003ccode\u003eParent\u003c/code\u003e to specify parameters for listing documents, like the maximum number of documents, pagination, and the branch to retrieve from.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eParent\u003c/code\u003e property and the \u003ccode\u003eParentAsBranchName\u003c/code\u003e is required, which indicates the branch from which to list documents, and it will give a \u003ccode\u003ePERMISSION_DENIED\u003c/code\u003e error if the caller does not have the required permissions.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class ListDocumentsRequest (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest) \n\n public sealed class ListDocumentsRequest : IMessage\u003cListDocumentsRequest\u003e, IEquatable\u003cListDocumentsRequest\u003e, IDeepCloneable\u003cListDocumentsRequest\u003e, IBufferMessage, IMessage, IPageRequest\n\nReference documentation and code samples for the Discovery Engine v1 API class ListDocumentsRequest.\n\nRequest message for\n\\[DocumentService.ListDocuments\\]\\[google.cloud.discoveryengine.v1.DocumentService.ListDocuments\\]\nmethod. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ListDocumentsRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ListDocumentsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ListDocumentsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ListDocumentsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html), [IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1.dll\n\nConstructors\n------------\n\n### ListDocumentsRequest()\n\n public ListDocumentsRequest()\n\n### ListDocumentsRequest(ListDocumentsRequest)\n\n public ListDocumentsRequest(ListDocumentsRequest other)\n\nProperties\n----------\n\n### PageSize\n\n public int PageSize { get; set; }\n\nMaximum number of \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s to\nreturn. If unspecified, defaults to 100. The maximum allowed value is 1000.\nValues above 1000 are set to 1000.\n\nIf this field is negative, an `INVALID_ARGUMENT` error is returned.\n\n### PageToken\n\n public string PageToken { get; set; }\n\nA page token\n\\[ListDocumentsResponse.next_page_token\\]\\[google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token\\],\nreceived from a previous\n\\[DocumentService.ListDocuments\\]\\[google.cloud.discoveryengine.v1.DocumentService.ListDocuments\\]\ncall. Provide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to\n\\[DocumentService.ListDocuments\\]\\[google.cloud.discoveryengine.v1.DocumentService.ListDocuments\\]\nmust match the call that provided the page token. Otherwise, an\n`INVALID_ARGUMENT` error is returned.\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The parent branch resource name, such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.\nUse `default_branch` as the branch ID, to list documents under the default\nbranch.\n\nIf the caller does not have permission to list\n\\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s under this branch,\nregardless of whether or not this branch exists, a `PERMISSION_DENIED`\nerror is returned.\n\n### ParentAsBranchName\n\n public BranchName ParentAsBranchName { get; set; }\n\n[BranchName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.BranchName)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ListDocumentsRequest#Google_Cloud_DiscoveryEngine_V1_ListDocumentsRequest_Parent) resource name property."]]
