Google Cloud Dataplex V1 Client - Class DataScanEvent (1.10.0)

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

These messages contain information about the execution of a datascan.

The monitored resource is 'DataScan'

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ data_source
string

The data source of the data scan

↳ job_id
string

The identifier of the specific data scan job this log entry is for.

↳ create_time
Google\Protobuf\Timestamp

The time when the data scan job was created.

↳ start_time
Google\Protobuf\Timestamp

The time when the data scan job started to run.

↳ end_time
Google\Protobuf\Timestamp

The time when the data scan job finished.

↳ type
int

The type of the data scan.

↳ state
int

The status of the data scan job.

↳ message
string

The message describing the data scan job event.

↳ spec_version
string

A version identifier of the spec which was used to execute this job.

↳ trigger
int

The trigger type of the data scan job.

↳ scope
int

The scope of the data scan (e.g. full, incremental).

↳ data_profile
DataScanEvent\DataProfileResult

Data profile result for data profile type data scan.

↳ data_quality
DataScanEvent\DataQualityResult

Data quality result for data quality type data scan.

↳ data_profile_configs
DataScanEvent\DataProfileAppliedConfigs

Applied configs for data profile type data scan.

↳ data_quality_configs
DataScanEvent\DataQualityAppliedConfigs

Applied configs for data quality type data scan.

↳ post_scan_actions_result
DataScanEvent\PostScanActionsResult

The result of post scan actions.

↳ catalog_publishing_status
DataScanCatalogPublishingStatus

The status of publishing the data scan as Dataplex Universal Catalog metadata.

getDataSource

The data source of the data scan

Returns
Type
Description
string

setDataSource

The data source of the data scan

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getJobId

The identifier of the specific data scan job this log entry is for.

Returns
Type
Description
string

setJobId

The identifier of the specific data scan job this log entry is for.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

The time when the data scan job was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

The time when the data scan job was created.

Parameter
Name
Description
Returns
Type
Description
$this

getStartTime

The time when the data scan job started to run.

Returns
Type
Description

hasStartTime

clearStartTime

setStartTime

The time when the data scan job started to run.

Parameter
Name
Description
Returns
Type
Description
$this

getEndTime

The time when the data scan job finished.

Returns
Type
Description

hasEndTime

clearEndTime

setEndTime

The time when the data scan job finished.

Parameter
Name
Description
Returns
Type
Description
$this

getType

The type of the data scan.

Returns
Type
Description
int
Enum of type ScanType .

setType

The type of the data scan.

Parameter
Name
Description
var
int

Enum of type ScanType .

Returns
Type
Description
$this

getState

The status of the data scan job.

Returns
Type
Description
int
Enum of type State .

setState

The status of the data scan job.

Parameter
Name
Description
var
int

Enum of type State .

Returns
Type
Description
$this

getMessage

The message describing the data scan job event.

Returns
Type
Description
string

setMessage

The message describing the data scan job event.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSpecVersion

A version identifier of the spec which was used to execute this job.

Returns
Type
Description
string

setSpecVersion

A version identifier of the spec which was used to execute this job.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTrigger

The trigger type of the data scan job.

Returns
Type
Description
int
Enum of type Trigger .

setTrigger

The trigger type of the data scan job.

Parameter
Name
Description
var
int

Enum of type Trigger .

Returns
Type
Description
$this

getScope

The scope of the data scan (e.g. full, incremental).

Returns
Type
Description
int
Enum of type Scope .

setScope

The scope of the data scan (e.g. full, incremental).

Parameter
Name
Description
var
int

Enum of type Scope .

Returns
Type
Description
$this

getDataProfile

Data profile result for data profile type data scan.

Returns
Type
Description

hasDataProfile

setDataProfile

Data profile result for data profile type data scan.

Parameter
Name
Description
Returns
Type
Description
$this

getDataQuality

Data quality result for data quality type data scan.

Returns
Type
Description

hasDataQuality

setDataQuality

Data quality result for data quality type data scan.

Parameter
Name
Description
Returns
Type
Description
$this

getDataProfileConfigs

Applied configs for data profile type data scan.

Returns
Type
Description

hasDataProfileConfigs

setDataProfileConfigs

Applied configs for data profile type data scan.

Parameter
Name
Description
Returns
Type
Description
$this

getDataQualityConfigs

Applied configs for data quality type data scan.

Returns
Type
Description

hasDataQualityConfigs

setDataQualityConfigs

Applied configs for data quality type data scan.

Parameter
Name
Description
Returns
Type
Description
$this

getPostScanActionsResult

The result of post scan actions.

Returns
Type
Description

hasPostScanActionsResult

clearPostScanActionsResult

setPostScanActionsResult

The result of post scan actions.

Parameter
Name
Description
Returns
Type
Description
$this

getCatalogPublishingStatus

The status of publishing the data scan as Dataplex Universal Catalog metadata.

Returns
Type
Description

hasCatalogPublishingStatus

clearCatalogPublishingStatus

setCatalogPublishingStatus

The status of publishing the data scan as Dataplex Universal Catalog metadata.

Parameter
Name
Description
Returns
Type
Description
$this

getResult

Returns
Type
Description
string

getAppliedConfigs

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: