Google Cloud Dataplex V1 Client - Class GetDataScanRequest (0.5.1)

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

Get dataScan request.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__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.

↳ view int

Optional. Select the DataScan view to return. Defaults to BASIC.

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
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getView

Optional. Select the DataScan view to return. Defaults to BASIC.

Returns
TypeDescription
int

setView

Optional. Select the DataScan view to return. Defaults to BASIC.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

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

Returns
TypeDescription
Google\Cloud\Dataplex\V1\GetDataScanRequest