Google Cloud Security Compliance V1 Client - Class DeploymentClient (0.1.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\DeploymentClient;
use Google\Cloud\CloudSecurityCompliance\V1\CloudControlDetails;
use Google\Cloud\CloudSecurityCompliance\V1\CloudControlMetadata;
use Google\Cloud\CloudSecurityCompliance\V1\CreateFrameworkDeploymentRequest;
use Google\Cloud\CloudSecurityCompliance\V1\EnforcementMode;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkDeployment;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkReference;
use Google\Cloud\CloudSecurityCompliance\V1\TargetResourceConfig;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                                                           The parent resource of the FrameworkDeployment in the format:
 *                                                                                          organizations/{organization}/locations/{location}
 *                                                                                          Only global location is supported. Please see
 *                                                                                          {@see DeploymentClient::organizationLocationName()} for help formatting this field.
 * @param string $frameworkDeploymentFrameworkFramework                                     In the format:
 *                                                                                          organizations/{org}/locations/{location}/frameworks/{framework}
 * @param string $frameworkDeploymentCloudControlMetadataCloudControlDetailsName            The name of the CloudControl in the format:
 *                                                                                          “organizations/{organization}/locations/{location}/
 *                                                                                          cloudControls/{cloud-control}”
 * @param int    $frameworkDeploymentCloudControlMetadataCloudControlDetailsMajorRevisionId Major revision of cloudcontrol
 * @param int    $frameworkDeploymentCloudControlMetadataEnforcementMode                    Enforcement mode of the cloud control
 */
function create_framework_deployment_sample(
    string $formattedParent,
    string $frameworkDeploymentFrameworkFramework,
    string $frameworkDeploymentCloudControlMetadataCloudControlDetailsName,
    int $frameworkDeploymentCloudControlMetadataCloudControlDetailsMajorRevisionId,
    int $frameworkDeploymentCloudControlMetadataEnforcementMode
): void {
    // Create a client.
    $deploymentClient = new DeploymentClient();

    // Prepare the request message.
    $frameworkDeploymentTargetResourceConfig = new TargetResourceConfig();
    $frameworkDeploymentFramework = (new FrameworkReference())
        ->setFramework($frameworkDeploymentFrameworkFramework);
    $frameworkDeploymentCloudControlMetadataCloudControlDetails = (new CloudControlDetails())
        ->setName($frameworkDeploymentCloudControlMetadataCloudControlDetailsName)
        ->setMajorRevisionId($frameworkDeploymentCloudControlMetadataCloudControlDetailsMajorRevisionId);
    $cloudControlMetadata = (new CloudControlMetadata())
        ->setCloudControlDetails($frameworkDeploymentCloudControlMetadataCloudControlDetails)
        ->setEnforcementMode($frameworkDeploymentCloudControlMetadataEnforcementMode);
    $frameworkDeploymentCloudControlMetadata = [$cloudControlMetadata,];
    $frameworkDeployment = (new FrameworkDeployment())
        ->setTargetResourceConfig($frameworkDeploymentTargetResourceConfig)
        ->setFramework($frameworkDeploymentFramework)
        ->setCloudControlMetadata($frameworkDeploymentCloudControlMetadata);
    $request = (new CreateFrameworkDeploymentRequest())
        ->setParent($formattedParent)
        ->setFrameworkDeployment($frameworkDeployment);

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

        if ($response->operationSucceeded()) {
            /** @var FrameworkDeployment $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 = DeploymentClient::organizationLocationName('[ORGANIZATION]', '[LOCATION]');
    $frameworkDeploymentFrameworkFramework = '[FRAMEWORK]';
    $frameworkDeploymentCloudControlMetadataCloudControlDetailsName = '[NAME]';
    $frameworkDeploymentCloudControlMetadataCloudControlDetailsMajorRevisionId = 0;
    $frameworkDeploymentCloudControlMetadataEnforcementMode = EnforcementMode::ENFORCEMENT_MODE_UNSPECIFIED;

    create_framework_deployment_sample(
        $formattedParent,
        $frameworkDeploymentFrameworkFramework,
        $frameworkDeploymentCloudControlMetadataCloudControlDetailsName,
        $frameworkDeploymentCloudControlMetadataCloudControlDetailsMajorRevisionId,
        $frameworkDeploymentCloudControlMetadataEnforcementMode
    );
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\DeploymentClient;
use Google\Cloud\CloudSecurityCompliance\V1\DeleteFrameworkDeploymentRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName name of the FrameworkDeployment to be deleted in the following
 *                              format:
 *                              organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}
 *                              Please see {@see DeploymentClient::frameworkDeploymentName()} for help formatting this field.
 */
function delete_framework_deployment_sample(string $formattedName): void
{
    // Create a client.
    $deploymentClient = new DeploymentClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $deploymentClient->deleteFrameworkDeployment($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 = DeploymentClient::frameworkDeploymentName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[FRAMEWORK_DEPLOYMENT]'
    );

    delete_framework_deployment_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\DeploymentClient;
use Google\Cloud\CloudSecurityCompliance\V1\CloudControlDeployment;
use Google\Cloud\CloudSecurityCompliance\V1\GetCloudControlDeploymentRequest;

/**
 * @param string $formattedName CloudControlDeployment name in the following format:
 *                              organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}
 *                              Please see {@see DeploymentClient::cloudControlDeploymentName()} for help formatting this field.
 */
function get_cloud_control_deployment_sample(string $formattedName): void
{
    // Create a client.
    $deploymentClient = new DeploymentClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var CloudControlDeployment $response */
        $response = $deploymentClient->getCloudControlDeployment($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 = DeploymentClient::cloudControlDeploymentName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[CLOUD_CONTROL_DEPLOYMENT]'
    );

    get_cloud_control_deployment_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\DeploymentClient;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkDeployment;
use Google\Cloud\CloudSecurityCompliance\V1\GetFrameworkDeploymentRequest;

/**
 * @param string $formattedName FrameworkDeployment name in the following format:
 *                              organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}
 *                              Please see {@see DeploymentClient::frameworkDeploymentName()} for help formatting this field.
 */
function get_framework_deployment_sample(string $formattedName): void
{
    // Create a client.
    $deploymentClient = new DeploymentClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var FrameworkDeployment $response */
        $response = $deploymentClient->getFrameworkDeployment($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 = DeploymentClient::frameworkDeploymentName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[FRAMEWORK_DEPLOYMENT]'
    );

    get_framework_deployment_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\DeploymentClient;
use Google\Cloud\CloudSecurityCompliance\V1\CloudControlDeployment;
use Google\Cloud\CloudSecurityCompliance\V1\ListCloudControlDeploymentsRequest;

/**
 * @param string $formattedParent parent resource of the CloudControlDeployment in the format:
 *                                organizations/{organization}/locations/{location}
 *                                Only global location is supported. Please see
 *                                {@see DeploymentClient::organizationLocationName()} for help formatting this field.
 */
function list_cloud_control_deployments_sample(string $formattedParent): void
{
    // Create a client.
    $deploymentClient = new DeploymentClient();

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

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

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

    list_cloud_control_deployments_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\DeploymentClient;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkDeployment;
use Google\Cloud\CloudSecurityCompliance\V1\ListFrameworkDeploymentsRequest;

/**
 * @param string $formattedParent parent resource of the FrameworkDeployment in the format:
 *                                organizations/{organization}/locations/{location}
 *                                Only global location is supported. Please see
 *                                {@see DeploymentClient::organizationLocationName()} for help formatting this field.
 */
function list_framework_deployments_sample(string $formattedParent): void
{
    // Create a client.
    $deploymentClient = new DeploymentClient();

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

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

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

    list_framework_deployments_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\DeploymentClient;
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.
    $deploymentClient = new DeploymentClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $deploymentClient->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\CloudSecurityCompliance\V1\Client\DeploymentClient;
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.
    $deploymentClient = new DeploymentClient();

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

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