Documentation

Google_Service_CloudResourceManager_Resource_Folders extends Google_Service_Resource
in package

Application

The "folders" collection of methods.

Typical usage is: $cloudresourcemanagerService = new Google_Service_CloudResourceManager(...); $folders = $cloudresourcemanagerService->folders;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_CloudResourceManager_Operation: Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folder's that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 4.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_CloudResourceManager_Folder: Requests deletion of a Folder. The Folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty Folder in the ACTIVE state, where a Folder is empty if it doesn't contain any Folders or Projects in the ACTIVE state. The caller must have `resourcemanager.folders.delete` permission on the identified folder. (folders.delete)
get() : Google_Service_CloudResourceManager_Folder: Retrieves a Folder identified by the supplied resource name. Valid Folder resource names have the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have `resourcemanager.folders.get` permission on the identified folder. (folders.get)
getIamPolicy() : Google_Service_CloudResourceManager_Policy: Gets the access control policy for a Folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the Folder's resource name, e.g. "folders/1234". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder.
listFolders() : Google_Service_CloudResourceManager_ListFoldersResponse: Lists the Folders that are direct descendants of supplied parent resource.
move() : Google_Service_CloudResourceManager_Operation: Moves a Folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success the Operation.response field will be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent. (folders.move)
patch() : Google_Service_CloudResourceManager_Folder: Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field.
search() : Google_Service_CloudResourceManager_SearchFoldersResponse: Search for folders that match specific filter criteria. Search provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`. (folders.search)
setIamPolicy() : Google_Service_CloudResourceManager_Policy: Sets the access control policy on a Folder, replacing any existing policy.
testIamPermissions() : Google_Service_CloudResourceManager_TestIamPermissionsResponse: Returns permissions that a caller has on the specified Folder. The `resource` field should be the Folder's resource name, e.g. "folders/1234". There are no permissions required for making this API call. (folders.testIamPermissions)
undelete() : Google_Service_CloudResourceManager_Folder: Cancels the deletion request for a Folder. This method may only be called on a Folder in the DELETE_REQUESTED state. In order to succeed, the Folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height and fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folder's that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 4.


    public
                create(Google_Service_CloudResourceManager_Folder $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_Operation

Note, the full active + deleted Folder hierarchy is allowed to reach a height of 8; this provides additional headroom when moving folders that contain deleted folders. + The addition of the Folder must not cause the total number of Folders under its parent to exceed 100. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error field. The caller must have resourcemanager.folders.create permission on the identified parent. (folders.create)

Parameters

$postBody : Google_Service_CloudResourceManager_Folder
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Requests deletion of a Folder. The Folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty Folder in the ACTIVE state, where a Folder is empty if it doesn't contain any Folders or Projects in the ACTIVE state. The caller must have `resourcemanager.folders.delete` permission on the identified folder. (folders.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_Folder

Parameters

$name : string: Required. the resource name of the Folder to be deleted. Must be of the form folders/{folder_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_Folder —

get()

Retrieves a Folder identified by the supplied resource name. Valid Folder resource names have the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have `resourcemanager.folders.get` permission on the identified folder. (folders.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_Folder

Parameters

$name : string: Required. The resource name of the Folder to retrieve. Must be of the form folders/{folder_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_Folder —

getIamPolicy()

Gets the access control policy for a Folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the Folder's resource name, e.g. "folders/1234". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder.


    public
                getIamPolicy(string $resource, Google_Service_CloudResourceManager_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_Policy

(folders.getIamPolicy)

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudResourceManager_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_Policy —

listFolders()

Lists the Folders that are direct descendants of supplied parent resource.


    public
                listFolders([array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_ListFoldersResponse

List provides a strongly consistent view of the Folders underneath the specified parent resource. List returns Folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have resourcemanager.folders.list permission on the identified parent. (folders.listFolders)

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_ListFoldersResponse —

move()

Moves a Folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success the Operation.response field will be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent. (folders.move)


    public
                move(string $name, Google_Service_CloudResourceManager_MoveFolderRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_Operation

Parameters

$name : string: Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}
$postBody : Google_Service_CloudResourceManager_MoveFolderRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_Operation —

patch()

Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field.


    public
                patch(string $name, Google_Service_CloudResourceManager_Folder $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_Folder

(folders.patch)

Parameters

$name : string: Output only. The resource name of the Folder. Its format is folders/{folder_id}, for example: "folders/1234".
$postBody : Google_Service_CloudResourceManager_Folder
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_Folder —

search()

Search for folders that match specific filter criteria. Search provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`. (folders.search)


    public
                search(Google_Service_CloudResourceManager_SearchFoldersRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_SearchFoldersResponse

Parameters

$postBody : Google_Service_CloudResourceManager_SearchFoldersRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_SearchFoldersResponse —

setIamPolicy()

Sets the access control policy on a Folder, replacing any existing policy.


    public
                setIamPolicy(string $resource, Google_Service_CloudResourceManager_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_Policy

The resource field should be the Folder's resource name, e.g. "folders/1234". The caller must have resourcemanager.folders.setIamPolicy permission on the identified folder. (folders.setIamPolicy)

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudResourceManager_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_Policy —

testIamPermissions()

Returns permissions that a caller has on the specified Folder. The `resource` field should be the Folder's resource name, e.g. "folders/1234". There are no permissions required for making this API call. (folders.testIamPermissions)


    public
                testIamPermissions(string $resource, Google_Service_CloudResourceManager_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_TestIamPermissionsResponse

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudResourceManager_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_TestIamPermissionsResponse —

undelete()

Cancels the deletion request for a Folder. This method may only be called on a Folder in the DELETE_REQUESTED state. In order to succeed, the Folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height and fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder.


    public
                undelete(string $name, Google_Service_CloudResourceManager_UndeleteFolderRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudResourceManager_Folder

(folders.undelete)

Parameters

$name : string: Required. The resource name of the Folder to undelete. Must be of the form folders/{folder_id}.
$postBody : Google_Service_CloudResourceManager_UndeleteFolderRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudResourceManager_Folder —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —