Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskTriggerSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb

Overview

Task scheduling and trigger settings.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1TaskTriggerSpec

Returns a new instance of GoogleCloudDataplexV1TaskTriggerSpec.



2929
2930
2931
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2929

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#disabled ⇒ Boolean Also known as: disabled?

Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


2898
2899
2900
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2898

def disabled
  @disabled
end

#max_retries ⇒ Fixnum

Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task. Corresponds to the JSON property maxRetries

Returns:

  • (Fixnum) 


2905
2906
2907
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2905

def max_retries
  @max_retries
end

#schedule ⇒ 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. Corresponds to the JSON property schedule

Returns:

  • (String) 


2915
2916
2917
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2915

def schedule
  @schedule
end

#start_time ⇒ String

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. Corresponds to the JSON property startTime

Returns:

  • (String) 


2922
2923
2924
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2922

def start_time
  @start_time
end

#type ⇒ String

Required. Immutable. Trigger type of the user-specified Task. Corresponds to the JSON property type

Returns:

  • (String) 


2927
2928
2929
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2927

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2934
2935
2936
2937
2938
2939
2940
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2934

def update!(**args)
  @disabled = args[:disabled] if args.key?(:disabled)
  @max_retries = args[:max_retries] if args.key?(:max_retries)
  @schedule = args[:schedule] if args.key?(:schedule)
  @start_time = args[:start_time] if args.key?(:start_time)
  @type = args[:type] if args.key?(:type)
end