Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Trigger.
DataScan scheduling and trigger settings.
Generated from protobuf message google.cloud.dataplex.v1.Trigger
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ on_demand |
Google\Cloud\Dataplex\V1\Trigger\OnDemand
The scan runs one-time shortly after DataScan Creation. |
↳ schedule |
Google\Cloud\Dataplex\V1\Trigger\Schedule
The scan is scheduled to run periodically. |
getOnDemand
The scan runs one-time shortly after DataScan Creation.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Trigger\OnDemand|null | |
hasOnDemand
setOnDemand
The scan runs one-time shortly after DataScan Creation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Trigger\OnDemand
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchedule
The scan is scheduled to run periodically.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Trigger\Schedule|null | |
hasSchedule
setSchedule
The scan is scheduled to run periodically.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Trigger\Schedule
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMode
| Returns | |
|---|---|
| Type | Description |
string | |