Generated from protobuf messagegoogle.cloud.discoveryengine.v1.ListDocumentsRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent branch resource name, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Usedefault_branchas the branch ID, to list documents under the default branch. If the caller does not have permission to listDocuments under this branch, regardless of whether or not this branch exists, aPERMISSION_DENIEDerror is returned.
↳ page_size
int
Maximum number ofDocuments 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, anINVALID_ARGUMENTerror is returned.
Required. The parent branch resource name, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Usedefault_branchas the branch ID, to list documents under the default
branch.
If the caller does not have permission to listDocuments under this branch,
regardless of whether or not this branch exists, aPERMISSION_DENIEDerror is returned.
Returns
Type
Description
string
setParent
Required. The parent branch resource name, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Usedefault_branchas the branch ID, to list documents under the default
branch.
If the caller does not have permission to listDocuments under this branch,
regardless of whether or not this branch exists, aPERMISSION_DENIEDerror is returned.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Maximum number ofDocuments 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, anINVALID_ARGUMENTerror is returned.
Returns
Type
Description
int
setPageSize
Maximum number ofDocuments 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, anINVALID_ARGUMENTerror is returned.
When paginating, all other parameters provided toDocumentService.ListDocumentsmust match the call that provided the page token. Otherwise, anINVALID_ARGUMENTerror is returned.
When paginating, all other parameters provided toDocumentService.ListDocumentsmust match the call that provided the page token. Otherwise, anINVALID_ARGUMENTerror is returned.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent branch resource name, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Usedefault_branchas the branch ID, to list documents under the default
branch.
If the caller does not have permission to listDocuments under this branch,
regardless of whether or not this branch exists, aPERMISSION_DENIEDerror is returned. Please seeDocumentServiceClient::branchName()for help formatting this field.
[[["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-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class ListDocumentsRequest (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.ListDocumentsRequest)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.ListDocumentsRequest)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.ListDocumentsRequest)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.ListDocumentsRequest)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.ListDocumentsRequest)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.ListDocumentsRequest)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.ListDocumentsRequest)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.ListDocumentsRequest)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.ListDocumentsRequest)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.ListDocumentsRequest)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.ListDocumentsRequest)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.ListDocumentsRequest)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.ListDocumentsRequest)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.ListDocumentsRequest)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.ListDocumentsRequest)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.ListDocumentsRequest)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.ListDocumentsRequest) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListDocumentsRequest.\n\nRequest message for\n[DocumentService.ListDocuments](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.DocumentServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_DocumentServiceClient__listDocuments__)\nmethod.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.ListDocumentsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent branch resource name, such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.\n\nUse `default_branch` as the branch ID, to list documents under the default\nbranch.\nIf the caller does not have permission to list\n[Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document)s under this branch,\nregardless of whether or not this branch exists, a `PERMISSION_DENIED`\nerror is returned.\n\n### setParent\n\nRequired. The parent branch resource name, such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.\n\nUse `default_branch` as the branch ID, to list documents under the default\nbranch.\nIf the caller does not have permission to list\n[Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document)s under this branch,\nregardless of whether or not this branch exists, a `PERMISSION_DENIED`\nerror is returned.\n\n### getPageSize\n\nMaximum number of [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document)s to\nreturn. If unspecified, defaults to 100. The maximum allowed value is 1000.\n\nValues above 1000 are set to 1000.\nIf this field is negative, an `INVALID_ARGUMENT` error is returned.\n\n### setPageSize\n\nMaximum number of [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document)s to\nreturn. If unspecified, defaults to 100. The maximum allowed value is 1000.\n\nValues above 1000 are set to 1000.\nIf this field is negative, an `INVALID_ARGUMENT` error is returned.\n\n### getPageToken\n\nA page token\n[ListDocumentsResponse.next_page_token](/php/docs/reference/cloud-discoveryengine/latest/V1.ListDocumentsResponse#_Google_Cloud_DiscoveryEngine_V1_ListDocumentsResponse__getNextPageToken__),\nreceived from a previous\n[DocumentService.ListDocuments](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.DocumentServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_DocumentServiceClient__listDocuments__)\ncall. Provide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to\n[DocumentService.ListDocuments](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.DocumentServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_DocumentServiceClient__listDocuments__)\nmust match the call that provided the page token. Otherwise, an\n`INVALID_ARGUMENT` error is returned.\n\n### setPageToken\n\nA page token\n[ListDocumentsResponse.next_page_token](/php/docs/reference/cloud-discoveryengine/latest/V1.ListDocumentsResponse#_Google_Cloud_DiscoveryEngine_V1_ListDocumentsResponse__getNextPageToken__),\nreceived from a previous\n[DocumentService.ListDocuments](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.DocumentServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_DocumentServiceClient__listDocuments__)\ncall. Provide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to\n[DocumentService.ListDocuments](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.DocumentServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_DocumentServiceClient__listDocuments__)\nmust match the call that provided the page token. Otherwise, an\n`INVALID_ARGUMENT` error is returned.\n\n### static::build"]]
