Class: OCI::DataIntegration::Models::Task

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

Overview

The task type contains the audit summary information and the definition of the task. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

MODEL_TYPE_ENUM = 
[
  MODEL_TYPE_INTEGRATION_TASK = 'INTEGRATION_TASK'.freeze,
  MODEL_TYPE_DATA_LOADER_TASK = 'DATA_LOADER_TASK'.freeze,
  MODEL_TYPE_PIPELINE_TASK = 'PIPELINE_TASK'.freeze,
  MODEL_TYPE_SQL_TASK = 'SQL_TASK'.freeze,
  MODEL_TYPE_OCI_DATAFLOW_TASK = 'OCI_DATAFLOW_TASK'.freeze,
  MODEL_TYPE_REST_TASK = 'REST_TASK'.freeze,
  MODEL_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 = {}) ⇒ Task

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
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
 
# File 'lib/oci/data_integration/models/task.rb', line 186

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.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.key = attributes[:'key'] if attributes[:'key']

  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.description = attributes[:'description'] if attributes[:'description']

  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.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.identifier = attributes[:'identifier'] if attributes[:'identifier']

  self.input_ports = attributes[:'inputPorts'] if attributes[:'inputPorts']

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

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

  self.output_ports = attributes[:'outputPorts'] if attributes[:'outputPorts']

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

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

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

  self.op_config_values = attributes[:'opConfigValues'] if attributes[:'opConfigValues']

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

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

  self.config_provider_delegate = attributes[:'configProviderDelegate'] if attributes[:'configProviderDelegate']

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

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

  self.is_concurrent_allowed = attributes[:'isConcurrentAllowed'] unless attributes[:'isConcurrentAllowed'].nil?
  self.is_concurrent_allowed = true if is_concurrent_allowed.nil? && !attributes.key?(:'isConcurrentAllowed') # rubocop:disable Style/StringLiterals

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

  self.is_concurrent_allowed = attributes[:'is_concurrent_allowed'] unless attributes[:'is_concurrent_allowed'].nil?
  self.is_concurrent_allowed = true if is_concurrent_allowed.nil? && !attributes.key?(:'isConcurrentAllowed') && !attributes.key?(:'is_concurrent_allowed') # rubocop:disable Style/StringLiterals

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

  self.key_map = attributes[:'keyMap'] if attributes[:'keyMap']

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

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

  self.registry_metadata = attributes[:'registryMetadata'] if attributes[:'registryMetadata']

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

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

Instance Attribute Details

#config_provider_delegate ⇒ OCI::DataIntegration::Models::ConfigProvider

Returns:



74
75
76
 
# File 'lib/oci/data_integration/models/task.rb', line 74

def config_provider_delegate
  @config_provider_delegate
end

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/data_integration/models/task.rb', line 44

def description
  @description
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) 


56
57
58
 
# File 'lib/oci/data_integration/models/task.rb', line 56

def identifier
  @identifier
end

#input_ports ⇒ Array<OCI::DataIntegration::Models::InputPort>

An array of input ports.

Returns:



60
61
62
 
# File 'lib/oci/data_integration/models/task.rb', line 60

def input_ports
  @input_ports
end

#is_concurrent_allowed ⇒ BOOLEAN

Whether the same task can be executed concurrently.

Returns:

  • (BOOLEAN) 


78
79
80
 
# File 'lib/oci/data_integration/models/task.rb', line 78

def is_concurrent_allowed
  @is_concurrent_allowed
end

#key ⇒ String

Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_integration/models/task.rb', line 29

def key
  @key
end

#key_map ⇒ Hash<String, String>

A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Returns:

  • (Hash<String, String>) 


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

def key_map
  @key_map
end

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

Returns:



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

def metadata
  @metadata
end

#model_type ⇒ String

The type of the task.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_integration/models/task.rb', line 25

def model_type
  @model_type
end

#model_version ⇒ String

The object's model version.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_integration/models/task.rb', line 33

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) 


40
41
42
 
# File 'lib/oci/data_integration/models/task.rb', line 40

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) 


52
53
54
 
# File 'lib/oci/data_integration/models/task.rb', line 52

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) 


48
49
50
 
# File 'lib/oci/data_integration/models/task.rb', line 48

def object_version
  @object_version
end

#op_config_values ⇒ OCI::DataIntegration::Models::ConfigValues

Returns:



71
72
73
 
# File 'lib/oci/data_integration/models/task.rb', line 71

def op_config_values
  @op_config_values
end

#output_ports ⇒ Array<OCI::DataIntegration::Models::OutputPort>

An array of output ports.

Returns:



64
65
66
 
# File 'lib/oci/data_integration/models/task.rb', line 64

def output_ports
  @output_ports
end

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

An array of parameters.

Returns:



68
69
70
 
# File 'lib/oci/data_integration/models/task.rb', line 68

def parameters
  @parameters
end

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

Returns:



36
37
38
 
# File 'lib/oci/data_integration/models/task.rb', line 36

def parent_ref
  @parent_ref
end

#registry_metadata ⇒ OCI::DataIntegration::Models::RegistryMetadata

Returns:



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

def registry_metadata
  @registry_metadata
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/data_integration/models/task.rb', line 91

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'object_version': :'objectVersion',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'input_ports': :'inputPorts',
    'output_ports': :'outputPorts',
    'parameters': :'parameters',
    'op_config_values': :'opConfigValues',
    'config_provider_delegate': :'configProviderDelegate',
    'is_concurrent_allowed': :'isConcurrentAllowed',
    'metadata': :'metadata',
    'key_map': :'keyMap',
    'registry_metadata': :'registryMetadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/data_integration/models/task.rb', line 147

def self.get_subtype(object_hash)
  type = object_hash[:'modelType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DataIntegration::Models::TaskFromPipelineTaskDetails' if type == 'PIPELINE_TASK'
  return 'OCI::DataIntegration::Models::TaskFromIntegrationTaskDetails' if type == 'INTEGRATION_TASK'
  return 'OCI::DataIntegration::Models::TaskFromSQLTaskDetails' if type == 'SQL_TASK'
  return 'OCI::DataIntegration::Models::TaskFromRestTaskDetails' if type == 'REST_TASK'
  return 'OCI::DataIntegration::Models::TaskFromOCIDataflowTaskDetails' if type == 'OCI_DATAFLOW_TASK'
  return 'OCI::DataIntegration::Models::TaskFromDataLoaderTaskDetails' if type == 'DATA_LOADER_TASK'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DataIntegration::Models::Task'
end

.swagger_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/data_integration/models/task.rb', line 117

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'description': :'String',
    'object_version': :'Integer',
    'object_status': :'Integer',
    'identifier': :'String',
    'input_ports': :'Array<OCI::DataIntegration::Models::InputPort>',
    'output_ports': :'Array<OCI::DataIntegration::Models::OutputPort>',
    'parameters': :'Array<OCI::DataIntegration::Models::Parameter>',
    'op_config_values': :'OCI::DataIntegration::Models::ConfigValues',
    'config_provider_delegate': :'OCI::DataIntegration::Models::ConfigProvider',
    'is_concurrent_allowed': :'BOOLEAN',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'key_map': :'Hash<String, String>',
    'registry_metadata': :'OCI::DataIntegration::Models::RegistryMetadata'
    # 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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/data_integration/models/task.rb', line 299

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

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    description == other.description &&
    object_version == other.object_version &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    input_ports == other.input_ports &&
    output_ports == other.output_ports &&
    parameters == other.parameters &&
    op_config_values == other.op_config_values &&
    config_provider_delegate == other.config_provider_delegate &&
    is_concurrent_allowed == other.is_concurrent_allowed &&
    metadata == other.metadata &&
    key_map == other.key_map &&
    registry_metadata == other.registry_metadata
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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/data_integration/models/task.rb', line 346

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


326
327
328
 
# File 'lib/oci/data_integration/models/task.rb', line 326

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



335
336
337
 
# File 'lib/oci/data_integration/models/task.rb', line 335

def hash
  [model_type, key, model_version, parent_ref, name, description, object_version, object_status, identifier, input_ports, output_ports, parameters, op_config_values, config_provider_delegate, is_concurrent_allowed, metadata, key_map, registry_metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/data_integration/models/task.rb', line 379

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



373
374
375
 
# File 'lib/oci/data_integration/models/task.rb', line 373

def to_s
  to_hash.to_s
end