1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudDataplex
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsDataScans

ProjectsLocationsDataScans

class ProjectsLocationsDataScans extends Resource (View source)

The "dataScans" collection of methods.

Typical usage is:

 $dataplexService = new Google\Service\CloudDataplex(...);
 $dataScans = $dataplexService->projects_locations_dataScans;

Methods

GoogleLongrunningOperation
create(string $parent, GoogleCloudDataplexV1DataScan $postBody, array $optParams = [])

Creates a DataScan resource. (dataScans.create)

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

Deletes a DataScan resource. (dataScans.delete)

GoogleCloudDataplexV1GenerateDataQualityRulesResponse
generateDataQualityRules(string $name, GoogleCloudDataplexV1GenerateDataQualityRulesRequest $postBody, array $optParams = [])

Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan. (dataScans.generateDataQualityRules)

GoogleCloudDataplexV1DataScan
get(string $name, array $optParams = [])

Gets a DataScan resource. (dataScans.get)

GoogleIamV1Policy
getIamPolicy(string $resource, array $optParams = [])

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

GoogleCloudDataplexV1ListDataScansResponse
listProjectsLocationsDataScans(string $parent, array $optParams = [])

Lists DataScans. (dataScans.listProjectsLocationsDataScans)

GoogleLongrunningOperation
patch(string $name, GoogleCloudDataplexV1DataScan $postBody, array $optParams = [])

Updates a DataScan resource. (dataScans.patch)

GoogleCloudDataplexV1RunDataScanResponse
run(string $name, GoogleCloudDataplexV1RunDataScanRequest $postBody, array $optParams = [])

Runs an on-demand execution of a DataScan (dataScans.run)

GoogleIamV1Policy
setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (dataScans.setIamPolicy)

GoogleIamV1TestIamPermissionsResponse
testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

at line 60
GoogleLongrunningOperation create(string $parent, GoogleCloudDataplexV1DataScan $postBody, array $optParams = [])

Creates a DataScan resource. (dataScans.create)

Parameters

string $parent

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.
GoogleCloudDataplexV1DataScan $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 77
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a DataScan resource. (dataScans.delete)

Parameters

string $name

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.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 97
GoogleCloudDataplexV1GenerateDataQualityRulesResponse generateDataQualityRules(string $name, GoogleCloudDataplexV1GenerateDataQualityRulesRequest $postBody, array $optParams = [])

Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan. (dataScans.generateDataQualityRules)

Parameters

string $name

Required. 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)
GoogleCloudDataplexV1GenerateDataQualityRulesRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1GenerateDataQualityRulesResponse

Exceptions

Exception

at line 117
GoogleCloudDataplexV1DataScan get(string $name, array $optParams = [])

Gets a DataScan resource. (dataScans.get)

Parameters

string $name

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.
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1DataScan

Exceptions

Exception

at line 147
GoogleIamV1Policy getIamPolicy(string $resource, array $optParams = [])

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

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

at line 175
GoogleCloudDataplexV1ListDataScansResponse listProjectsLocationsDataScans(string $parent, array $optParams = [])

Lists DataScans. (dataScans.listProjectsLocationsDataScans)

Parameters

string $parent

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.
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1ListDataScansResponse

Exceptions

Exception

at line 197
GoogleLongrunningOperation patch(string $name, GoogleCloudDataplexV1DataScan $postBody, array $optParams = [])

Updates a DataScan resource. (dataScans.patch)

Parameters

string $name

Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
GoogleCloudDataplexV1DataScan $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 215
GoogleCloudDataplexV1RunDataScanResponse run(string $name, GoogleCloudDataplexV1RunDataScanRequest $postBody, array $optParams = [])

Runs an on-demand execution of a DataScan (dataScans.run)

Parameters

string $name

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.
GoogleCloudDataplexV1RunDataScanRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1RunDataScanResponse

Exceptions

Exception

at line 235
GoogleIamV1Policy setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (dataScans.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
GoogleIamV1SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

at line 258
GoogleIamV1TestIamPermissionsResponse testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

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. (dataScans.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
GoogleIamV1TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1TestIamPermissionsResponse

Exceptions

Exception