Google Cloud Dataplex V1 Client - Class DataScanEvent (0.5.1)
Stay organized with collections
Save and categorize content based on your preferences.
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 \ V1Methods
__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. |
↳ 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. |
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 |
|
getStartTime
The time when the data scan job started to run.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
The time when the data scan job started to run.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
The time when the data scan job finished.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
The time when the data scan job finished.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
The type of the data scan.
| Returns | |
|---|---|
| Type | Description |
int |
|
setType
The type of the data scan.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
The status of the data scan job.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
The status of the data scan job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 |
|
setTrigger
The trigger type of the data scan job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScope
The scope of the data scan (e.g. full, incremental).
| Returns | |
|---|---|
| Type | Description |
int |
|
setScope
The scope of the data scan (e.g. full, incremental).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataProfile
Data profile result for data profile type data scan.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataScanEvent\DataProfileResult|null |
|
hasDataProfile
setDataProfile
Data profile result for data profile type data scan.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataScanEvent\DataProfileResult
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataQuality
Data quality result for data quality type data scan.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataScanEvent\DataQualityResult|null |
|
hasDataQuality
setDataQuality
Data quality result for data quality type data scan.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataScanEvent\DataQualityResult
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResult
| Returns | |
|---|---|
| Type | Description |
string |
|