Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class FoldersClient.
Service Description: Manages Cloud Platform folder resources.
Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ ResourceManager \ V3 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createFolder
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 folders that share its parent. - The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; 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 300.
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 in the details list in the Operation.error
field.
The caller must have resourcemanager.folders.create
permission on the
identified parent.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::createFolderAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\CreateFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
use Google\Cloud\ResourceManager\V3\CreateFolderRequest;
use Google\Cloud\ResourceManager\V3\Folder;
use Google\Rpc\Status;
/**
* @param string $folderParent The folder's parent's resource name.
* Updates to the folder's parent must be performed using
* [MoveFolder][google.cloud.resourcemanager.v3.Folders.MoveFolder].
*/
function create_folder_sample(string $folderParent): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$folder = (new Folder())
->setParent($folderParent);
$request = (new CreateFolderRequest())
->setFolder($folder);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $foldersClient->createFolder($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Folder $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$folderParent = '[PARENT]';
create_folder_sample($folderParent);
}
deleteFolder
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, where a folder is empty if it doesn't contain any folders or projects in the ACTIVE state. If called on a folder in DELETE_REQUESTED state the operation will result in a no-op success.
The caller must have resourcemanager.folders.delete
permission on the
identified folder.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::deleteFolderAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\DeleteFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
use Google\Cloud\ResourceManager\V3\DeleteFolderRequest;
use Google\Cloud\ResourceManager\V3\Folder;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the folder to be deleted.
* Must be of the form `folders/{folder_id}`. Please see
* {@see FoldersClient::folderName()} for help formatting this field.
*/
function delete_folder_sample(string $formattedName): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$request = (new DeleteFolderRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $foldersClient->deleteFolder($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Folder $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = FoldersClient::folderName('[FOLDER]');
delete_folder_sample($formattedName);
}
getFolder
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.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::getFolderAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\GetFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\ResourceManager\V3\Folder |
use Google\ApiCore\ApiException;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
use Google\Cloud\ResourceManager\V3\Folder;
use Google\Cloud\ResourceManager\V3\GetFolderRequest;
/**
* @param string $formattedName The resource name of the folder to retrieve.
* Must be of the form `folders/{folder_id}`. Please see
* {@see FoldersClient::folderName()} for help formatting this field.
*/
function get_folder_sample(string $formattedName): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$request = (new GetFolderRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Folder $response */
$response = $foldersClient->getFolder($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = FoldersClient::folderName('[FOLDER]');
get_folder_sample($formattedName);
}
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, for example: "folders/1234".
The caller must have resourcemanager.folders.getIamPolicy
permission
on the identified folder.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
function get_iam_policy_sample(string $resource): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $foldersClient->getIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
listFolders
Lists the folders that are direct descendants of supplied parent resource.
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.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::listFoldersAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\ListFoldersRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
use Google\Cloud\ResourceManager\V3\Folder;
use Google\Cloud\ResourceManager\V3\ListFoldersRequest;
/**
* @param string $parent 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`.
*/
function list_folders_sample(string $parent): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$request = (new ListFoldersRequest())
->setParent($parent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $foldersClient->listFolders($request);
/** @var Folder $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$parent = '[PARENT]';
list_folders_sample($parent);
}
moveFolder
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 in the Status.details
field.
If it occurs asynchronously, then the FolderOperation will be returned
in 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.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::moveFolderAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\MoveFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
use Google\Cloud\ResourceManager\V3\Folder;
use Google\Cloud\ResourceManager\V3\MoveFolderRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the Folder to move.
* Must be of the form folders/{folder_id}
* Please see {@see FoldersClient::folderName()} for help formatting this field.
* @param string $destinationParent The resource name of the folder or organization which should be
* the folder's new parent. Must be of the form `folders/{folder_id}` or
* `organizations/{org_id}`.
*/
function move_folder_sample(string $formattedName, string $destinationParent): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$request = (new MoveFolderRequest())
->setName($formattedName)
->setDestinationParent($destinationParent);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $foldersClient->moveFolder($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Folder $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = FoldersClient::folderName('[FOLDER]');
$destinationParent = '[DESTINATION_PARENT]';
move_folder_sample($formattedName, $destinationParent);
}
searchFolders
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
.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::searchFoldersAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\SearchFoldersRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
use Google\Cloud\ResourceManager\V3\Folder;
use Google\Cloud\ResourceManager\V3\SearchFoldersRequest;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function search_folders_sample(): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$request = new SearchFoldersRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $foldersClient->searchFolders($request);
/** @var Folder $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
setIamPolicy
Sets the access control policy on a folder, replacing any existing policy.
The resource
field should be the folder's resource name, for example:
"folders/1234".
The caller must have resourcemanager.folders.setIamPolicy
permission
on the identified folder.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
function set_iam_policy_sample(string $resource): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $foldersClient->setIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified folder.
The resource
field should be the folder's resource name,
for example: "folders/1234".
There are no permissions required for making this API call.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
/**
* @param string $resource REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
* @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $foldersClient->testIamPermissions($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
undeleteFolder
Cancels the deletion request for a folder. This method may be called on a
folder in any state. If the folder is in the
ACTIVE state the
result will be a no-op success. 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.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::undeleteFolderAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\UndeleteFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
use Google\Cloud\ResourceManager\V3\Folder;
use Google\Cloud\ResourceManager\V3\UndeleteFolderRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the folder to undelete.
* Must be of the form `folders/{folder_id}`. Please see
* {@see FoldersClient::folderName()} for help formatting this field.
*/
function undelete_folder_sample(string $formattedName): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$request = (new UndeleteFolderRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $foldersClient->undeleteFolder($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Folder $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = FoldersClient::folderName('[FOLDER]');
undelete_folder_sample($formattedName);
}
updateFolder
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 the 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
between 3 and 30 characters. This is captured by the regular expression:
[\p{L}\p{N}][\p{L}\p{N}_- ]{1,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.
The async variant is Google\Cloud\ResourceManager\V3\Client\FoldersClient::updateFolderAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\UpdateFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\Client\FoldersClient;
use Google\Cloud\ResourceManager\V3\Folder;
use Google\Cloud\ResourceManager\V3\UpdateFolderRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* @param string $folderParent The folder's parent's resource name.
* Updates to the folder's parent must be performed using
* [MoveFolder][google.cloud.resourcemanager.v3.Folders.MoveFolder].
*/
function update_folder_sample(string $folderParent): void
{
// Create a client.
$foldersClient = new FoldersClient();
// Prepare the request message.
$folder = (new Folder())
->setParent($folderParent);
$updateMask = new FieldMask();
$request = (new UpdateFolderRequest())
->setFolder($folder)
->setUpdateMask($updateMask);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $foldersClient->updateFolder($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Folder $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$folderParent = '[PARENT]';
update_folder_sample($folderParent);
}
createFolderAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\CreateFolderRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteFolderAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\DeleteFolderRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getFolderAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\GetFolderRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listFoldersAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\ListFoldersRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
moveFolderAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\MoveFolderRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
searchFoldersAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\SearchFoldersRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
undeleteFolderAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\UndeleteFolderRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateFolderAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\UpdateFolderRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\LongRunning\Client\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::folderName
Formats a string containing the fully-qualified path to represent a folder resource.
Parameter | |
---|---|
Name | Description |
folder |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- folder: folders/{folder}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array |
An associative array from name component IDs to component values. |