Google Cloud Dataplex V1 Client - Class DataScanServiceClient (0.11.1)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataScanServiceClient.

Service Description: DataScanService manages DataScan resources which can be configured to run various types of data scanning workload and generate enriched metadata (e.g.

Data Profile, Data Quality) for the data source.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$dataScanServiceClient = new DataScanServiceClient();
try {
    $formattedParent = $dataScanServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $dataScan = new DataScan();
    $dataScanId = 'data_scan_id';
    $operationResponse = $dataScanServiceClient->createDataScan($formattedParent, $dataScan, $dataScanId);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $dataScanServiceClient->createDataScan($formattedParent, $dataScan, $dataScanId);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $dataScanServiceClient->resumeOperation($operationName, 'createDataScan');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $dataScanServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This service has a new (beta) implementation. See Google\Cloud\Dataplex\V1\Client\DataScanServiceClient to use the new surface.

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createDataScan

Creates a DataScan resource.

Parameters
Name	Description
`parent`	`string` Required. 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.
`dataScan`	`Google\Cloud\Dataplex\V1\DataScan` Required. DataScan resource.
`dataScanId`	`string` Required. 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.
`optionalArgs`	`array` Optional.
`↳ validateOnly`	`bool` Optional. Only validate the request, but do not perform mutations. The default is `false`.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

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);
}

deleteDataScan

Deletes a DataScan resource.

Parameters
Name	Description
`name`	`string` Required. 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.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

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);
}

getDataScan

Gets a DataScan resource.

Parameters
Name	Description
`name`	`string` Required. 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.
`optionalArgs`	`array` Optional.
`↳ view`	`int` Optional. Select the DataScan view to return. Defaults to `BASIC`. For allowed values, use constants defined on Google\Cloud\Dataplex\V1\GetDataScanRequest\DataScanView
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\DataScan`

Example

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);
}

getDataScanJob

Gets a DataScanJob resource.

Parameters
Name	Description
`name`	`string` Required. 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.
`optionalArgs`	`array` Optional.
`↳ view`	`int` Optional. Select the DataScanJob view to return. Defaults to `BASIC`. For allowed values, use constants defined on Google\Cloud\Dataplex\V1\GetDataScanJobRequest\DataScanJobView
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\DataScanJob`

Example

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);
}

listDataScanJobs

Lists DataScanJobs under the given DataScan.

Parameters
Name	Description
`parent`	`string` Required. 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.
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ filter`	`string` Optional. An expression for filtering the results of the ListDataScanJobs request. If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with `AND`, `OR` logical operators). Filters are case-sensitive. Allowed fields are: - `start_time` - `end_time` `start_time` and `end_time` expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00). For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

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);
}

listDataScans

Lists DataScans.

Parameters
Name	Description
`parent`	`string` Required. 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.
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ filter`	`string` Optional. Filter request.
`↳ orderBy`	`string` Optional. Order by fields (`name` or `create_time`) for the result. If not specified, the ordering is undefined.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

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);
}

runDataScan

Runs an on-demand execution of a DataScan

Parameters
Name	Description
`name`	`string` Required. 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.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\RunDataScanResponse`

Example

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);
}

updateDataScan

Updates a DataScan resource.

Parameters
Name	Description
`dataScan`	`Google\Cloud\Dataplex\V1\DataScan` Required. DataScan resource to be updated. Only fields specified in `update_mask` are updated.
`updateMask`	`Google\Protobuf\FieldMask` Required. Mask of fields to update.
`optionalArgs`	`array` Optional.
`↳ validateOnly`	`bool` Optional. Only validate the request, but do not perform mutations. The default is `false`.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

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());
    }
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
`optionalArgs`	`array` Optional.
`↳ options`	`GetPolicyOptions` OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

Example

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);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`Google\Cloud\Iam\V1\Policy` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

Example

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);
}

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`string[]` 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.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\TestIamPermissionsResponse`

Example

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);
}

getLocation

Gets information about a location.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` Resource name for the location.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Location\Location`

Example

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());
    }
}

listLocations

Lists information about the supported locations for this service.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` The resource that owns the locations collection, if applicable.
`↳ filter`	`string` The standard list filter.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

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());
    }
}

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::dataScanName

Formats a string containing the fully-qualified path to represent a data_scan resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataScan`	`string`

Returns
Type	Description
`string`	The formatted data_scan resource.

static::dataScanJobName

Formats a string containing the fully-qualified path to represent a data_scan_job resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataScan`	`string`
`job`	`string`

Returns
Type	Description
`string`	The formatted data_scan_job resource.

static::entityName

Formats a string containing the fully-qualified path to represent a entity resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`lake`	`string`
`zone`	`string`
`entity`	`string`

Returns
Type	Description
`string`	The formatted entity resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

dataScan: projects/{project}/locations/{location}/dataScans/{dataScan}
dataScanJob: projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{job}
entity: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}
location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.cloud.dataplex.v1.DataScanService'

The name of the service.

SERVICE_ADDRESS

Value: 'dataplex.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.