Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/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 Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
Query parameters
Parameters
pageSize
integer
Maximum number of Documents 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.
When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT 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-02-28 UTC."],[[["This webpage details how to retrieve a list of Documents via a `GET` request using the provided endpoint and parameters."],["The required `parent` path parameter specifies the branch from which to list documents, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}`, and using `default_branch` as the branch ID is possible to list documents under the default branch."],["The `pageSize` and `pageToken` query parameters allow for pagination of the document list, with `pageSize` defaulting to 100 and a maximum of 1000, and the `pageToken` being used to get the subsequent page."],["The request body for listing documents must be empty, and a successful request will return a `ListDocumentsResponse`."],["To successfully list documents, the caller needs the `discoveryengine.documents.list` IAM permission on the `parent` resource, and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
