Google Cloud Dataplex V1 Client - Class RunDataScanRequest (0.4.0)

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

Run DataScan Request

Generated from protobuf message google.cloud.dataplex.v1.RunDataScanRequest

Methods

build

Parameter
NameDescription
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. Please see {@see \Google\Cloud\Dataplex\V1\DataScanServiceClient::dataScanName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\RunDataScanRequest

__construct

Constructor.

Parameters
NameDescription
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. Only OnDemand data scans are allowed.

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. Only OnDemand data scans are allowed.

Returns
TypeDescription
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. Only OnDemand data scans are allowed.

Parameter
NameDescription
var string
Returns
TypeDescription
$this