Class: OCI::DataIntegration::Models::RuntimeOperator

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_integration/models/runtime_operator.rb

Overview

Runtime operator model which holds the runtime metadata of the task operator executed.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_NOT_STARTED = 'NOT_STARTED'.freeze,
  STATUS_QUEUED = 'QUEUED'.freeze,
  STATUS_RUNNING = 'RUNNING'.freeze,
  STATUS_TERMINATING = 'TERMINATING'.freeze,
  STATUS_TERMINATED = 'TERMINATED'.freeze,
  STATUS_SUCCESS = 'SUCCESS'.freeze,
  STATUS_ERROR = 'ERROR'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
EXECUTION_STATE_ENUM = 
[
  EXECUTION_STATE_NOT_STARTED = 'NOT_STARTED'.freeze,
  EXECUTION_STATE_RUNNING = 'RUNNING'.freeze,
  EXECUTION_STATE_TERMINATED = 'TERMINATED'.freeze,
  EXECUTION_STATE_SUCCESS = 'SUCCESS'.freeze,
  EXECUTION_STATE_ERROR = 'ERROR'.freeze,
  EXECUTION_STATE_SKIPPED = 'SKIPPED'.freeze,
  EXECUTION_STATE_UNKNOWN = 'UNKNOWN'.freeze,
  EXECUTION_STATE_IGNORED = 'IGNORED'.freeze,
  EXECUTION_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TASK_TYPE_ENUM = 
[
  TASK_TYPE_INTEGRATION_TASK = 'INTEGRATION_TASK'.freeze,
  TASK_TYPE_DATA_LOADER_TASK = 'DATA_LOADER_TASK'.freeze,
  TASK_TYPE_PIPELINE_TASK = 'PIPELINE_TASK'.freeze,
  TASK_TYPE_SQL_TASK = 'SQL_TASK'.freeze,
  TASK_TYPE_OCI_DATAFLOW_TASK = 'OCI_DATAFLOW_TASK'.freeze,
  TASK_TYPE_REST_TASK = 'REST_TASK'.freeze,
  TASK_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OPERATOR_TYPE_ENUM = 
[
  OPERATOR_TYPE_BASH_OPERATOR = 'BASH_OPERATOR'.freeze,
  OPERATOR_TYPE_TASK_OPERATOR = 'TASK_OPERATOR'.freeze,
  OPERATOR_TYPE_REST_OPERATOR = 'REST_OPERATOR'.freeze,
  OPERATOR_TYPE_START_OPERATOR = 'START_OPERATOR'.freeze,
  OPERATOR_TYPE_END_OPERATOR = 'END_OPERATOR'.freeze,
  OPERATOR_TYPE_EXPRESSION_OPERATOR = 'EXPRESSION_OPERATOR'.freeze,
  OPERATOR_TYPE_MERGE_OPERATOR = 'MERGE_OPERATOR'.freeze,
  OPERATOR_TYPE_DECISION_OPERATOR = 'DECISION_OPERATOR'.freeze,
  OPERATOR_TYPE_LOOP_OPERATOR = 'LOOP_OPERATOR'.freeze,
  OPERATOR_TYPE_ACTUAL_END_OPERATOR = 'ACTUAL_END_OPERATOR'.freeze,
  OPERATOR_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RuntimeOperator

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 231

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.key = attributes[:'key'] if attributes[:'key']

  self.task_run_key = attributes[:'taskRunKey'] if attributes[:'taskRunKey']

  raise 'You cannot provide both :taskRunKey and :task_run_key' if attributes.key?(:'taskRunKey') && attributes.key?(:'task_run_key')

  self.task_run_key = attributes[:'task_run_key'] if attributes[:'task_run_key']

  self.start_time_in_millis = attributes[:'startTimeInMillis'] if attributes[:'startTimeInMillis']

  raise 'You cannot provide both :startTimeInMillis and :start_time_in_millis' if attributes.key?(:'startTimeInMillis') && attributes.key?(:'start_time_in_millis')

  self.start_time_in_millis = attributes[:'start_time_in_millis'] if attributes[:'start_time_in_millis']

  self.end_time_in_millis = attributes[:'endTimeInMillis'] if attributes[:'endTimeInMillis']

  raise 'You cannot provide both :endTimeInMillis and :end_time_in_millis' if attributes.key?(:'endTimeInMillis') && attributes.key?(:'end_time_in_millis')

  self.end_time_in_millis = attributes[:'end_time_in_millis'] if attributes[:'end_time_in_millis']

  self.status = attributes[:'status'] if attributes[:'status']

  self.model_type = attributes[:'modelType'] if attributes[:'modelType']

  raise 'You cannot provide both :modelType and :model_type' if attributes.key?(:'modelType') && attributes.key?(:'model_type')

  self.model_type = attributes[:'model_type'] if attributes[:'model_type']

  self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion']

  raise 'You cannot provide both :modelVersion and :model_version' if attributes.key?(:'modelVersion') && attributes.key?(:'model_version')

  self.model_version = attributes[:'model_version'] if attributes[:'model_version']

  self.parent_ref = attributes[:'parentRef'] if attributes[:'parentRef']

  raise 'You cannot provide both :parentRef and :parent_ref' if attributes.key?(:'parentRef') && attributes.key?(:'parent_ref')

  self.parent_ref = attributes[:'parent_ref'] if attributes[:'parent_ref']

  self.name = attributes[:'name'] if attributes[:'name']

  self.object_version = attributes[:'objectVersion'] if attributes[:'objectVersion']

  raise 'You cannot provide both :objectVersion and :object_version' if attributes.key?(:'objectVersion') && attributes.key?(:'object_version')

  self.object_version = attributes[:'object_version'] if attributes[:'object_version']

  self.identifier = attributes[:'identifier'] if attributes[:'identifier']

  self.execution_state = attributes[:'executionState'] if attributes[:'executionState']

  raise 'You cannot provide both :executionState and :execution_state' if attributes.key?(:'executionState') && attributes.key?(:'execution_state')

  self.execution_state = attributes[:'execution_state'] if attributes[:'execution_state']

  self.parameters = attributes[:'parameters'] if attributes[:'parameters']

  self.object_status = attributes[:'objectStatus'] if attributes[:'objectStatus']

  raise 'You cannot provide both :objectStatus and :object_status' if attributes.key?(:'objectStatus') && attributes.key?(:'object_status')

  self.object_status = attributes[:'object_status'] if attributes[:'object_status']

  self.metadata = attributes[:'metadata'] if attributes[:'metadata']

  self.operator = attributes[:'operator'] if attributes[:'operator']

  self.inputs = attributes[:'inputs'] if attributes[:'inputs']

  self.outputs = attributes[:'outputs'] if attributes[:'outputs']

  self.task_type = attributes[:'taskType'] if attributes[:'taskType']

  raise 'You cannot provide both :taskType and :task_type' if attributes.key?(:'taskType') && attributes.key?(:'task_type')

  self.task_type = attributes[:'task_type'] if attributes[:'task_type']

  self.config_provider = attributes[:'configProvider'] if attributes[:'configProvider']

  raise 'You cannot provide both :configProvider and :config_provider' if attributes.key?(:'configProvider') && attributes.key?(:'config_provider')

  self.config_provider = attributes[:'config_provider'] if attributes[:'config_provider']

  self.operator_type = attributes[:'operatorType'] if attributes[:'operatorType']

  raise 'You cannot provide both :operatorType and :operator_type' if attributes.key?(:'operatorType') && attributes.key?(:'operator_type')

  self.operator_type = attributes[:'operator_type'] if attributes[:'operator_type']

  self.metrics = attributes[:'metrics'] if attributes[:'metrics']
end

Instance Attribute Details

#config_provider ⇒ OCI::DataIntegration::Models::ConfigProvider

Returns:



133
134
135
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 133

def config_provider
  @config_provider
end

#end_time_in_millis ⇒ Integer

The runtime operator end time.

Returns:

  • (Integer) 


73
74
75
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 73

def end_time_in_millis
  @end_time_in_millis
end

#execution_state ⇒ String

status

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 104

def execution_state
  @execution_state
end

#identifier ⇒ String

Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 100

def identifier
  @identifier
end

#inputs ⇒ Hash<String, OCI::DataIntegration::Models::ParameterValue>

The configuration provider bindings.

Returns:



122
123
124
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 122

def inputs
  @inputs
end

#key ⇒ String

The RuntimeOperator key.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 61

def key
  @key
end

#metadata ⇒ OCI::DataIntegration::Models::ObjectMetadata

Returns:



115
116
117
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 115

def metadata
  @metadata
end

#metrics ⇒ Hash<String, Float>

A map metrics for the task run.

Returns:

  • (Hash<String, Float>) 


141
142
143
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 141

def metrics
  @metrics
end

#model_type ⇒ String

The type of the object.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 81

def model_type
  @model_type
end

#model_version ⇒ String

The model version of an object.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 85

def model_version
  @model_version
end

#name ⇒ String

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 92

def name
  @name
end

#object_status ⇒ Integer

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:

  • (Integer) 


112
113
114
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 112

def object_status
  @object_status
end

#object_version ⇒ Integer

The version of the object that is used to track changes in the object instance.

Returns:

  • (Integer) 


96
97
98
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 96

def object_version
  @object_version
end

#operator ⇒ OCI::DataIntegration::Models::Operator

Returns:



118
119
120
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 118

def operator
  @operator
end

#operator_type ⇒ String

The type of Runtime Operator

Returns:

  • (String) 


137
138
139
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 137

def operator_type
  @operator_type
end

#outputs ⇒ Hash<String, OCI::DataIntegration::Models::ParameterValue>

The configuration provider bindings.

Returns:



126
127
128
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 126

def outputs
  @outputs
end

#parameters ⇒ Array<OCI::DataIntegration::Models::Parameter>

A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed.

Returns:



108
109
110
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 108

def parameters
  @parameters
end

#parent_ref ⇒ OCI::DataIntegration::Models::ParentReference

Returns:



88
89
90
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 88

def parent_ref
  @parent_ref
end

#start_time_in_millis ⇒ Integer

The runtime operator start time.

Returns:

  • (Integer) 


69
70
71
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 69

def start_time_in_millis
  @start_time_in_millis
end

#status ⇒ String

Status of RuntimeOperator. This field is deprecated, use RuntimeOperator's executionState field instead.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 77

def status
  @status
end

#task_run_key ⇒ String

The TaskRun key.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 65

def task_run_key
  @task_run_key
end

#task_type ⇒ String

The type of task run.

Returns:

  • (String) 


130
131
132
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 130

def task_type
  @task_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 144

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'task_run_key': :'taskRunKey',
    'start_time_in_millis': :'startTimeInMillis',
    'end_time_in_millis': :'endTimeInMillis',
    'status': :'status',
    'model_type': :'modelType',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'object_version': :'objectVersion',
    'identifier': :'identifier',
    'execution_state': :'executionState',
    'parameters': :'parameters',
    'object_status': :'objectStatus',
    'metadata': :'metadata',
    'operator': :'operator',
    'inputs': :'inputs',
    'outputs': :'outputs',
    'task_type': :'taskType',
    'config_provider': :'configProvider',
    'operator_type': :'operatorType',
    'metrics': :'metrics'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 174

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'task_run_key': :'String',
    'start_time_in_millis': :'Integer',
    'end_time_in_millis': :'Integer',
    'status': :'String',
    'model_type': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'object_version': :'Integer',
    'identifier': :'String',
    'execution_state': :'String',
    'parameters': :'Array<OCI::DataIntegration::Models::Parameter>',
    'object_status': :'Integer',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'operator': :'OCI::DataIntegration::Models::Operator',
    'inputs': :'Hash<String, OCI::DataIntegration::Models::ParameterValue>',
    'outputs': :'Hash<String, OCI::DataIntegration::Models::ParameterValue>',
    'task_type': :'String',
    'config_provider': :'OCI::DataIntegration::Models::ConfigProvider',
    'operator_type': :'String',
    'metrics': :'Hash<String, Float>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 389

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key == other.key &&
    task_run_key == other.task_run_key &&
    start_time_in_millis == other.start_time_in_millis &&
    end_time_in_millis == other.end_time_in_millis &&
    status == other.status &&
    model_type == other.model_type &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    object_version == other.object_version &&
    identifier == other.identifier &&
    execution_state == other.execution_state &&
    parameters == other.parameters &&
    object_status == other.object_status &&
    metadata == other.metadata &&
    operator == other.operator &&
    inputs == other.inputs &&
    outputs == other.outputs &&
    task_type == other.task_type &&
    config_provider == other.config_provider &&
    operator_type == other.operator_type &&
    metrics == other.metrics
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 440

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


420
421
422
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 420

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



429
430
431
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 429

def hash
  [key, task_run_key, start_time_in_millis, end_time_in_millis, status, model_type, model_version, parent_ref, name, object_version, identifier, execution_state, parameters, object_status, metadata, operator, inputs, outputs, task_type, config_provider, operator_type, metrics].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



473
474
475
476
477
478
479
480
481
482
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 473

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



467
468
469
 
# File 'lib/oci/data_integration/models/runtime_operator.rb', line 467

def to_s
  to_hash.to_s
end