Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class ListFoldersRequest.
The ListFolders request message.
Generated from protobuf messagegoogle.cloud.resourcemanager.v3.ListFoldersRequest
Namespace
Google \ Cloud \ ResourceManager \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the valuefolders/{folder_id}. If the parent is an organization, use the valueorganizations/{org_id}. Access to this method is controlled by checking theresourcemanager.folders.listpermission on theparent.
↳ page_size
int
Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.
↳ page_token
string
Optional. A pagination token returned from a previous call toListFoldersthat indicates where this listing should continue from.
↳ show_deleted
bool
Optional. Controls whether folders in theDELETE_REQUESTEDstate should be returned. Defaults to false.
getParent
Required. The name of the parent resource whose folders are being listed.
Only children of this parent resource are listed; descendants are not
listed.
If the parent is a folder, use the valuefolders/{folder_id}. If the
parent is an organization, use the valueorganizations/{org_id}.
Access to this method is controlled by checking theresourcemanager.folders.listpermission on theparent.
Returns
Type
Description
string
setParent
Required. The name of the parent resource whose folders are being listed.
Only children of this parent resource are listed; descendants are not
listed.
If the parent is a folder, use the valuefolders/{folder_id}. If the
parent is an organization, use the valueorganizations/{org_id}.
Access to this method is controlled by checking theresourcemanager.folders.listpermission on theparent.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of folders to return in the response. The
server can return fewer folders than requested. If unspecified, server
picks an appropriate default.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of folders to return in the response. The
server can return fewer folders than requested. If unspecified, server
picks an appropriate default.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A pagination token returned from a previous call toListFoldersthat indicates where this listing should continue from.
Returns
Type
Description
string
setPageToken
Optional. A pagination token returned from a previous call toListFoldersthat indicates where this listing should continue from.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getShowDeleted
Optional. Controls whether folders in theDELETE_REQUESTEDstate should be returned. Defaults to false.
Returns
Type
Description
bool
setShowDeleted
Optional. Controls whether folders in theDELETE_REQUESTEDstate should be returned. Defaults to false.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The name of the parent resource whose folders are being listed.
Only children of this parent resource are listed; descendants are not
listed.
If the parent is a folder, use the valuefolders/{folder_id}. If the
parent is an organization, use the valueorganizations/{org_id}.
Access to this method is controlled by checking theresourcemanager.folders.listpermission on theparent.
[[["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 Resource Manager V3 Client - Class ListFoldersRequest (1.0.4)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.4 (latest)](/php/docs/reference/cloud-resource-manager/latest/V3.ListFoldersRequest)\n- [1.0.3](/php/docs/reference/cloud-resource-manager/1.0.3/V3.ListFoldersRequest)\n- [0.8.5](/php/docs/reference/cloud-resource-manager/0.8.5/V3.ListFoldersRequest)\n- [0.7.2](/php/docs/reference/cloud-resource-manager/0.7.2/V3.ListFoldersRequest)\n- [0.6.1](/php/docs/reference/cloud-resource-manager/0.6.1/V3.ListFoldersRequest)\n- [0.5.0](/php/docs/reference/cloud-resource-manager/0.5.0/V3.ListFoldersRequest)\n- [0.4.1](/php/docs/reference/cloud-resource-manager/0.4.1/V3.ListFoldersRequest)\n- [0.3.9](/php/docs/reference/cloud-resource-manager/0.3.9/V3.ListFoldersRequest) \nReference documentation and code samples for the Google Cloud Resource Manager V3 Client class ListFoldersRequest.\n\nThe ListFolders request message.\n\nGenerated from protobuf message `google.cloud.resourcemanager.v3.ListFoldersRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ResourceManager \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The name of the parent resource whose folders are being listed.\n\nOnly children of this parent resource are listed; descendants are not\nlisted.\nIf the parent is a folder, use the value `folders/{folder_id}`. If the\nparent is an organization, use the value `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.\n\n### setParent\n\nRequired. The name of the parent resource whose folders are being listed.\n\nOnly children of this parent resource are listed; descendants are not\nlisted.\nIf the parent is a folder, use the value `folders/{folder_id}`. If the\nparent is an organization, use the value `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.\n\n### getPageSize\n\nOptional. The maximum number of folders to return in the response. The\nserver can return fewer folders than requested. If unspecified, server\npicks an appropriate default.\n\n### setPageSize\n\nOptional. The maximum number of folders to return in the response. The\nserver can return fewer folders than requested. If unspecified, server\npicks an appropriate default.\n\n### getPageToken\n\nOptional. A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\n\n### setPageToken\n\nOptional. A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\n\n### getShowDeleted\n\nOptional. Controls whether folders in the\n[DELETE_REQUESTED](/php/docs/reference/cloud-resource-manager/latest/V3.Folder.State#_Google_Cloud_ResourceManager_V3_Folder_State__DELETE_REQUESTED)\nstate should be returned. Defaults to false.\n\n### setShowDeleted\n\nOptional. Controls whether folders in the\n[DELETE_REQUESTED](/php/docs/reference/cloud-resource-manager/latest/V3.Folder.State#_Google_Cloud_ResourceManager_V3_Folder_State__DELETE_REQUESTED)\nstate should be returned. Defaults to false.\n\n### static::build"]]
