Google Cloud Dataplex V1 Client - Class DataScanEvent (0.8.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' Next ID: 13

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 Google\Cloud\Dataplex\V1\DataScanEvent\DataProfileResult

Data profile result for data profile type data scan.

↳ data_quality Google\Cloud\Dataplex\V1\DataScanEvent\DataQualityResult

Data quality result for data quality type data scan.

↳ data_profile_configs Google\Cloud\Dataplex\V1\DataScanEvent\DataProfileAppliedConfigs

Applied configs for data profile type data scan.

↳ data_quality_configs Google\Cloud\Dataplex\V1\DataScanEvent\DataQualityAppliedConfigs

Applied configs for data quality type data scan.

↳ post_scan_actions_result Google\Cloud\Dataplex\V1\DataScanEvent\PostScanActionsResult

The result of post scan actions.

getDataSource

The data source of the data scan

Returns
TypeDescription
string

setDataSource

The data source of the data scan

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobId

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

Returns
TypeDescription
string

setJobId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

The time when the data scan job was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time when the data scan job was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getStartTime

The time when the data scan job started to run.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

The time when the data scan job started to run.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

The time when the data scan job finished.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

The time when the data scan job finished.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getType

The type of the data scan.

Returns
TypeDescription
int

setType

The type of the data scan.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getState

The status of the data scan job.

Returns
TypeDescription
int

setState

The status of the data scan job.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMessage

The message describing the data scan job event.

Returns
TypeDescription
string

setMessage

The message describing the data scan job event.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSpecVersion

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

Returns
TypeDescription
string

setSpecVersion

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTrigger

The trigger type of the data scan job.

Returns
TypeDescription
int

setTrigger

The trigger type of the data scan job.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getScope

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

Returns
TypeDescription
int

setScope

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDataProfile

Data profile result for data profile type data scan.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\DataScanEvent\DataProfileResult|null

hasDataProfile

setDataProfile

Data profile result for data profile type data scan.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\DataScanEvent\DataProfileResult
Returns
TypeDescription
$this

getDataQuality

Data quality result for data quality type data scan.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\DataScanEvent\DataQualityResult|null

hasDataQuality

setDataQuality

Data quality result for data quality type data scan.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\DataScanEvent\DataQualityResult
Returns
TypeDescription
$this

getDataProfileConfigs

Applied configs for data profile type data scan.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\DataScanEvent\DataProfileAppliedConfigs|null

hasDataProfileConfigs

setDataProfileConfigs

Applied configs for data profile type data scan.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\DataScanEvent\DataProfileAppliedConfigs
Returns
TypeDescription
$this

getDataQualityConfigs

Applied configs for data quality type data scan.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\DataScanEvent\DataQualityAppliedConfigs|null

hasDataQualityConfigs

setDataQualityConfigs

Applied configs for data quality type data scan.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\DataScanEvent\DataQualityAppliedConfigs
Returns
TypeDescription
$this

getPostScanActionsResult

The result of post scan actions.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\DataScanEvent\PostScanActionsResult|null

hasPostScanActionsResult

clearPostScanActionsResult

setPostScanActionsResult

The result of post scan actions.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\DataScanEvent\PostScanActionsResult
Returns
TypeDescription
$this

getResult

Returns
TypeDescription
string

getAppliedConfigs

Returns
TypeDescription
string