Cloud KMS V1 Client - Class EkmServiceClient (2.1.6)

use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;
use Google\Cloud\Kms\V1\CreateEkmConnectionRequest;
use Google\Cloud\Kms\V1\EkmConnection;

/**
 * @param string $formattedParent The resource name of the location associated with the
 *                                [EkmConnection][google.cloud.kms.v1.EkmConnection], in the format
 *                                `projects/*/locations/*`. Please see
 *                                {@see EkmServiceClient::locationName()} for help formatting this field.
 * @param string $ekmConnectionId It must be unique within a location and match the regular
 *                                expression `[a-zA-Z0-9_-]{1,63}`.
 */
function create_ekm_connection_sample(string $formattedParent, string $ekmConnectionId): void
{
    // Create a client.
    $ekmServiceClient = new EkmServiceClient();

    // Prepare the request message.
    $ekmConnection = new EkmConnection();
    $request = (new CreateEkmConnectionRequest())
        ->setParent($formattedParent)
        ->setEkmConnectionId($ekmConnectionId)
        ->setEkmConnection($ekmConnection);

    // Call the API and handle any network failures.
    try {
        /** @var EkmConnection $response */
        $response = $ekmServiceClient->createEkmConnection($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 = EkmServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $ekmConnectionId = '[EKM_CONNECTION_ID]';

    create_ekm_connection_sample($formattedParent, $ekmConnectionId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;
use Google\Cloud\Kms\V1\EkmConfig;
use Google\Cloud\Kms\V1\GetEkmConfigRequest;

/**
 * @param string $formattedName The [name][google.cloud.kms.v1.EkmConfig.name] of the
 *                              [EkmConfig][google.cloud.kms.v1.EkmConfig] to get. Please see
 *                              {@see EkmServiceClient::ekmConfigName()} for help formatting this field.
 */
function get_ekm_config_sample(string $formattedName): void
{
    // Create a client.
    $ekmServiceClient = new EkmServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var EkmConfig $response */
        $response = $ekmServiceClient->getEkmConfig($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 = EkmServiceClient::ekmConfigName('[PROJECT]', '[LOCATION]');

    get_ekm_config_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;
use Google\Cloud\Kms\V1\EkmConnection;
use Google\Cloud\Kms\V1\GetEkmConnectionRequest;

/**
 * @param string $formattedName The [name][google.cloud.kms.v1.EkmConnection.name] of the
 *                              [EkmConnection][google.cloud.kms.v1.EkmConnection] to get. Please see
 *                              {@see EkmServiceClient::ekmConnectionName()} for help formatting this field.
 */
function get_ekm_connection_sample(string $formattedName): void
{
    // Create a client.
    $ekmServiceClient = new EkmServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var EkmConnection $response */
        $response = $ekmServiceClient->getEkmConnection($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 = EkmServiceClient::ekmConnectionName('[PROJECT]', '[LOCATION]', '[EKM_CONNECTION]');

    get_ekm_connection_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;
use Google\Cloud\Kms\V1\EkmConnection;
use Google\Cloud\Kms\V1\ListEkmConnectionsRequest;

/**
 * @param string $formattedParent The resource name of the location associated with the
 *                                [EkmConnections][google.cloud.kms.v1.EkmConnection] to list, in the format
 *                                `projects/*/locations/*`. Please see
 *                                {@see EkmServiceClient::locationName()} for help formatting this field.
 */
function list_ekm_connections_sample(string $formattedParent): void
{
    // Create a client.
    $ekmServiceClient = new EkmServiceClient();

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

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

        /** @var EkmConnection $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 = EkmServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_ekm_connections_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;
use Google\Cloud\Kms\V1\EkmConfig;
use Google\Cloud\Kms\V1\UpdateEkmConfigRequest;
use Google\Protobuf\FieldMask;

/**
 * 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_ekm_config_sample(): void
{
    // Create a client.
    $ekmServiceClient = new EkmServiceClient();

    // Prepare the request message.
    $ekmConfig = new EkmConfig();
    $updateMask = new FieldMask();
    $request = (new UpdateEkmConfigRequest())
        ->setEkmConfig($ekmConfig)
        ->setUpdateMask($updateMask);

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

use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;
use Google\Cloud\Kms\V1\EkmConnection;
use Google\Cloud\Kms\V1\UpdateEkmConnectionRequest;
use Google\Protobuf\FieldMask;

/**
 * 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_ekm_connection_sample(): void
{
    // Create a client.
    $ekmServiceClient = new EkmServiceClient();

    // Prepare the request message.
    $ekmConnection = new EkmConnection();
    $updateMask = new FieldMask();
    $request = (new UpdateEkmConnectionRequest())
        ->setEkmConnection($ekmConnection)
        ->setUpdateMask($updateMask);

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

use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;
use Google\Cloud\Kms\V1\VerifyConnectivityRequest;
use Google\Cloud\Kms\V1\VerifyConnectivityResponse;

/**
 * @param string $formattedName The [name][google.cloud.kms.v1.EkmConnection.name] of the
 *                              [EkmConnection][google.cloud.kms.v1.EkmConnection] to verify. Please see
 *                              {@see EkmServiceClient::ekmConnectionName()} for help formatting this field.
 */
function verify_connectivity_sample(string $formattedName): void
{
    // Create a client.
    $ekmServiceClient = new EkmServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var VerifyConnectivityResponse $response */
        $response = $ekmServiceClient->verifyConnectivity($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 = EkmServiceClient::ekmConnectionName('[PROJECT]', '[LOCATION]', '[EKM_CONNECTION]');

    verify_connectivity_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $ekmServiceClient = new EkmServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

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

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $ekmServiceClient = new EkmServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

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

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;

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

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $ekmServiceClient->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);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;

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

    // 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 = $ekmServiceClient->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);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Kms\V1\Client\EkmServiceClient;

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

    // 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 = $ekmServiceClient->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);
}