Class: OCI::DataIntegration::Models::TaskRunLineageDetails

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

Overview

The task lineage object provides information on the lineage information of a task after execution.

Constant Summary collapse

TASK_EXECUTION_STATUS_ENUM =
[
  TASK_EXECUTION_STATUS_SUCCESS = 'SUCCESS'.freeze,
  TASK_EXECUTION_STATUS_ERROR = 'ERROR'.freeze,
  TASK_EXECUTION_STATUS_TERMINATED = 'TERMINATED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaskRunLineageDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



134
135
136
137
138
139
140
141
142
143
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
172
173
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
202
203
204
205
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 134

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

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

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

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

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

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

  self.is_lineage_gen_completed = attributes[:'isLineageGenCompleted'] unless attributes[:'isLineageGenCompleted'].nil?
  self.is_lineage_gen_completed = false if is_lineage_gen_completed.nil? && !attributes.key?(:'isLineageGenCompleted') # rubocop:disable Style/StringLiterals

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

  self.is_lineage_gen_completed = attributes[:'is_lineage_gen_completed'] unless attributes[:'is_lineage_gen_completed'].nil?
  self.is_lineage_gen_completed = false if is_lineage_gen_completed.nil? && !attributes.key?(:'isLineageGenCompleted') && !attributes.key?(:'is_lineage_gen_completed') # rubocop:disable Style/StringLiterals

  self.task_execution_status = attributes[:'taskExecutionStatus'] if attributes[:'taskExecutionStatus']

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

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

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

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

Instance Attribute Details

#descriptionString

Detailed description for the object.

Returns:

  • (String)


38
39
40
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 38

def description
  @description
end

#flowOCI::DataIntegration::Models::DataFlow



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

def flow
  @flow
end

#is_lineage_gen_completedBOOLEAN

This value is used to track if lineage generation for a task is completed or not.

Returns:

  • (BOOLEAN)


58
59
60
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 58

def is_lineage_gen_completed
  @is_lineage_gen_completed
end

#keyString

The object key.

Returns:

  • (String)


19
20
21
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 19

def key
  @key
end

#metadataOCI::DataIntegration::Models::ObjectMetadata



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

def 
  @metadata
end

#model_typeString

The object type.

Returns:

  • (String)


23
24
25
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 23

def model_type
  @model_type
end

#model_versionString

The object's model version.

Returns:

  • (String)


27
28
29
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 27

def model_version
  @model_version
end

#nameString

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)


34
35
36
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 34

def name
  @name
end

#object_versionInteger

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

Returns:

  • (Integer)


42
43
44
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 42

def object_version
  @object_version
end

#parent_refOCI::DataIntegration::Models::ParentReference



30
31
32
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 30

def parent_ref
  @parent_ref
end

#task_execution_statusString

The status of the task run.

Returns:

  • (String)


62
63
64
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 62

def task_execution_status
  @task_execution_status
end

#task_keyString

The object key.

Returns:

  • (String)


54
55
56
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 54

def task_key
  @task_key
end

#task_nameString

Task name

Returns:

  • (String)


46
47
48
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 46

def task_name
  @task_name
end

#task_typeString

Task name

Returns:

  • (String)


50
51
52
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 50

def task_type
  @task_type
end

Class Method Details

.attribute_mapObject

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'model_type': :'modelType',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'object_version': :'objectVersion',
    'task_name': :'taskName',
    'task_type': :'taskType',
    'task_key': :'taskKey',
    'is_lineage_gen_completed': :'isLineageGenCompleted',
    'task_execution_status': :'taskExecutionStatus',
    'flow': :'flow',
    'metadata': :'metadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'model_type': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'description': :'String',
    'object_version': :'Integer',
    'task_name': :'String',
    'task_type': :'String',
    'task_key': :'String',
    'is_lineage_gen_completed': :'BOOLEAN',
    'task_execution_status': :'String',
    'flow': :'OCI::DataIntegration::Models::DataFlow',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata'
    # 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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 222

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

  self.class == other.class &&
    key == other.key &&
    model_type == other.model_type &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    description == other.description &&
    object_version == other.object_version &&
    task_name == other.task_name &&
    task_type == other.task_type &&
    task_key == other.task_key &&
    is_lineage_gen_completed == other.is_lineage_gen_completed &&
    task_execution_status == other.task_execution_status &&
    flow == other.flow &&
     == other.
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 265

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


245
246
247
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 245

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



254
255
256
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 254

def hash
  [key, model_type, model_version, parent_ref, name, description, object_version, task_name, task_type, task_key, is_lineage_gen_completed, task_execution_status, flow, ].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
307
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 298

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



292
293
294
# File 'lib/oci/data_integration/models/task_run_lineage_details.rb', line 292

def to_s
  to_hash.to_s
end