Google Cloud Resource Manager V3 Client - Class TagKeysClient (0.3.9)

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\TagKey;
use Google\Cloud\ResourceManager\V3\TagKeysClient;
use Google\Rpc\Status;

/**
 * @param string $tagKeyShortName Immutable. The user friendly name for a TagKey. The short name should be
 *                                unique for TagKeys within the same tag namespace.
 *
 *                                The short name must be 1-63 characters, beginning and ending with
 *                                an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_),
 *                                dots (.), and alphanumerics between.
 */
function create_tag_key_sample(string $tagKeyShortName): void
{
    // Create a client.
    $tagKeysClient = new TagKeysClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $tagKey = (new TagKey())
        ->setShortName($tagKeyShortName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $tagKeysClient->createTagKey($tagKey);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var TagKey $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());
    }
}

/**
 * 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
{
    $tagKeyShortName = '[SHORT_NAME]';

    create_tag_key_sample($tagKeyShortName);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\TagKey;
use Google\Cloud\ResourceManager\V3\TagKeysClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of a TagKey to be deleted in the format `tagKeys/123`.
 *                              The TagKey cannot be a parent of any existing TagValues or it will not be
 *                              deleted successfully. Please see
 *                              {@see TagKeysClient::tagKeyName()} for help formatting this field.
 */
function delete_tag_key_sample(string $formattedName): void
{
    // Create a client.
    $tagKeysClient = new TagKeysClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $tagKeysClient->deleteTagKey($formattedName);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var TagKey $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());
    }
}

/**
 * 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 = TagKeysClient::tagKeyName('[TAG_KEY]');

    delete_tag_key_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\ResourceManager\V3\TagKeysClient;

/**
 * @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.
    $tagKeysClient = new TagKeysClient();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $tagKeysClient->getIamPolicy($resource);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\ResourceManager\V3\TagKey;
use Google\Cloud\ResourceManager\V3\TagKeysClient;

/**
 * @param string $formattedName A resource name in the format `tagKeys/{id}`, such as
 *                              `tagKeys/123`. Please see
 *                              {@see TagKeysClient::tagKeyName()} for help formatting this field.
 */
function get_tag_key_sample(string $formattedName): void
{
    // Create a client.
    $tagKeysClient = new TagKeysClient();

    // Call the API and handle any network failures.
    try {
        /** @var TagKey $response */
        $response = $tagKeysClient->getTagKey($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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 = TagKeysClient::tagKeyName('[TAG_KEY]');

    get_tag_key_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ResourceManager\V3\TagKey;
use Google\Cloud\ResourceManager\V3\TagKeysClient;

/**
 * @param string $parent The resource name of the new TagKey's parent.
 *                       Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
 */
function list_tag_keys_sample(string $parent): void
{
    // Create a client.
    $tagKeysClient = new TagKeysClient();

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

        /** @var TagKey $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());
    }
}

/**
 * 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_tag_keys_sample($parent);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\ResourceManager\V3\TagKeysClient;

/**
 * @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.
    $tagKeysClient = new TagKeysClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $policy = new Policy();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $tagKeysClient->setIamPolicy($resource, $policy);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\ResourceManager\V3\TagKeysClient;

/**
 * @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.
    $tagKeysClient = new TagKeysClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $permissions = [$permissionsElement,];

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $tagKeysClient->testIamPermissions($resource, $permissions);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\TagKey;
use Google\Cloud\ResourceManager\V3\TagKeysClient;
use Google\Rpc\Status;

/**
 * @param string $tagKeyShortName Immutable. The user friendly name for a TagKey. The short name should be
 *                                unique for TagKeys within the same tag namespace.
 *
 *                                The short name must be 1-63 characters, beginning and ending with
 *                                an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_),
 *                                dots (.), and alphanumerics between.
 */
function update_tag_key_sample(string $tagKeyShortName): void
{
    // Create a client.
    $tagKeysClient = new TagKeysClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $tagKey = (new TagKey())
        ->setShortName($tagKeyShortName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $tagKeysClient->updateTagKey($tagKey);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var TagKey $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());
    }
}

/**
 * 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
{
    $tagKeyShortName = '[SHORT_NAME]';

    update_tag_key_sample($tagKeyShortName);
}