Google Cloud Dataplex V1 Client - Class CreateDataScanRequest (0.5.1)

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

Create dataScan request.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The resource name of the parent location: `projects/{project}/locations/{location_id}` where `project` refers to a project_id or project_number and `location_id` refers to a GCP region.
`↳ data_scan`	`Google\Cloud\Dataplex\V1\DataScan` Required. DataScan resource.
`↳ data_scan_id`	`string` Required. DataScan identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
`↳ validate_only`	`bool` Optional. Only validate the request, but do not perform mutations. The default is `false`.

getParent

Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

Returns
Type	Description
`string`

setParent

Required. The resource name of the parent location: projects/{project}/locations/{location_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`

getDataScan

Required. DataScan resource.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\DataScan\|null`

hasDataScan

clearDataScan

setDataScan

Required. DataScan resource.

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\DataScan`

Returns
Type	Description
`$this`

getDataScanId

Required. DataScan identifier.

Must contain only lowercase letters, numbers and hyphens.
Must start with a letter.
Must end with a number or a letter.
Must be between 1-63 characters.
Must be unique within the customer project / location.

Returns
Type	Description
`string`

setDataScanId

Required. DataScan identifier.

Must contain only lowercase letters, numbers and hyphens.
Must start with a letter.
Must end with a number or a letter.
Must be between 1-63 characters.
Must be unique within the customer project / location.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is false.

Returns
Type	Description
`bool`

setValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is false.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. The resource name of the parent location: `projects/{project}/locations/{location_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::locationName() for help formatting this field.
`dataScan`	`Google\Cloud\Dataplex\V1\DataScan` Required. DataScan resource.
`dataScanId`	`string` Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\CreateDataScanRequest`