Google Cloud Security Compliance V1 Client - Class ConfigClient (0.2.0)

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\CloudControl;
use Google\Cloud\CloudSecurityCompliance\V1\CreateCloudControlRequest;

/**
 * @param string $formattedParent  The parent resource name, in the format
 *                                 `organizations/{organization}/locations/{location}`.
 *                                 The only supported location is `global`. Please see
 *                                 {@see ConfigClient::organizationLocationName()} for help formatting this field.
 * @param string $cloudControlId   The identifier for the cloud control, which is the last segment
 *                                 of the cloud control name. The format is
 *                                 `^[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$`.
 * @param string $cloudControlName Identifier. The name of the cloud control, in the format
 *                                 `organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id}`.
 *                                 The only supported location is `global`.
 */
function create_cloud_control_sample(
    string $formattedParent,
    string $cloudControlId,
    string $cloudControlName
): void {
    // Create a client.
    $configClient = new ConfigClient();

    // Prepare the request message.
    $cloudControl = (new CloudControl())
        ->setName($cloudControlName);
    $request = (new CreateCloudControlRequest())
        ->setParent($formattedParent)
        ->setCloudControlId($cloudControlId)
        ->setCloudControl($cloudControl);

    // Call the API and handle any network failures.
    try {
        /** @var CloudControl $response */
        $response = $configClient->createCloudControl($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 = ConfigClient::organizationLocationName('[ORGANIZATION]', '[LOCATION]');
    $cloudControlId = '[CLOUD_CONTROL_ID]';
    $cloudControlName = '[NAME]';

    create_cloud_control_sample($formattedParent, $cloudControlId, $cloudControlName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\CreateFrameworkRequest;
use Google\Cloud\CloudSecurityCompliance\V1\Framework;

/**
 * @param string $formattedParent The parent resource name, in the format
 *                                `organizations/{organization}/locations/{location}`.
 *                                The only supported location is `global`. Please see
 *                                {@see ConfigClient::organizationLocationName()} for help formatting this field.
 * @param string $frameworkId     The identifier (ID) of the framework. The ID is not the full name
 *                                of the framework; it's the last part of the full name of the framework.
 * @param string $frameworkName   Identifier. The name of the framework, in the format
 *                                `organizations/{organization}/locations/{location}/frameworks/{framework_id}`.
 *                                The only supported location is `global`.
 */
function create_framework_sample(
    string $formattedParent,
    string $frameworkId,
    string $frameworkName
): void {
    // Create a client.
    $configClient = new ConfigClient();

    // Prepare the request message.
    $framework = (new Framework())
        ->setName($frameworkName);
    $request = (new CreateFrameworkRequest())
        ->setParent($formattedParent)
        ->setFrameworkId($frameworkId)
        ->setFramework($framework);

    // Call the API and handle any network failures.
    try {
        /** @var Framework $response */
        $response = $configClient->createFramework($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 = ConfigClient::organizationLocationName('[ORGANIZATION]', '[LOCATION]');
    $frameworkId = '[FRAMEWORK_ID]';
    $frameworkName = '[NAME]';

    create_framework_sample($formattedParent, $frameworkId, $frameworkName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\DeleteCloudControlRequest;

/**
 * @param string $formattedName The name of the cloud control to delete, in the format
 *                              `organizations/{organization}/locations/{location}/CloudControls/{CloudControl}`.
 *                              The only supported location is `global`. Please see
 *                              {@see ConfigClient::cloudControlName()} for help formatting this field.
 */
function delete_cloud_control_sample(string $formattedName): void
{
    // Create a client.
    $configClient = new ConfigClient();

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

    // Call the API and handle any network failures.
    try {
        $configClient->deleteCloudControl($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 = ConfigClient::cloudControlName('[ORGANIZATION]', '[LOCATION]', '[CLOUD_CONTROL]');

    delete_cloud_control_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\DeleteFrameworkRequest;

/**
 * @param string $formattedName The name of the resource, in the format
 *                              `organizations/{organization}/locations/{location}/frameworks/{framework}`.
 *                              The only supported location is `global`. Please see
 *                              {@see ConfigClient::frameworkName()} for help formatting this field.
 */
function delete_framework_sample(string $formattedName): void
{
    // Create a client.
    $configClient = new ConfigClient();

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

    // Call the API and handle any network failures.
    try {
        $configClient->deleteFramework($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 = ConfigClient::frameworkName('[ORGANIZATION]', '[LOCATION]', '[FRAMEWORK]');

    delete_framework_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\CloudControl;
use Google\Cloud\CloudSecurityCompliance\V1\GetCloudControlRequest;

/**
 * @param string $formattedName The name of the cloud control to retrieve, in the format
 *                              `organizations/{organization}/locations/{location}/cloudControls/{cloud_control}`.
 *                              The only supported location is `global`. Please see
 *                              {@see ConfigClient::cloudControlName()} for help formatting this field.
 */
function get_cloud_control_sample(string $formattedName): void
{
    // Create a client.
    $configClient = new ConfigClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var CloudControl $response */
        $response = $configClient->getCloudControl($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 = ConfigClient::cloudControlName('[ORGANIZATION]', '[LOCATION]', '[CLOUD_CONTROL]');

    get_cloud_control_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\Framework;
use Google\Cloud\CloudSecurityCompliance\V1\GetFrameworkRequest;

/**
 * @param string $formattedName The name of the framework to retrieve, in the format
 *                              `organizations/{organization}/locations/{location}/frameworks/{framework_id}`
 *                              The only supported location is `global`. Please see
 *                              {@see ConfigClient::frameworkName()} for help formatting this field.
 */
function get_framework_sample(string $formattedName): void
{
    // Create a client.
    $configClient = new ConfigClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Framework $response */
        $response = $configClient->getFramework($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 = ConfigClient::frameworkName('[ORGANIZATION]', '[LOCATION]', '[FRAMEWORK]');

    get_framework_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\CloudControl;
use Google\Cloud\CloudSecurityCompliance\V1\ListCloudControlsRequest;

/**
 * @param string $formattedParent The parent resource name, in the format
 *                                `organizations/{organization}/locations/{location}`.
 *                                The only supported location is `global`. Please see
 *                                {@see ConfigClient::organizationLocationName()} for help formatting this field.
 */
function list_cloud_controls_sample(string $formattedParent): void
{
    // Create a client.
    $configClient = new ConfigClient();

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

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

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

    list_cloud_controls_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\Framework;
use Google\Cloud\CloudSecurityCompliance\V1\ListFrameworksRequest;

/**
 * @param string $formattedParent The parent resource name, in the format
 *                                `organizations/{organization}/locations/{location}`.
 *                                The only supported location is `global`. Please see
 *                                {@see ConfigClient::organizationLocationName()} for help formatting this field.
 */
function list_frameworks_sample(string $formattedParent): void
{
    // Create a client.
    $configClient = new ConfigClient();

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

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

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

    list_frameworks_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\CloudControl;
use Google\Cloud\CloudSecurityCompliance\V1\UpdateCloudControlRequest;

/**
 * @param string $cloudControlName Identifier. The name of the cloud control, in the format
 *                                 `organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id}`.
 *                                 The only supported location is `global`.
 */
function update_cloud_control_sample(string $cloudControlName): void
{
    // Create a client.
    $configClient = new ConfigClient();

    // Prepare the request message.
    $cloudControl = (new CloudControl())
        ->setName($cloudControlName);
    $request = (new UpdateCloudControlRequest())
        ->setCloudControl($cloudControl);

    // Call the API and handle any network failures.
    try {
        /** @var CloudControl $response */
        $response = $configClient->updateCloudControl($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
{
    $cloudControlName = '[NAME]';

    update_cloud_control_sample($cloudControlName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\ConfigClient;
use Google\Cloud\CloudSecurityCompliance\V1\Framework;
use Google\Cloud\CloudSecurityCompliance\V1\UpdateFrameworkRequest;

/**
 * @param string $frameworkName Identifier. The name of the framework, in the format
 *                              `organizations/{organization}/locations/{location}/frameworks/{framework_id}`.
 *                              The only supported location is `global`.
 */
function update_framework_sample(string $frameworkName): void
{
    // Create a client.
    $configClient = new ConfigClient();

    // Prepare the request message.
    $framework = (new Framework())
        ->setName($frameworkName);
    $request = (new UpdateFrameworkRequest())
        ->setFramework($framework);

    // Call the API and handle any network failures.
    try {
        /** @var Framework $response */
        $response = $configClient->updateFramework($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
{
    $frameworkName = '[NAME]';

    update_framework_sample($frameworkName);
}

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

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

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

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

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