Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class ListFoldersRequest.
The ListFolders request message.
Generated from protobuf message google.cloud.resourcemanager.v3.ListFoldersRequest
Methods
build
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 value folders/{folder_id}
. If the
parent is an organization, use the value organizations/{org_id}
.
Access to this method is controlled by checking the resourcemanager.folders.list
permission on the parent
.
__construct
Constructor.
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 value folders/{folder_id}
. If the parent is an organization, use the value organizations/{org_id}
. Access to this method is controlled by checking the resourcemanager.folders.list
permission on the parent
.
↳ 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 to ListFolders
that indicates where this listing should continue from.
↳ show_deleted
bool
Optional. Controls whether folders in the DELETE_REQUESTED state 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 value folders/{folder_id}
. If the
parent is an organization, use the value organizations/{org_id}
.
Access to this method is controlled by checking the resourcemanager.folders.list
permission on the parent
.
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 value folders/{folder_id}
. If the
parent is an organization, use the value organizations/{org_id}
.
Access to this method is controlled by checking the resourcemanager.folders.list
permission on the parent
.
var
string
$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.
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.
var
int
$this
getPageToken
Optional. A pagination token returned from a previous call to ListFolders
that indicates where this listing should continue from.
string
setPageToken
Optional. A pagination token returned from a previous call to ListFolders
that indicates where this listing should continue from.
var
string
$this
getShowDeleted
Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.
bool
setShowDeleted
Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.
var
bool
$this
