Class: Google::Cloud::Dataplex::V1::Trigger
- Inherits:
-
Object
- Object
- Google::Cloud::Dataplex::V1::Trigger
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/dataplex/v1/processing.rb
Overview
DataScan scheduling and trigger settings.
Defined Under Namespace
Instance Attribute Summary collapse
-
#on_demand ⇒ ::Google::Cloud::Dataplex::V1::Trigger::OnDemand
The scan runs once via
RunDataScan
API. -
#schedule ⇒ ::Google::Cloud::Dataplex::V1::Trigger::Schedule
The scan is scheduled to run periodically.
Instance Attribute Details
#on_demand ⇒ ::Google::Cloud::Dataplex::V1::Trigger::OnDemand
Returns The scan runs once via RunDataScan
API.
Note: The following fields are mutually exclusive: on_demand
, schedule
. If a field in that set is populated, all other fields in the set will automatically be cleared.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'proto_docs/google/cloud/dataplex/v1/processing.rb', line 35 class Trigger include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The scan runs once via `RunDataScan` API. class OnDemand include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The scan is scheduled to run periodically. # @!attribute [rw] cron # @return [::String] # Required. [Cron](https://en.wikipedia.org/wiki/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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). # For example, `CRON_TZ=America/New_York 1 * * * *`, or # `TZ=America/New_York 1 * * * *`. # # This field is required for Schedule scans. class Schedule include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#schedule ⇒ ::Google::Cloud::Dataplex::V1::Trigger::Schedule
Returns The scan is scheduled to run periodically.
Note: The following fields are mutually exclusive: schedule
, on_demand
. If a field in that set is populated, all other fields in the set will automatically be cleared.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'proto_docs/google/cloud/dataplex/v1/processing.rb', line 35 class Trigger include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The scan runs once via `RunDataScan` API. class OnDemand include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The scan is scheduled to run periodically. # @!attribute [rw] cron # @return [::String] # Required. [Cron](https://en.wikipedia.org/wiki/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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). # For example, `CRON_TZ=America/New_York 1 * * * *`, or # `TZ=America/New_York 1 * * * *`. # # This field is required for Schedule scans. class Schedule include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |