Class: Google::Cloud::Dataplex::V1::Task::TriggerSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/tasks.rb

Overview

Task scheduling and trigger settings.

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Attribute Details

#disabled ⇒ ::Boolean

Returns 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.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 179

class TriggerSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Determines how often and when the job will run.
  module Type
    # Unspecified trigger type.
    TYPE_UNSPECIFIED = 0

    # The task runs one-time shortly after Task Creation.
    ON_DEMAND = 1

    # The task is scheduled to run periodically.
    RECURRING = 2
  end
end

#max_retries ⇒ ::Integer

Returns 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.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 179

class TriggerSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Determines how often and when the job will run.
  module Type
    # Unspecified trigger type.
    TYPE_UNSPECIFIED = 0

    # The task runs one-time shortly after Task Creation.
    ON_DEMAND = 1

    # The task is scheduled to run periodically.
    RECURRING = 2
  end
end

#schedule ⇒ ::String

Returns 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.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 179

class TriggerSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Determines how often and when the job will run.
  module Type
    # Unspecified trigger type.
    TYPE_UNSPECIFIED = 0

    # The task runs one-time shortly after Task Creation.
    ON_DEMAND = 1

    # The task is scheduled to run periodically.
    RECURRING = 2
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 179

class TriggerSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Determines how often and when the job will run.
  module Type
    # Unspecified trigger type.
    TYPE_UNSPECIFIED = 0

    # The task runs one-time shortly after Task Creation.
    ON_DEMAND = 1

    # The task is scheduled to run periodically.
    RECURRING = 2
  end
end

#type ⇒ ::Google::Cloud::Dataplex::V1::Task::TriggerSpec::Type

Returns Required. Immutable. Trigger type of the user-specified Task.

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 179

class TriggerSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Determines how often and when the job will run.
  module Type
    # Unspecified trigger type.
    TYPE_UNSPECIFIED = 0

    # The task runs one-time shortly after Task Creation.
    ON_DEMAND = 1

    # The task is scheduled to run periodically.
    RECURRING = 2
  end
end