Google Cloud Dataplex V1 Client - Class Schedule (0.4.0)
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 Schedule.
The scan is scheduled to run periodically.
Generated from protobuf message google.cloud.dataplex.v1.Trigger.Schedule
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ cron |
string
Required. Cron schedule for running scans periodically. To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia). For example, |
getCron
Required. Cron schedule for running scans periodically.
To explicitly set a timezone in the cron tab, apply a prefix in the
cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
database
(wikipedia).
For example, CRON_TZ=America/New_York 1 * * * *, or
TZ=America/New_York 1 * * * *.
This field is required for Schedule scans.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCron
Required. Cron schedule for running scans periodically.
To explicitly set a timezone in the cron tab, apply a prefix in the
cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
database
(wikipedia).
For example, CRON_TZ=America/New_York 1 * * * *, or
TZ=America/New_York 1 * * * *.
This field is required for Schedule scans.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|