Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Trigger::Schedule.
The scan is scheduled to run periodically.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#cron
defcron()->::String
Returns
(::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.
#cron=
defcron=(value)->::String
Parameter
value (::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.
Returns
(::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 * * * *.
[[["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-04 UTC."],[],[],null,["# Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Trigger::Schedule (v2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/ruby/docs/reference/google-cloud-dataplex-v1/latest/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [2.4.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.4.1/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [2.3.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.3.1/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [2.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.2.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [2.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.1.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [2.0.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.0.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [1.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.4.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [1.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.3.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [1.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.2.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [1.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.1.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [1.0.1](/ruby/docs/reference/google-cloud-dataplex-v1/1.0.1/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.23.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.23.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.22.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.22.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.21.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.21.1/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.20.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.20.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.19.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.19.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.18.2](/ruby/docs/reference/google-cloud-dataplex-v1/0.18.2/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.17.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.17.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.16.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.16.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.15.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.15.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.14.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.14.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.13.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.12.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.11.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.10.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.10.1/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.9.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.8.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.7.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.6.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.6.1/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.5.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.5.1/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.4.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.3.0/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.2.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.2.1/Google-Cloud-Dataplex-V1-Trigger-Schedule)\n- [0.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.1.0/Google-Cloud-Dataplex-V1-Trigger-Schedule) \nReference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Trigger::Schedule.\n\nThe scan is scheduled to run periodically. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #cron\n\n def cron() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. [Cron](https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.\n\n\n To explicitly set a timezone in the cron tab, apply a prefix in the\n cron tab: **\"CRON_TZ=${IANA_TIME_ZONE}\"** or **\"TZ=${IANA_TIME_ZONE}\"** .\n The **${IANA_TIME_ZONE}** may only be a valid string from IANA time zone\n database\n ([wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)).\n For example, `CRON_TZ=America/New_York 1 * * * *`, or\n `TZ=America/New_York 1 * * * *`.\n\n This field is required for Schedule scans.\n\n### #cron=\n\n def cron=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. [Cron](https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.\n\n\n To explicitly set a timezone in the cron tab, apply a prefix in the\n cron tab: **\"CRON_TZ=${IANA_TIME_ZONE}\"** or **\"TZ=${IANA_TIME_ZONE}\"** .\n The **${IANA_TIME_ZONE}** may only be a valid string from IANA time zone\n database\n ([wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)).\n For example, `CRON_TZ=America/New_York 1 * * * *`, or\n `TZ=America/New_York 1 * * * *`.\n\nThis field is required for Schedule scans. \n**Returns**\n\n- (::String) --- Required. [Cron](https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.\n\n\n To explicitly set a timezone in the cron tab, apply a prefix in the\n cron tab: **\"CRON_TZ=${IANA_TIME_ZONE}\"** or **\"TZ=${IANA_TIME_ZONE}\"** .\n The **${IANA_TIME_ZONE}** may only be a valid string from IANA time zone\n database\n ([wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)).\n For example, `CRON_TZ=America/New_York 1 * * * *`, or\n `TZ=America/New_York 1 * * * *`.\n\n This field is required for Schedule scans."]]