# Google Cloud Dataplex V1 Client - Class DataScanEvent (1.14.0)

1.14.0 (latest) 1.13.0 1.12.0 1.11.0 1.10.0 1.9.1 1.8.0 1.7.1 1.6.1 1.4.0 1.3.0 1.2.1 1.1.1 1.0.1 0.16.1 0.15.1 0.14.0 0.13.0 0.12.0 0.11.1 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.1 0.4.0 0.3.0 0.2.3 0.1.6 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` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The time when the data scan job was created. |
| `↳ start_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The time when the data scan job started to run. |
| `↳ end_time` | `https://protobuf.dev/reference/php/api-docs/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` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataProfileResult` Data profile result for data profile type data scan. |
| `↳ data_quality` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataQualityResult` Data quality result for data quality type data scan. |
| `↳ data_profile_configs` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataProfileAppliedConfigs` Applied configs for data profile type data scan. |
| `↳ data_quality_configs` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataQualityAppliedConfigs` Applied configs for data quality type data scan. |
| `↳ post_scan_actions_result` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.PostScanActionsResult` The result of post scan actions. |
| `↳ catalog_publishing_status` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasCreateTime

### clearCreateTime

### setCreateTime

The time when the data scan job was created.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStartTime

The time when the data scan job started to run.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasStartTime

### clearStartTime

### setStartTime

The time when the data scan job started to run.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEndTime

The time when the data scan job finished.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasEndTime

### clearEndTime

### setEndTime

The time when the data scan job finished.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getType

The type of the data scan.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ScanType](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.ScanType). |

### setType

The type of the data scan.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ScanType](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.ScanType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getState

The status of the data scan job.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.State). |

### setState

The status of the data scan job.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.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](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.Trigger). |

### setTrigger

The trigger type of the data scan job.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [Trigger](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.Trigger). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getScope

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [Scope](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.Scope). |

### setScope

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [Scope](https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.Scope). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDataProfile

Data profile result for data profile type data scan.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataProfileResult|null` |   |

### hasDataProfile

### setDataProfile

Data profile result for data profile type data scan.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataProfileResult` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDataQuality

Data quality result for data quality type data scan.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataQualityResult|null` |   |

### hasDataQuality

### setDataQuality

Data quality result for data quality type data scan.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataQualityResult` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDataProfileConfigs

Applied configs for data profile type data scan.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataProfileAppliedConfigs|null` |   |

### hasDataProfileConfigs

### setDataProfileConfigs

Applied configs for data profile type data scan.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataProfileAppliedConfigs` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDataQualityConfigs

Applied configs for data quality type data scan.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataQualityAppliedConfigs|null` |   |

### hasDataQualityConfigs

### setDataQualityConfigs

Applied configs for data quality type data scan.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.DataQualityAppliedConfigs` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPostScanActionsResult

The result of post scan actions.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.PostScanActionsResult|null` |   |

### hasPostScanActionsResult

### clearPostScanActionsResult

### setPostScanActionsResult

The result of post scan actions.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanEvent.PostScanActionsResult` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCatalogPublishingStatus

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanCatalogPublishingStatus|null` |   |

### hasCatalogPublishingStatus

### clearCatalogPublishingStatus

### setCatalogPublishingStatus

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-dataplex/latest/V1.DataScanCatalogPublishingStatus` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getResult

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### getAppliedConfigs

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |