Google Cloud Dataplex V1 Client - Class NotificationReport (1.0.1)

Version 1.0.1

• 1.1.0 (latest)
• 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 NotificationReport.

The configuration of notification report post scan action.

Generated from protobuf message google.cloud.dataplex.v1.DataQualitySpec.PostScanActions.NotificationReport

Namespace

Google \ Cloud \ Dataplex \ V1 \ DataQualitySpec \ PostScanActions

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ recipients	Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\Recipients Required. The recipients who will receive the notification report.
↳ score_threshold_trigger	Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\ScoreThresholdTrigger Optional. If set, report will be sent when score threshold is met.
↳ job_failure_trigger	Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\JobFailureTrigger Optional. If set, report will be sent when a scan job fails.
↳ job_end_trigger	Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\JobEndTrigger Optional. If set, report will be sent when a scan job ends.

getRecipients

Required. The recipients who will receive the notification report.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\Recipients|null

hasRecipients

clearRecipients

setRecipients

Required. The recipients who will receive the notification report.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\Recipients

Returns
Type	Description
$this

getScoreThresholdTrigger

Optional. If set, report will be sent when score threshold is met.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\ScoreThresholdTrigger|null

hasScoreThresholdTrigger

clearScoreThresholdTrigger

setScoreThresholdTrigger

Optional. If set, report will be sent when score threshold is met.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\ScoreThresholdTrigger

Returns
Type	Description
$this

getJobFailureTrigger

Optional. If set, report will be sent when a scan job fails.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\JobFailureTrigger|null

hasJobFailureTrigger

clearJobFailureTrigger

setJobFailureTrigger

Optional. If set, report will be sent when a scan job fails.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\JobFailureTrigger

Returns
Type	Description
$this

getJobEndTrigger

Optional. If set, report will be sent when a scan job ends.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\JobEndTrigger|null

hasJobEndTrigger

clearJobEndTrigger

setJobEndTrigger

Optional. If set, report will be sent when a scan job ends.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualitySpec\PostScanActions\JobEndTrigger

Returns
Type	Description
$this