Google Cloud Iam V3 Client - Class AccessPoliciesClient (1.5.3)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Iam\V3\AccessPolicy;
use Google\Cloud\Iam\V3\Client\AccessPoliciesClient;
use Google\Cloud\Iam\V3\CreateAccessPolicyRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent resource where this access policy will be created.
 *
 *                                Format:
 *                                `projects/{project_id}/locations/{location}`
 *                                `projects/{project_number}/locations/{location}`
 *                                `folders/{folder_id}/locations/{location}`
 *                                `organizations/{organization_id}/locations/{location}`
 *                                Please see {@see AccessPoliciesClient::organizationLocationName()} for help formatting this field.
 * @param string $accessPolicyId  The ID to use for the access policy, which
 *                                will become the final component of the access policy's
 *                                resource name.
 *
 *                                This value must start with a lowercase letter followed by up to 62
 *                                lowercase letters, numbers, hyphens, or dots. Pattern,
 *                                /[a-z][a-z0-9-\.]{2,62}/.
 *
 *                                This value must be unique among all access policies with the same parent.
 */
function create_access_policy_sample(string $formattedParent, string $accessPolicyId): void
{
    // Create a client.
    $accessPoliciesClient = new AccessPoliciesClient();

    // Prepare the request message.
    $accessPolicy = new AccessPolicy();
    $request = (new CreateAccessPolicyRequest())
        ->setParent($formattedParent)
        ->setAccessPolicyId($accessPolicyId)
        ->setAccessPolicy($accessPolicy);

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

        if ($response->operationSucceeded()) {
            /** @var AccessPolicy $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
{
    $formattedParent = AccessPoliciesClient::organizationLocationName('[ORGANIZATION]', '[LOCATION]');
    $accessPolicyId = '[ACCESS_POLICY_ID]';

    create_access_policy_sample($formattedParent, $accessPolicyId);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Iam\V3\Client\AccessPoliciesClient;
use Google\Cloud\Iam\V3\DeleteAccessPolicyRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the access policy to delete.
 *
 *                              Format:
 *                              `projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              `projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              `folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              `organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              Please see {@see AccessPoliciesClient::accessPolicyName()} for help formatting this field.
 */
function delete_access_policy_sample(string $formattedName): void
{
    // Create a client.
    $accessPoliciesClient = new AccessPoliciesClient();

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

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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 = AccessPoliciesClient::accessPolicyName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[ACCESS_POLICY]'
    );

    delete_access_policy_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V3\AccessPolicy;
use Google\Cloud\Iam\V3\Client\AccessPoliciesClient;
use Google\Cloud\Iam\V3\GetAccessPolicyRequest;

/**
 * @param string $formattedName The name of the access policy to retrieve.
 *
 *                              Format:
 *                              `projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              `projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              `folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              `organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              Please see {@see AccessPoliciesClient::accessPolicyName()} for help formatting this field.
 */
function get_access_policy_sample(string $formattedName): void
{
    // Create a client.
    $accessPoliciesClient = new AccessPoliciesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AccessPolicy $response */
        $response = $accessPoliciesClient->getAccessPolicy($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 = AccessPoliciesClient::accessPolicyName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[ACCESS_POLICY]'
    );

    get_access_policy_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Iam\V3\AccessPolicy;
use Google\Cloud\Iam\V3\Client\AccessPoliciesClient;
use Google\Cloud\Iam\V3\ListAccessPoliciesRequest;

/**
 * @param string $formattedParent The parent resource, which owns the collection of access policy
 *                                resources.
 *
 *                                Format:
 *                                `projects/{project_id}/locations/{location}`
 *                                `projects/{project_number}/locations/{location}`
 *                                `folders/{folder_id}/locations/{location}`
 *                                `organizations/{organization_id}/locations/{location}`
 *                                Please see {@see AccessPoliciesClient::organizationLocationName()} for help formatting this field.
 */
function list_access_policies_sample(string $formattedParent): void
{
    // Create a client.
    $accessPoliciesClient = new AccessPoliciesClient();

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

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

        /** @var AccessPolicy $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 = AccessPoliciesClient::organizationLocationName('[ORGANIZATION]', '[LOCATION]');

    list_access_policies_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Iam\V3\Client\AccessPoliciesClient;
use Google\Cloud\Iam\V3\PolicyBinding;
use Google\Cloud\Iam\V3\SearchAccessPolicyBindingsRequest;

/**
 * @param string $formattedName The name of the access policy.
 *                              Format:
 *                              `organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              `folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              `projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              `projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}`
 *                              Please see {@see AccessPoliciesClient::accessPolicyName()} for help formatting this field.
 */
function search_access_policy_bindings_sample(string $formattedName): void
{
    // Create a client.
    $accessPoliciesClient = new AccessPoliciesClient();

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

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

        /** @var PolicyBinding $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
{
    $formattedName = AccessPoliciesClient::accessPolicyName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[ACCESS_POLICY]'
    );

    search_access_policy_bindings_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Iam\V3\AccessPolicy;
use Google\Cloud\Iam\V3\Client\AccessPoliciesClient;
use Google\Cloud\Iam\V3\UpdateAccessPolicyRequest;
use Google\Rpc\Status;

/**
 * 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 update_access_policy_sample(): void
{
    // Create a client.
    $accessPoliciesClient = new AccessPoliciesClient();

    // Prepare the request message.
    $accessPolicy = new AccessPolicy();
    $request = (new UpdateAccessPolicyRequest())
        ->setAccessPolicy($accessPolicy);

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

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