Class: Google::Apis::DataformV1beta1::WorkflowConfig

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

Overview

Represents a Dataform workflow configuration.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkflowConfig

Returns a new instance of WorkflowConfig.



4183
4184
4185
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4183

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

Instance Attribute Details

#create_time ⇒ String

Output only. The timestamp of when the WorkflowConfig was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4120
4121
4122
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4120

def create_time
  @create_time
end

#cron_schedule ⇒ String

Optional. Optional schedule (in cron format) for automatic execution of this workflow config. Corresponds to the JSON property cronSchedule

Returns:

  • (String) 


4126
4127
4128
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4126

def cron_schedule
  @cron_schedule
end

#disabled ⇒ Boolean Also known as: disabled?

Optional. Disables automatic creation of workflow invocations. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


4131
4132
4133
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4131

def disabled
  @disabled
end

#internal_metadata ⇒ String

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. Corresponds to the JSON property internalMetadata

Returns:

  • (String) 


4139
4140
4141
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4139

def internal_metadata
  @internal_metadata
end

#invocation_config ⇒ Google::Apis::DataformV1beta1::InvocationConfig

Includes various configuration options for a workflow invocation. If both included_targets and included_tags are unset, all actions will be included. Corresponds to the JSON property invocationConfig

Returns:



4145
4146
4147
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4145

def invocation_config
  @invocation_config
end

#name ⇒ String

Identifier. The workflow config's name. Corresponds to the JSON property name

Returns:

  • (String) 


4150
4151
4152
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4150

def name
  @name
end

#recent_scheduled_execution_records ⇒ Array<Google::Apis::DataformV1beta1::ScheduledExecutionRecord>

Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. Corresponds to the JSON property recentScheduledExecutionRecords

Returns:



4157
4158
4159
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4157

def recent_scheduled_execution_records
  @recent_scheduled_execution_records
end

#release_config ⇒ String

Required. The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/ */releaseConfigs/*. Corresponds to the JSON property releaseConfig

Returns:

  • (String) 


4164
4165
4166
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4164

def release_config
  @release_config
end

#time_zone ⇒ String

Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/ wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. Corresponds to the JSON property timeZone

Returns:

  • (String) 


4171
4172
4173
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4171

def time_zone
  @time_zone
end

#update_time ⇒ String

Output only. The timestamp of when the WorkflowConfig was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4176
4177
4178
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4176

def update_time
  @update_time
end

#workflow_trigger_config ⇒ Google::Apis::DataformV1beta1::WorkflowTriggerConfig

Represents a trigger configuration for a workflow. Corresponds to the JSON property workflowTriggerConfig

Returns:



4181
4182
4183
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4181

def workflow_trigger_config
  @workflow_trigger_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
 
# File 'lib/google/apis/dataform_v1beta1/classes.rb', line 4188

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @cron_schedule = args[:cron_schedule] if args.key?(:cron_schedule)
  @disabled = args[:disabled] if args.key?(:disabled)
  @internal_metadata = args[:internal_metadata] if args.key?(:internal_metadata)
  @invocation_config = args[:invocation_config] if args.key?(:invocation_config)
  @name = args[:name] if args.key?(:name)
  @recent_scheduled_execution_records = args[:recent_scheduled_execution_records] if args.key?(:recent_scheduled_execution_records)
  @release_config = args[:release_config] if args.key?(:release_config)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @update_time = args[:update_time] if args.key?(:update_time)
  @workflow_trigger_config = args[:workflow_trigger_config] if args.key?(:workflow_trigger_config)
end