Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Task::TriggerSpec (v1.0.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Task::TriggerSpec.

Task scheduling and trigger settings.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#disabled

def disabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.

#disabled=

def disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
Returns
  • (::Boolean) — Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.

#max_retries

def max_retries() -> ::Integer
Returns
  • (::Integer) — Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.

#max_retries=

def max_retries=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.
Returns
  • (::Integer) — Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.

#schedule

def schedule() -> ::String
Returns
  • (::String) — Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to 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. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.

#schedule=

def schedule=(value) -> ::String
Parameter
  • value (::String) — Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to 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. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.
Returns
  • (::String) — Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to 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. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Optional. The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Optional. The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.
Returns
  • (::Google::Protobuf::Timestamp) — Optional. The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.

#type

def type() -> ::Google::Cloud::Dataplex::V1::Task::TriggerSpec::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::Dataplex::V1::Task::TriggerSpec::Type
Parameter
Returns