Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DeleteDataScanRequest.
Delete dataScan request.
Generated from protobuf messagegoogle.cloud.dataplex.v1.DeleteDataScanRequest
Namespace
Google \ Cloud \ Dataplex \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The resource name of the dataScan:projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region.
↳ force
bool
Optional. If set to true, any child resources of this data scan will also be deleted. (Otherwise, the request will only work if the data scan has no child resources.)
getName
Required. The resource name of the dataScan:projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region.
Returns
Type
Description
string
setName
Required. The resource name of the dataScan:projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getForce
Optional. If set to true, any child resources of this data scan will also
be deleted. (Otherwise, the request will only work if the data scan has no
child resources.)
Returns
Type
Description
bool
setForce
Optional. If set to true, any child resources of this data scan will also
be deleted. (Otherwise, the request will only work if the data scan has no
child resources.)
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. The resource name of the dataScan:projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region. Please seeDataScanServiceClient::dataScanName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class DeleteDataScanRequest (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.DeleteDataScanRequest)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.DeleteDataScanRequest)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.DeleteDataScanRequest)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.DeleteDataScanRequest)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.DeleteDataScanRequest)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.DeleteDataScanRequest)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.DeleteDataScanRequest)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.DeleteDataScanRequest)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.DeleteDataScanRequest)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.DeleteDataScanRequest)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.DeleteDataScanRequest)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.DeleteDataScanRequest)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.DeleteDataScanRequest)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.DeleteDataScanRequest)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.DeleteDataScanRequest)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.DeleteDataScanRequest)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.DeleteDataScanRequest)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.DeleteDataScanRequest)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.DeleteDataScanRequest)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.DeleteDataScanRequest)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.DeleteDataScanRequest)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.DeleteDataScanRequest)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.DeleteDataScanRequest)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.DeleteDataScanRequest) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class DeleteDataScanRequest.\n\nDelete dataScan request.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.DeleteDataScanRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The resource name of the dataScan:\n`projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`\nwhere `project` refers to a *project_id* or *project_number* and\n`location_id` refers to a GCP region.\n\n### setName\n\nRequired. The resource name of the dataScan:\n`projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`\nwhere `project` refers to a *project_id* or *project_number* and\n`location_id` refers to a GCP region.\n\n### getForce\n\nOptional. If set to true, any child resources of this data scan will also\nbe deleted. (Otherwise, the request will only work if the data scan has no\nchild resources.)\n\n### setForce\n\nOptional. If set to true, any child resources of this data scan will also\nbe deleted. (Otherwise, the request will only work if the data scan has no\nchild resources.)\n\n### static::build"]]
