Google Cloud Dataplex V1 Client - Class DeleteDataScanRequest (1.2.0)

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

Delete dataScan request.

Generated from protobuf message google.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} where project refers to a project_id or project_number and location_id refers 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} where project refers to a project_id or project_number and location_id refers 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} where project refers to a project_id or project_number and location_id refers 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} where project refers to a project_id or project_number and location_id refers to a GCP region. Please see DataScanServiceClient::dataScanName() for help formatting this field.

Returns
Type Description
DeleteDataScanRequest