Google Cloud Storage Control V2 Client - Class StorageControlClient (1.0.2)

use Google\ApiCore\ApiException;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\CreateFolderRequest;
use Google\Cloud\Storage\Control\V2\Folder;

/**
 * @param string $formattedParent Name of the bucket in which the folder will reside. The bucket
 *                                must be a hierarchical namespace enabled bucket. Please see
 *                                {@see StorageControlClient::bucketName()} for help formatting this field.
 * @param string $folderId        The full name of a folder, including all its parent folders.
 *                                Folders use single '/' characters as a delimiter.
 *                                The folder_id must end with a slash.
 *                                For example, the folder_id of "books/biographies/" would create a new
 *                                "biographies/" folder under the "books/" folder.
 */
function create_folder_sample(string $formattedParent, string $folderId): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $folder = new Folder();
    $request = (new CreateFolderRequest())
        ->setParent($formattedParent)
        ->setFolder($folder)
        ->setFolderId($folderId);

    // Call the API and handle any network failures.
    try {
        /** @var Folder $response */
        $response = $storageControlClient->createFolder($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
{
    $formattedParent = StorageControlClient::bucketName('[PROJECT]', '[BUCKET]');
    $folderId = '[FOLDER_ID]';

    create_folder_sample($formattedParent, $folderId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\CreateManagedFolderRequest;
use Google\Cloud\Storage\Control\V2\ManagedFolder;

/**
 * @param string $formattedParent Name of the bucket this managed folder belongs to. Please see
 *                                {@see StorageControlClient::bucketName()} for help formatting this field.
 * @param string $managedFolderId The name of the managed folder. It uses a single `/` as delimiter
 *                                and leading and trailing `/` are allowed.
 */
function create_managed_folder_sample(string $formattedParent, string $managedFolderId): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $managedFolder = new ManagedFolder();
    $request = (new CreateManagedFolderRequest())
        ->setParent($formattedParent)
        ->setManagedFolder($managedFolder)
        ->setManagedFolderId($managedFolderId);

    // Call the API and handle any network failures.
    try {
        /** @var ManagedFolder $response */
        $response = $storageControlClient->createManagedFolder($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
{
    $formattedParent = StorageControlClient::bucketName('[PROJECT]', '[BUCKET]');
    $managedFolderId = '[MANAGED_FOLDER_ID]';

    create_managed_folder_sample($formattedParent, $managedFolderId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\DeleteFolderRequest;

/**
 * @param string $formattedName Name of the folder.
 *                              Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
 *                              Please see {@see StorageControlClient::folderName()} for help formatting this field.
 */
function delete_folder_sample(string $formattedName): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $request = (new DeleteFolderRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $storageControlClient->deleteFolder($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = StorageControlClient::folderName('[PROJECT]', '[BUCKET]', '[FOLDER]');

    delete_folder_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\DeleteManagedFolderRequest;

/**
 * @param string $formattedName Name of the managed folder.
 *                              Format:
 *                              `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
 *                              Please see {@see StorageControlClient::managedFolderName()} for help formatting this field.
 */
function delete_managed_folder_sample(string $formattedName): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $request = (new DeleteManagedFolderRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $storageControlClient->deleteManagedFolder($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = StorageControlClient::managedFolderName(
        '[PROJECT]',
        '[BUCKET]',
        '[MANAGED_FOLDER]'
    );

    delete_managed_folder_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\Folder;
use Google\Cloud\Storage\Control\V2\GetFolderRequest;

/**
 * @param string $formattedName Name of the folder.
 *                              Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
 *                              Please see {@see StorageControlClient::folderName()} for help formatting this field.
 */
function get_folder_sample(string $formattedName): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $request = (new GetFolderRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Folder $response */
        $response = $storageControlClient->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 = StorageControlClient::folderName('[PROJECT]', '[BUCKET]', '[FOLDER]');

    get_folder_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\GetManagedFolderRequest;
use Google\Cloud\Storage\Control\V2\ManagedFolder;

/**
 * @param string $formattedName Name of the managed folder.
 *                              Format:
 *                              `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
 *                              Please see {@see StorageControlClient::managedFolderName()} for help formatting this field.
 */
function get_managed_folder_sample(string $formattedName): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $request = (new GetManagedFolderRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var ManagedFolder $response */
        $response = $storageControlClient->getManagedFolder($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 = StorageControlClient::managedFolderName(
        '[PROJECT]',
        '[BUCKET]',
        '[MANAGED_FOLDER]'
    );

    get_managed_folder_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\GetStorageLayoutRequest;
use Google\Cloud\Storage\Control\V2\StorageLayout;

/**
 * @param string $formattedName The name of the StorageLayout resource.
 *                              Format: `projects/{project}/buckets/{bucket}/storageLayout`
 *                              Please see {@see StorageControlClient::storageLayoutName()} for help formatting this field.
 */
function get_storage_layout_sample(string $formattedName): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $request = (new GetStorageLayoutRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var StorageLayout $response */
        $response = $storageControlClient->getStorageLayout($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 = StorageControlClient::storageLayoutName('[PROJECT]', '[BUCKET]');

    get_storage_layout_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\Folder;
use Google\Cloud\Storage\Control\V2\ListFoldersRequest;

/**
 * @param string $formattedParent Name of the bucket in which to look for folders. The bucket must
 *                                be a hierarchical namespace enabled bucket. Please see
 *                                {@see StorageControlClient::bucketName()} for help formatting this field.
 */
function list_folders_sample(string $formattedParent): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $request = (new ListFoldersRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $storageControlClient->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
{
    $formattedParent = StorageControlClient::bucketName('[PROJECT]', '[BUCKET]');

    list_folders_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\ListManagedFoldersRequest;
use Google\Cloud\Storage\Control\V2\ManagedFolder;

/**
 * @param string $formattedParent Name of the bucket this managed folder belongs to. Please see
 *                                {@see StorageControlClient::bucketName()} for help formatting this field.
 */
function list_managed_folders_sample(string $formattedParent): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $request = (new ListManagedFoldersRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $storageControlClient->listManagedFolders($request);

        /** @var ManagedFolder $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
{
    $formattedParent = StorageControlClient::bucketName('[PROJECT]', '[BUCKET]');

    list_managed_folders_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Storage\Control\V2\Client\StorageControlClient;
use Google\Cloud\Storage\Control\V2\Folder;
use Google\Cloud\Storage\Control\V2\RenameFolderRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName       Name of the source folder being renamed.
 *                                    Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
 *                                    Please see {@see StorageControlClient::folderName()} for help formatting this field.
 * @param string $destinationFolderId The destination folder ID, e.g. `foo/bar/`.
 */
function rename_folder_sample(string $formattedName, string $destinationFolderId): void
{
    // Create a client.
    $storageControlClient = new StorageControlClient();

    // Prepare the request message.
    $request = (new RenameFolderRequest())
        ->setName($formattedName)
        ->setDestinationFolderId($destinationFolderId);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $storageControlClient->renameFolder($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 = StorageControlClient::folderName('[PROJECT]', '[BUCKET]', '[FOLDER]');
    $destinationFolderId = '[DESTINATION_FOLDER_ID]';

    rename_folder_sample($formattedName, $destinationFolderId);
}