A page token
[ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token],
received from a previous
[DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
[DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.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.v1beta.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"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eListDocumentsRequest\u003c/code\u003e class is used to request a list of documents from the Discovery Engine v1beta API, specifically for the \u003ccode\u003eDocumentService.ListDocuments\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThis class implements several interfaces, including \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, and inherits from the \u003ccode\u003eobject\u003c/code\u003e class.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListDocumentsRequest\u003c/code\u003e class allows for pagination through its \u003ccode\u003ePageSize\u003c/code\u003e and \u003ccode\u003ePageToken\u003c/code\u003e properties, where \u003ccode\u003ePageSize\u003c/code\u003e limits the number of returned documents, with a maximum of 1000, and \u003ccode\u003ePageToken\u003c/code\u003e fetches the next page.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eParent\u003c/code\u003e property specifies the branch under which to list documents, using a resource name format, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version available is 1.0.0-beta18.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1beta API - Class ListDocumentsRequest (1.0.0-beta19)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta19 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest)\n- [1.0.0-beta18](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/1.0.0-beta18/Google.Cloud.DiscoveryEngine.V1Beta.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 v1beta API class ListDocumentsRequest.\n\nRequest message for\n\\[DocumentService.ListDocuments\\]\\[google.cloud.discoveryengine.v1beta.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.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ListDocumentsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ListDocumentsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.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.V1Beta](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1Beta.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.v1beta.Document\\]s\nto return. If unspecified, defaults to 100. The maximum allowed value is\n\n1. Values 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.v1beta.ListDocumentsResponse.next_page_token\\],\nreceived from a previous\n\\[DocumentService.ListDocuments\\]\\[google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments\\]\ncall. Provide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to\n\\[DocumentService.ListDocuments\\]\\[google.cloud.discoveryengine.v1beta.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.v1beta.Document\\]s under this\nbranch, regardless of whether or not this branch exists, a\n`PERMISSION_DENIED` error is returned.\n\n### ParentAsBranchName\n\n public BranchName ParentAsBranchName { get; set; }\n\n[BranchName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BranchName)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest#Google_Cloud_DiscoveryEngine_V1Beta_ListDocumentsRequest_Parent) resource name property."]]
