Google Cloud Dataplex V1 Client - Class DataScanServiceClient (0.11.1)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Dataplex\V1\CreateDataScanRequest;
use Google\Cloud\Dataplex\V1\DataScan;
use Google\Cloud\Dataplex\V1\DataSource;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The resource name of the parent location:
 *                                `projects/{project}/locations/{location_id}`
 *                                where `project` refers to a *project_id* or *project_number* and
 *                                `location_id` refers to a GCP region. Please see
 *                                {@see DataScanServiceClient::locationName()} for help formatting this field.
 * @param string $dataScanId      DataScan identifier.
 *
 *                                * Must contain only lowercase letters, numbers and hyphens.
 *                                * Must start with a letter.
 *                                * Must end with a number or a letter.
 *                                * Must be between 1-63 characters.
 *                                * Must be unique within the customer project / location.
 */
function create_data_scan_sample(string $formattedParent, string $dataScanId): void
{
    // Create a client.
    $dataScanServiceClient = new DataScanServiceClient();

    // Prepare the request message.
    $dataScanData = new DataSource();
    $dataScan = (new DataScan())
        ->setData($dataScanData);
    $request = (new CreateDataScanRequest())
        ->setParent($formattedParent)
        ->setDataScan($dataScan)
        ->setDataScanId($dataScanId);

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

        if ($response->operationSucceeded()) {
            /** @var DataScan $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 = DataScanServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $dataScanId = '[DATA_SCAN_ID]';

    create_data_scan_sample($formattedParent, $dataScanId);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Dataplex\V1\DeleteDataScanRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the dataScan:
 *                              `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
 *                              where `project` refers to a *project_id* or *project_number* and
 *                              `location_id` refers to a GCP region. Please see
 *                              {@see DataScanServiceClient::dataScanName()} for help formatting this field.
 */
function delete_data_scan_sample(string $formattedName): void
{
    // Create a client.
    $dataScanServiceClient = new DataScanServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $dataScanServiceClient->deleteDataScan($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 = DataScanServiceClient::dataScanName('[PROJECT]', '[LOCATION]', '[DATASCAN]');

    delete_data_scan_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Dataplex\V1\DataScan;
use Google\Cloud\Dataplex\V1\GetDataScanRequest;

/**
 * @param string $formattedName The resource name of the dataScan:
 *                              `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
 *                              where `project` refers to a *project_id* or *project_number* and
 *                              `location_id` refers to a GCP region. Please see
 *                              {@see DataScanServiceClient::dataScanName()} for help formatting this field.
 */
function get_data_scan_sample(string $formattedName): void
{
    // Create a client.
    $dataScanServiceClient = new DataScanServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DataScan $response */
        $response = $dataScanServiceClient->getDataScan($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 = DataScanServiceClient::dataScanName('[PROJECT]', '[LOCATION]', '[DATASCAN]');

    get_data_scan_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Dataplex\V1\DataScanJob;
use Google\Cloud\Dataplex\V1\GetDataScanJobRequest;

/**
 * @param string $formattedName The resource name of the DataScanJob:
 *                              `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}`
 *                              where `project` refers to a *project_id* or *project_number* and
 *                              `location_id` refers to a GCP region. Please see
 *                              {@see DataScanServiceClient::dataScanJobName()} for help formatting this field.
 */
function get_data_scan_job_sample(string $formattedName): void
{
    // Create a client.
    $dataScanServiceClient = new DataScanServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DataScanJob $response */
        $response = $dataScanServiceClient->getDataScanJob($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 = DataScanServiceClient::dataScanJobName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASCAN]',
        '[JOB]'
    );

    get_data_scan_job_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Dataplex\V1\DataScanJob;
use Google\Cloud\Dataplex\V1\ListDataScanJobsRequest;

/**
 * @param string $formattedParent The resource name of the parent environment:
 *                                `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
 *                                where `project` refers to a *project_id* or *project_number* and
 *                                `location_id` refers to a GCP region. Please see
 *                                {@see DataScanServiceClient::dataScanName()} for help formatting this field.
 */
function list_data_scan_jobs_sample(string $formattedParent): void
{
    // Create a client.
    $dataScanServiceClient = new DataScanServiceClient();

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

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

        /** @var DataScanJob $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 = DataScanServiceClient::dataScanName('[PROJECT]', '[LOCATION]', '[DATASCAN]');

    list_data_scan_jobs_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Dataplex\V1\DataScan;
use Google\Cloud\Dataplex\V1\ListDataScansRequest;

/**
 * @param string $formattedParent The resource name of the parent location:
 *                                `projects/{project}/locations/{location_id}`
 *                                where `project` refers to a *project_id* or *project_number* and
 *                                `location_id` refers to a GCP region. Please see
 *                                {@see DataScanServiceClient::locationName()} for help formatting this field.
 */
function list_data_scans_sample(string $formattedParent): void
{
    // Create a client.
    $dataScanServiceClient = new DataScanServiceClient();

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

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

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

    list_data_scans_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Dataplex\V1\RunDataScanRequest;
use Google\Cloud\Dataplex\V1\RunDataScanResponse;

/**
 * @param string $formattedName The resource name of the DataScan:
 *                              `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`.
 *                              where `project` refers to a *project_id* or *project_number* and
 *                              `location_id` refers to a GCP region.
 *
 *                              Only **OnDemand** data scans are allowed. Please see
 *                              {@see DataScanServiceClient::dataScanName()} for help formatting this field.
 */
function run_data_scan_sample(string $formattedName): void
{
    // Create a client.
    $dataScanServiceClient = new DataScanServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var RunDataScanResponse $response */
        $response = $dataScanServiceClient->runDataScan($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 = DataScanServiceClient::dataScanName('[PROJECT]', '[LOCATION]', '[DATASCAN]');

    run_data_scan_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Dataplex\V1\DataScan;
use Google\Cloud\Dataplex\V1\DataSource;
use Google\Cloud\Dataplex\V1\UpdateDataScanRequest;
use Google\Protobuf\FieldMask;
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_data_scan_sample(): void
{
    // Create a client.
    $dataScanServiceClient = new DataScanServiceClient();

    // Prepare the request message.
    $dataScanData = new DataSource();
    $dataScan = (new DataScan())
        ->setData($dataScanData);
    $updateMask = new FieldMask();
    $request = (new UpdateDataScanRequest())
        ->setDataScan($dataScan)
        ->setUpdateMask($updateMask);

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

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

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $dataScanServiceClient->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\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

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

    // 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 = $dataScanServiceClient->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\Dataplex\V1\Client\DataScanServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

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

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

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;
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.
    $dataScanServiceClient = new DataScanServiceClient();

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

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

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

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