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
Namespace
Google \ Cloud \ Dataplex \ V1 \ Trigger
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, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for Schedule scans.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class Schedule (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.Trigger.Schedule)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.Trigger.Schedule)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.Trigger.Schedule)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.Trigger.Schedule)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.Trigger.Schedule)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.Trigger.Schedule)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.Trigger.Schedule)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.Trigger.Schedule)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.Trigger.Schedule)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.Trigger.Schedule)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.Trigger.Schedule)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.Trigger.Schedule)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.Trigger.Schedule)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.Trigger.Schedule)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.Trigger.Schedule)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.Trigger.Schedule)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.Trigger.Schedule)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.Trigger.Schedule)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.Trigger.Schedule)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.Trigger.Schedule)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.Trigger.Schedule)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.Trigger.Schedule)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.Trigger.Schedule)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.Trigger.Schedule) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class Schedule.\n\nThe scan is scheduled to run periodically.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.Trigger.Schedule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1 \\\\ Trigger\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCron\n\nRequired. [Cron](https://en.wikipedia.org/wiki/Cron) schedule for running\nscans periodically.\n\nTo explicitly set a timezone in the cron tab, apply a prefix in the\ncron tab: **\"CRON_TZ=${IANA_TIME_ZONE}\"** or **\"TZ=${IANA_TIME_ZONE}\"** .\nThe **${IANA_TIME_ZONE}** may only be a valid string from IANA time zone\ndatabase\n([wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)).\nFor example, `CRON_TZ=America/New_York 1 * * * *`, or\n`TZ=America/New_York 1 * * * *`.\nThis field is required for Schedule scans.\n\n### setCron\n\nRequired. [Cron](https://en.wikipedia.org/wiki/Cron) schedule for running\nscans periodically.\n\nTo explicitly set a timezone in the cron tab, apply a prefix in the\ncron tab: **\"CRON_TZ=${IANA_TIME_ZONE}\"** or **\"TZ=${IANA_TIME_ZONE}\"** .\nThe **${IANA_TIME_ZONE}** may only be a valid string from IANA time zone\ndatabase\n([wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)).\nFor example, `CRON_TZ=America/New_York 1 * * * *`, or\n`TZ=America/New_York 1 * * * *`.\nThis field is required for Schedule scans."]]
