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 \ PostScanActionsMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ recipients |
Recipients
Required. The recipients who will receive the notification report. |
↳ score_threshold_trigger |
ScoreThresholdTrigger
Optional. If set, report will be sent when score threshold is met. |
↳ job_failure_trigger |
JobFailureTrigger
Optional. If set, report will be sent when a scan job fails. |
↳ job_end_trigger |
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 |
Recipients|null |
hasRecipients
clearRecipients
setRecipients
Required. The recipients who will receive the notification report.
Parameter | |
---|---|
Name | Description |
var |
Recipients
|
Returns | |
---|---|
Type | Description |
$this |
getScoreThresholdTrigger
Optional. If set, report will be sent when score threshold is met.
Returns | |
---|---|
Type | Description |
ScoreThresholdTrigger|null |
hasScoreThresholdTrigger
clearScoreThresholdTrigger
setScoreThresholdTrigger
Optional. If set, report will be sent when score threshold is met.
Parameter | |
---|---|
Name | Description |
var |
ScoreThresholdTrigger
|
Returns | |
---|---|
Type | Description |
$this |
getJobFailureTrigger
Optional. If set, report will be sent when a scan job fails.
Returns | |
---|---|
Type | Description |
JobFailureTrigger|null |
hasJobFailureTrigger
clearJobFailureTrigger
setJobFailureTrigger
Optional. If set, report will be sent when a scan job fails.
Parameter | |
---|---|
Name | Description |
var |
JobFailureTrigger
|
Returns | |
---|---|
Type | Description |
$this |
getJobEndTrigger
Optional. If set, report will be sent when a scan job ends.
Returns | |
---|---|
Type | Description |
JobEndTrigger|null |
hasJobEndTrigger
clearJobEndTrigger
setJobEndTrigger
Optional. If set, report will be sent when a scan job ends.
Parameter | |
---|---|
Name | Description |
var |
JobEndTrigger
|
Returns | |
---|---|
Type | Description |
$this |