Google Cloud Resource Manager V3 Client - Class ListFoldersRequest (1.0.0)

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

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 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.

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 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.

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 to ListFolders that indicates where this listing should continue from.

Returns
Type Description
string

setPageToken

Optional. A pagination token returned from a previous call to ListFolders that indicates where this listing should continue from.

Parameter
Name Description
var string
Returns
Type Description
$this

getShowDeleted

Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.

Returns
Type Description
bool

setShowDeleted

Optional. Controls whether folders in the DELETE_REQUESTED state 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 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.
Returns
Type Description
Google\Cloud\ResourceManager\V3\ListFoldersRequest