Class: OCI::DataCatalog::Models::JobExecution

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/job_execution.rb

Overview

A job execution is a unit of work being executed on behalf of a job.

Constant Summary collapse

JOB_TYPE_ENUM =
[
  JOB_TYPE_HARVEST = 'HARVEST'.freeze,
  JOB_TYPE_PROFILING = 'PROFILING'.freeze,
  JOB_TYPE_SAMPLING = 'SAMPLING'.freeze,
  JOB_TYPE_PREVIEW = 'PREVIEW'.freeze,
  JOB_TYPE_IMPORT = 'IMPORT'.freeze,
  JOB_TYPE_EXPORT = 'EXPORT'.freeze,
  JOB_TYPE_IMPORT_GLOSSARY = 'IMPORT_GLOSSARY'.freeze,
  JOB_TYPE_EXPORT_GLOSSARY = 'EXPORT_GLOSSARY'.freeze,
  JOB_TYPE_INTERNAL = 'INTERNAL'.freeze,
  JOB_TYPE_PURGE = 'PURGE'.freeze,
  JOB_TYPE_IMMEDIATE = 'IMMEDIATE'.freeze,
  JOB_TYPE_SCHEDULED = 'SCHEDULED'.freeze,
  JOB_TYPE_IMMEDIATE_EXECUTION = 'IMMEDIATE_EXECUTION'.freeze,
  JOB_TYPE_SCHEDULED_EXECUTION = 'SCHEDULED_EXECUTION'.freeze,
  JOB_TYPE_SCHEDULED_EXECUTION_INSTANCE = 'SCHEDULED_EXECUTION_INSTANCE'.freeze,
  JOB_TYPE_ASYNC_DELETE = 'ASYNC_DELETE'.freeze,
  JOB_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATED = 'CREATED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED_WITH_WARNINGS = 'SUCCEEDED_WITH_WARNINGS'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobExecution

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String)

    The value to assign to the #key property

  • :job_key (String)

    The value to assign to the #job_key property

  • :job_type (String)

    The value to assign to the #job_type property

  • :sub_type (String)

    The value to assign to the #sub_type property

  • :parent_key (String)

    The value to assign to the #parent_key property

  • :schedule_instance_key (String)

    The value to assign to the #schedule_instance_key property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_started (DateTime)

    The value to assign to the #time_started property

  • :time_ended (DateTime)

    The value to assign to the #time_ended property

  • :error_code (String)

    The value to assign to the #error_code property

  • :error_message (String)

    The value to assign to the #error_message property

  • :process_key (String)

    The value to assign to the #process_key property

  • :external_url (String)

    The value to assign to the #external_url property

  • :event_key (String)

    The value to assign to the #event_key property

  • :data_entity_key (String)

    The value to assign to the #data_entity_key property

  • :created_by_id (String)

    The value to assign to the #created_by_id property

  • :updated_by (String)

    The value to assign to the #updated_by property

  • :uri (String)

    The value to assign to the #uri property

  • :properties (Hash<String, Hash<String, String>>)

    The value to assign to the #properties property



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
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
329
330
# File 'lib/oci/data_catalog/models/job_execution.rb', line 217

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

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

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

  self.job_type = attributes[:'jobType'] if attributes[:'jobType']

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

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

  self.sub_type = attributes[:'subType'] if attributes[:'subType']

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

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

  self.parent_key = attributes[:'parentKey'] if attributes[:'parentKey']

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

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

  self.schedule_instance_key = attributes[:'scheduleInstanceKey'] if attributes[:'scheduleInstanceKey']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

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

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

  self.error_code = attributes[:'errorCode'] if attributes[:'errorCode']

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

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

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

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

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

  self.process_key = attributes[:'processKey'] if attributes[:'processKey']

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

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

  self.external_url = attributes[:'externalUrl'] if attributes[:'externalUrl']

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

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

  self.event_key = attributes[:'eventKey'] if attributes[:'eventKey']

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

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

  self.data_entity_key = attributes[:'dataEntityKey'] if attributes[:'dataEntityKey']

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

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

  self.created_by_id = attributes[:'createdById'] if attributes[:'createdById']

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

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

  self.updated_by = attributes[:'updatedBy'] if attributes[:'updatedBy']

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

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

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

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

Instance Attribute Details

#created_by_idString

OCID of the user who created the job execution.

Returns:

  • (String)


116
117
118
# File 'lib/oci/data_catalog/models/job_execution.rb', line 116

def created_by_id
  @created_by_id
end

#data_entity_keyString

The key of the associated data entity resource.

Returns:

  • (String)


112
113
114
# File 'lib/oci/data_catalog/models/job_execution.rb', line 112

def data_entity_key
  @data_entity_key
end

#error_codeString

Error code returned from the job execution or null if job is still running or didn't return an error.

Returns:

  • (String)


89
90
91
# File 'lib/oci/data_catalog/models/job_execution.rb', line 89

def error_code
  @error_code
end

#error_messageString

Error message returned from the job execution or null if job is still running or didn't return an error.

Returns:

  • (String)


94
95
96
# File 'lib/oci/data_catalog/models/job_execution.rb', line 94

def error_message
  @error_message
end

#event_keyString

An identifier used for log message correlation.

Returns:

  • (String)


108
109
110
# File 'lib/oci/data_catalog/models/job_execution.rb', line 108

def event_key
  @event_key
end

#external_urlString

If the job is an external process, then a URL of the job for accessing this resource and its status.

Returns:

  • (String)


103
104
105
# File 'lib/oci/data_catalog/models/job_execution.rb', line 103

def external_url
  @external_url
end

#job_keyString

The unique key of the parent job.

Returns:

  • (String)


48
49
50
# File 'lib/oci/data_catalog/models/job_execution.rb', line 48

def job_key
  @job_key
end

#job_typeString

Type of the job execution.

Returns:

  • (String)


52
53
54
# File 'lib/oci/data_catalog/models/job_execution.rb', line 52

def job_type
  @job_type
end

#keyString

[Required] Unique key of the job execution resource.

Returns:

  • (String)


44
45
46
# File 'lib/oci/data_catalog/models/job_execution.rb', line 44

def key
  @key
end

#lifecycle_stateString

Status of the job execution, such as running, paused, or completed.

Returns:

  • (String)


68
69
70
# File 'lib/oci/data_catalog/models/job_execution.rb', line 68

def lifecycle_state
  @lifecycle_state
end

#parent_keyString

The unique key of the parent execution or null if this job execution has no parent.

Returns:

  • (String)


60
61
62
# File 'lib/oci/data_catalog/models/job_execution.rb', line 60

def parent_key
  @parent_key
end

#process_keyString

Process identifier related to the job execution if the job is an external job.

Returns:

  • (String)


98
99
100
# File 'lib/oci/data_catalog/models/job_execution.rb', line 98

def process_key
  @process_key
end

#propertiesHash<String, Hash<String, String>>

A map of maps that contains the execution context properties which are specific to a job execution. Each job execution may define it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job executions have required properties within the "default" category. Example: {\"properties\": { \"default\": { \"host\": \"host1\", \"port\": \"1521\", \"database\": \"orcl\"}}}

Returns:

  • (Hash<String, Hash<String, String>>)


133
134
135
# File 'lib/oci/data_catalog/models/job_execution.rb', line 133

def properties
  @properties
end

#schedule_instance_keyString

The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.

Returns:

  • (String)


64
65
66
# File 'lib/oci/data_catalog/models/job_execution.rb', line 64

def schedule_instance_key
  @schedule_instance_key
end

#sub_typeString

Sub-type of this job execution.

Returns:

  • (String)


56
57
58
# File 'lib/oci/data_catalog/models/job_execution.rb', line 56

def sub_type
  @sub_type
end

#time_createdDateTime

The date and time the job execution was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:

  • (DateTime)


74
75
76
# File 'lib/oci/data_catalog/models/job_execution.rb', line 74

def time_created
  @time_created
end

#time_endedDateTime

Time that the job execution ended or null if it hasn't yet completed. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


84
85
86
# File 'lib/oci/data_catalog/models/job_execution.rb', line 84

def time_ended
  @time_ended
end

#time_startedDateTime

Time that job execution started. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


78
79
80
# File 'lib/oci/data_catalog/models/job_execution.rb', line 78

def time_started
  @time_started
end

#updated_byString

OCID of the user who updated the job execution.

Returns:

  • (String)


120
121
122
# File 'lib/oci/data_catalog/models/job_execution.rb', line 120

def updated_by
  @updated_by
end

#uriString

URI to the job execution instance in the API.

Returns:

  • (String)


124
125
126
# File 'lib/oci/data_catalog/models/job_execution.rb', line 124

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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



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
# File 'lib/oci/data_catalog/models/job_execution.rb', line 136

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'job_key': :'jobKey',
    'job_type': :'jobType',
    'sub_type': :'subType',
    'parent_key': :'parentKey',
    'schedule_instance_key': :'scheduleInstanceKey',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'error_code': :'errorCode',
    'error_message': :'errorMessage',
    'process_key': :'processKey',
    'external_url': :'externalUrl',
    'event_key': :'eventKey',
    'data_entity_key': :'dataEntityKey',
    'created_by_id': :'createdById',
    'updated_by': :'updatedBy',
    'uri': :'uri',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/oci/data_catalog/models/job_execution.rb', line 164

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'job_key': :'String',
    'job_type': :'String',
    'sub_type': :'String',
    'parent_key': :'String',
    'schedule_instance_key': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'error_code': :'String',
    'error_message': :'String',
    'process_key': :'String',
    'external_url': :'String',
    'event_key': :'String',
    'data_entity_key': :'String',
    'created_by_id': :'String',
    'updated_by': :'String',
    'uri': :'String',
    'properties': :'Hash<String, Hash<String, String>>'
    # 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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
# File 'lib/oci/data_catalog/models/job_execution.rb', line 365

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

  self.class == other.class &&
    key == other.key &&
    job_key == other.job_key &&
    job_type == other.job_type &&
    sub_type == other.sub_type &&
    parent_key == other.parent_key &&
    schedule_instance_key == other.schedule_instance_key &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    error_code == other.error_code &&
    error_message == other.error_message &&
    process_key == other.process_key &&
    external_url == other.external_url &&
    event_key == other.event_key &&
    data_entity_key == other.data_entity_key &&
    created_by_id == other.created_by_id &&
    updated_by == other.updated_by &&
    uri == other.uri &&
    properties == other.properties
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



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
# File 'lib/oci/data_catalog/models/job_execution.rb', line 414

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


394
395
396
# File 'lib/oci/data_catalog/models/job_execution.rb', line 394

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



403
404
405
# File 'lib/oci/data_catalog/models/job_execution.rb', line 403

def hash
  [key, job_key, job_type, sub_type, parent_key, schedule_instance_key, lifecycle_state, time_created, time_started, time_ended, error_code, error_message, process_key, external_url, event_key, data_entity_key, created_by_id, updated_by, uri, properties].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



447
448
449
450
451
452
453
454
455
456
# File 'lib/oci/data_catalog/models/job_execution.rb', line 447

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



441
442
443
# File 'lib/oci/data_catalog/models/job_execution.rb', line 441

def to_s
  to_hash.to_s
end