Google Cloud Dataplex V1 Client - Class DataScanServiceClient (1.11.0) Stay organized with collections Save and categorize content based on your preferences.
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 runvarious 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 methodcalls that map to API methods.
Many parameters require resource names to be formatted in a particular way. Toassist with these names, this class includes a format method for each type ofname, and additionally a parseName method to extract the individual identifierscontained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ Dataplex \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options | array|Google\ApiCore\Options\ClientOptionsOptional. Options for configuring the service API wrapper. |
↳ apiEndpoint | stringThe address of the API remote host. May optionally include the port, formatted as " |
↳ credentials | FetchAuthTokenInterface|CredentialsWrapperThis option should only be used with a pre-constructedGoogle\Auth\FetchAuthTokenInterface orGoogle\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ credentialsConfig | arrayOptions used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, seeGoogle\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries | boolDetermines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig | string|arrayClient 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|TransportInterfaceThe transport used for executing network requests. May be either the string |
↳ transportConfig | arrayConfiguration 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 theGoogle\ApiCore\Transport\GrpcTransport::build() andGoogle\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource | callableA 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. |
↳ logger | false|LoggerInterfaceA PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
↳ universeDomain | stringThe service domain for the client. Defaults to 'googleapis.com'. |
createDataScan
Creates a DataScan resource.
The async variant isDataScanServiceClient::createDataScanAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\CreateDataScanRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse<Google\Cloud\Dataplex\V1\DataScan> | |
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 Google Cloud 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.
The async variant isDataScanServiceClient::deleteDataScanAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\DeleteDataScanRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse<null> | |
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 Google Cloud 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);}generateDataQualityRules
Generates recommended data quality rules based on the results of a dataprofiling scan.
Use the recommendations to build rules for a data quality scan.
The async variant isDataScanServiceClient::generateDataQualityRulesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\GenerateDataQualityRulesRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\GenerateDataQualityRulesResponse | |
use Google\ApiCore\ApiException;use Google\Cloud\Dataplex\V1\Client\DataScanServiceClient;use Google\Cloud\Dataplex\V1\GenerateDataQualityRulesRequest;use Google\Cloud\Dataplex\V1\GenerateDataQualityRulesResponse;/** * @param string $name The name must be one of the following: * * * The name of a data scan with at least one successful, completed data * profiling job * * The name of a successful, completed data profiling job (a data scan job * where the job type is data profiling) */function generate_data_quality_rules_sample(string $name): void{ // Create a client. $dataScanServiceClient = new DataScanServiceClient(); // Prepare the request message. $request = (new GenerateDataQualityRulesRequest()) ->setName($name); // Call the API and handle any network failures. try { /** @var GenerateDataQualityRulesResponse $response */ $response = $dataScanServiceClient->generateDataQualityRules($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{ $name = '[NAME]'; generate_data_quality_rules_sample($name);}getDataScan
Gets a DataScan resource.
The async variant isDataScanServiceClient::getDataScanAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\GetDataScanRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataScan | |
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 Google Cloud 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.
The async variant isDataScanServiceClient::getDataScanJobAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\GetDataScanJobRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataScanJob | |
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 Google Cloud 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.
The async variant isDataScanServiceClient::listDataScanJobsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\ListDataScanJobsRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
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 Google Cloud 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.
The async variant isDataScanServiceClient::listDataScansAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\ListDataScansRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
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 Google Cloud 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
The async variant isDataScanServiceClient::runDataScanAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\RunDataScanRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\RunDataScanResponse | |
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 Google Cloud 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.
The async variant isDataScanServiceClient::updateDataScanAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\UpdateDataScanRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse<Google\Cloud\Dataplex\V1\DataScan> | |
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\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); $request = (new UpdateDataScanRequest()) ->setDataScan($dataScan); // 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 policyif the resource exists and does not have a policy set.
The async variant isDataScanServiceClient::getIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Iam\V1\GetIamPolicyRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy | |
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. Replacesany existing policy.
Can returnNOT_FOUND,INVALID_ARGUMENT, andPERMISSION_DENIEDerrors.
The async variant isDataScanServiceClient::setIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Iam\V1\SetIamPolicyRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy | |
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 theresource does not exist, this will return an empty set ofpermissions, not aNOT_FOUND error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
The async variant isDataScanServiceClient::testIamPermissionsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Iam\V1\TestIamPermissionsRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse | |
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.
The async variant isDataScanServiceClient::getLocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Location\GetLocationRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Location\Location | |
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.
The async variant isDataScanServiceClient::listLocationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Location\ListLocationsRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
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()); }}createDataScanAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\CreateDataScanRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
deleteDataScanAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\DeleteDataScanRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
generateDataQualityRulesAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\GenerateDataQualityRulesRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataplex\V1\GenerateDataQualityRulesResponse> | |
getDataScanAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\GetDataScanRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataplex\V1\DataScan> | |
getDataScanJobAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\GetDataScanJobRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataplex\V1\DataScanJob> | |
listDataScanJobsAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\ListDataScanJobsRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> | |
listDataScansAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\ListDataScansRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> | |
runDataScanAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\RunDataScanRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataplex\V1\RunDataScanResponse> | |
updateDataScanAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Dataplex\V1\UpdateDataScanRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
getIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Iam\V1\GetIamPolicyRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> | |
setIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Iam\V1\SetIamPolicyRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> | |
testIamPermissionsAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Iam\V1\TestIamPermissionsRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse> | |
getLocationAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Location\GetLocationRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> | |
listLocationsAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Location\ListLocationsRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> | |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\LongRunning\Client\OperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a longrunning API method. If $methodName is not provided, or does not match a longrunning API method, then the operation can still be resumed, but theOperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of the long running operation |
methodName | stringThe name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
static::connectionName
Formats a string containing the fully-qualified path to represent a connectionresource.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
connection | string |
| Returns | |
|---|---|
| Type | Description |
string | The formatted connection resource. |
static::dataScanName
Formats a string containing the fully-qualified path to represent a data_scanresource.
| 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 adata_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::datasetName
Formats a string containing the fully-qualified path to represent a datasetresource.
| Parameters | |
|---|---|
| Name | Description |
project | string |
dataset | string |
| Returns | |
|---|---|
| Type | Description |
string | The formatted dataset resource. |
static::entityName
Formats a string containing the fully-qualified path to represent a entityresource.
| 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 locationresource.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
| Returns | |
|---|---|
| Type | Description |
string | The formatted location resource. |
static::projectName
Formats a string containing the fully-qualified path to represent a projectresource.
| Parameter | |
|---|---|
| Name | Description |
project | string |
| Returns | |
|---|---|
| Type | Description |
string | The formatted project 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
- connection: projects/{project}/locations/{location}/connections/{connection}
- dataScan: projects/{project}/locations/{location}/dataScans/{dataScan}
- dataScanJob: projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{job}
- dataset: projects/{project}/datasets/{dataset}
- entity: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}
- location: projects/{project}/locations/{location}
- project: projects/{project}
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 isprovided, or if the $template argument does not match one of the templateslisted, then parseName will check each of the supported templates, and returnthe first match.
| Parameters | |
|---|---|
| Name | Description |
formattedName | stringThe formatted name string |
template | ?stringOptional name of template to match |
| Returns | |
|---|---|
| Type | Description |
array | An associative array from name component IDs to component values. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-10 UTC.