Google Cloud Dataplex V1 Client - Class GetDataScanRequest (1.11.0)

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

Get dataScan request.

Generated from protobuf messagegoogle.cloud.dataplex.v1.GetDataScanRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ namestring

Required. The resource name of the dataScan:projects/{project}/locations/{location_id}/dataScans/{data_scan_id} whereproject refers to aproject_id orproject_number andlocation_id refers to a Google Cloud region.

↳ viewint

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

getName

Required. The resource name of the dataScan:projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereproject refers to aproject_id orproject_number andlocation_id refers to a Google Cloud region.

Returns
TypeDescription
string

setName

Required. The resource name of the dataScan:projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereproject refers to aproject_id orproject_number andlocation_id refers to a Google Cloud region.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getView

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

Returns
TypeDescription
intEnum of typeDataScanView.

setView

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

Parameter
NameDescription
varint

Enum of typeDataScanView.

Returns
TypeDescription
$this

static::build

Parameter
NameDescription
namestring

Required. The resource name of the dataScan:projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereproject refers to aproject_id orproject_number andlocation_id refers to a Google Cloud region. Please seeDataScanServiceClient::dataScanName() for help formatting this field.

Returns
TypeDescription
GetDataScanRequest

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-11-08 UTC.