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

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\AuditClient;
use Google\Cloud\CloudSecurityCompliance\V1\CreateFrameworkAuditRequest;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkAudit;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkAuditDestination;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent resource where this framework audit is created.
 *
 *                                Supported formats are the following:
 *
 *                                * `organizations/{organization_id}/locations/{location}`
 *                                * `folders/{folder_id}/locations/{location}`
 *                                * `projects/{project_id}/locations/{location}`
 *                                Please see {@see AuditClient::organizationLocationName()} for help formatting this field.
 */
function create_framework_audit_sample(string $formattedParent): void
{
    // Create a client.
    $auditClient = new AuditClient();

    // Prepare the request message.
    $frameworkAuditFrameworkAuditDestination = new FrameworkAuditDestination();
    $frameworkAudit = (new FrameworkAudit())
        ->setFrameworkAuditDestination($frameworkAuditFrameworkAuditDestination);
    $request = (new CreateFrameworkAuditRequest())
        ->setParent($formattedParent)
        ->setFrameworkAudit($frameworkAudit);

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

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

    create_framework_audit_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\AuditClient;
use Google\Cloud\CloudSecurityCompliance\V1\GenerateFrameworkAuditScopeReportRequest;
use Google\Cloud\CloudSecurityCompliance\V1\GenerateFrameworkAuditScopeReportRequest\Format;
use Google\Cloud\CloudSecurityCompliance\V1\GenerateFrameworkAuditScopeReportResponse;

/**
 * @param string $scope               The organization, folder or project for the audit report.
 *
 *                                    Supported formats are the following:
 *
 *                                    * `projects/{project_id}/locations/{location}`
 *                                    * `folders/{folder_id}/locations/{location}`
 *                                    * `organizations/{organization_id}/locations/{location}`
 * @param int    $reportFormat        The format that the scope report bytes is returned in.
 * @param string $complianceFramework The compliance framework that the scope report is generated for.
 */
function generate_framework_audit_scope_report_sample(
    string $scope,
    int $reportFormat,
    string $complianceFramework
): void {
    // Create a client.
    $auditClient = new AuditClient();

    // Prepare the request message.
    $request = (new GenerateFrameworkAuditScopeReportRequest())
        ->setScope($scope)
        ->setReportFormat($reportFormat)
        ->setComplianceFramework($complianceFramework);

    // Call the API and handle any network failures.
    try {
        /** @var GenerateFrameworkAuditScopeReportResponse $response */
        $response = $auditClient->generateFrameworkAuditScopeReport($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
{
    $scope = '[SCOPE]';
    $reportFormat = Format::FORMAT_UNSPECIFIED;
    $complianceFramework = '[COMPLIANCE_FRAMEWORK]';

    generate_framework_audit_scope_report_sample($scope, $reportFormat, $complianceFramework);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\AuditClient;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkAudit;
use Google\Cloud\CloudSecurityCompliance\V1\GetFrameworkAuditRequest;

/**
 * @param string $formattedName The name of the framework audit to retrieve.
 *
 *                              Supported formats are the following:
 *
 *                              * `organizations/{organization_id}/locations/{location}/frameworkAudits/{frameworkAuditName}`
 *                              * `folders/{folder_id}/locations/{location}/frameworkAudits/{frameworkAuditName}`
 *                              * `projects/{project_id}/locations/{location}/frameworkAudits/{frameworkAuditName}`
 *                              Please see {@see AuditClient::frameworkAuditName()} for help formatting this field.
 */
function get_framework_audit_sample(string $formattedName): void
{
    // Create a client.
    $auditClient = new AuditClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var FrameworkAudit $response */
        $response = $auditClient->getFrameworkAudit($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 = AuditClient::frameworkAuditName('[PROJECT]', '[LOCATION]', '[FRAMEWORK_AUDIT]');

    get_framework_audit_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\AuditClient;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkAudit;
use Google\Cloud\CloudSecurityCompliance\V1\ListFrameworkAuditsRequest;

/**
 * @param string $formattedParent The parent resource where the framework audits are listed.
 *
 *                                Supported formats are the following:
 *
 *                                * `organizations/{organization_id}/locations/{location}`
 *                                * `folders/{folder_id}/locations/{location}`
 *                                * `projects/{project_id}/locations/{location}`
 *                                Please see {@see AuditClient::organizationLocationName()} for help formatting this field.
 */
function list_framework_audits_sample(string $formattedParent): void
{
    // Create a client.
    $auditClient = new AuditClient();

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

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

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

    list_framework_audits_sample($formattedParent);
} 

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

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

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

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

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