Class: OCI::DataCatalog::Models::JobDefinitionSummary

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

Overview

A list of job definition resources. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.

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_IMPORT_DATA_ASSET = 'IMPORT_DATA_ASSET'.freeze,
  JOB_TYPE_CREATE_SCAN_PROXY = 'CREATE_SCAN_PROXY'.freeze,
  JOB_TYPE_ASYNC_EXPORT_GLOSSARY = 'ASYNC_EXPORT_GLOSSARY'.freeze,
  JOB_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_MOVING = 'MOVING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
JOB_EXECUTION_STATE_ENUM = 
[
  JOB_EXECUTION_STATE_CREATED = 'CREATED'.freeze,
  JOB_EXECUTION_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  JOB_EXECUTION_STATE_INACTIVE = 'INACTIVE'.freeze,
  JOB_EXECUTION_STATE_FAILED = 'FAILED'.freeze,
  JOB_EXECUTION_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  JOB_EXECUTION_STATE_CANCELED = 'CANCELED'.freeze,
  JOB_EXECUTION_STATE_SUCCEEDED_WITH_WARNINGS = 'SUCCEEDED_WITH_WARNINGS'.freeze,
  JOB_EXECUTION_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SCHEDULE_TYPE_ENUM = 
[
  SCHEDULE_TYPE_SCHEDULED = 'SCHEDULED'.freeze,
  SCHEDULE_TYPE_IMMEDIATE = 'IMMEDIATE'.freeze,
  SCHEDULE_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 = {}) ⇒ JobDefinitionSummary

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :catalog_id (String) —

    The value to assign to the #catalog_id property

  • :uri (String) —

    The value to assign to the #uri property

  • :job_type (String) —

    The value to assign to the #job_type property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :is_sample_data_extracted (BOOLEAN) —

    The value to assign to the #is_sample_data_extracted property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :connection_key (String) —

    The value to assign to the #connection_key property

  • :time_latest_execution_started (DateTime) —

    The value to assign to the #time_latest_execution_started property

  • :time_latest_execution_ended (DateTime) —

    The value to assign to the #time_latest_execution_ended property

  • :job_execution_state (String) —

    The value to assign to the #job_execution_state property

  • :schedule_type (String) —

    The value to assign to the #schedule_type property

  • :data_asset_key (String) —

    The value to assign to the #data_asset_key property

  • :glossary_key (String) —

    The value to assign to the #glossary_key property



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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 208

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

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

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

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

  self.catalog_id = attributes[:'catalogId'] if attributes[:'catalogId']

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

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

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

  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.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.is_sample_data_extracted = attributes[:'isSampleDataExtracted'] unless attributes[:'isSampleDataExtracted'].nil?
  self.is_sample_data_extracted = true if is_sample_data_extracted.nil? && !attributes.key?(:'isSampleDataExtracted') # rubocop:disable Style/StringLiterals

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

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

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

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

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

  self.time_latest_execution_started = attributes[:'timeLatestExecutionStarted'] if attributes[:'timeLatestExecutionStarted']

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

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

  self.time_latest_execution_ended = attributes[:'timeLatestExecutionEnded'] if attributes[:'timeLatestExecutionEnded']

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

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

  self.job_execution_state = attributes[:'jobExecutionState'] if attributes[:'jobExecutionState']

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

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

  self.schedule_type = attributes[:'scheduleType'] if attributes[:'scheduleType']

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

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

  self.data_asset_key = attributes[:'dataAssetKey'] if attributes[:'dataAssetKey']

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

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

  self.glossary_key = attributes[:'glossaryKey'] if attributes[:'glossaryKey']

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

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

Instance Attribute Details

#catalog_id ⇒ String

The data catalog's OCID.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 83

def catalog_id
  @catalog_id
end

#connection_key ⇒ String

The key of the connection resource used in harvest, sampling, profiling jobs.

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 110

def connection_key
  @connection_key
end

#data_asset_key ⇒ String

Unique key of the data asset to which this job applies, if the job involves a data asset.

Returns:

  • (String) 


132
133
134
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 132

def data_asset_key
  @data_asset_key
end

#description ⇒ String

Detailed description of the job definition.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 79

def description
  @description
end

#display_name ⇒ String

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 75

def display_name
  @display_name
end

#glossary_key ⇒ String

Unique key of the glossary to which this job applies, if the job involves a glossary.

Returns:

  • (String) 


136
137
138
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 136

def glossary_key
  @glossary_key
end

#is_sample_data_extracted ⇒ BOOLEAN

Specify if sample data to be extracted as part of this harvest.

Returns:

  • (BOOLEAN) 


99
100
101
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 99

def is_sample_data_extracted
  @is_sample_data_extracted
end

#job_execution_state ⇒ String

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

Returns:

  • (String) 


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

def job_execution_state
  @job_execution_state
end

#job_type ⇒ String

Type of the job definition.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 91

def job_type
  @job_type
end

#key ⇒ String

[Required] Unique key of the job definition resource that is immutable.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 69

def key
  @key
end

#lifecycle_state ⇒ String

Lifecycle state of the job definition.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 95

def lifecycle_state
  @lifecycle_state
end

#schedule_type ⇒ String

Type of job schedule for the latest job executed.

Returns:

  • (String) 


128
129
130
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 128

def schedule_type
  @schedule_type
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


105
106
107
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 105

def time_created
  @time_created
end

#time_latest_execution_ended ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_latest_execution_ended
  @time_latest_execution_ended
end

#time_latest_execution_started ⇒ DateTime

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

Returns:

  • (DateTime) 


114
115
116
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 114

def time_latest_execution_started
  @time_latest_execution_started
end

#uri ⇒ String

URI to the job definition instance in the API.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 87

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 139

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'description': :'description',
    'catalog_id': :'catalogId',
    'uri': :'uri',
    'job_type': :'jobType',
    'lifecycle_state': :'lifecycleState',
    'is_sample_data_extracted': :'isSampleDataExtracted',
    'time_created': :'timeCreated',
    'connection_key': :'connectionKey',
    'time_latest_execution_started': :'timeLatestExecutionStarted',
    'time_latest_execution_ended': :'timeLatestExecutionEnded',
    'job_execution_state': :'jobExecutionState',
    'schedule_type': :'scheduleType',
    'data_asset_key': :'dataAssetKey',
    'glossary_key': :'glossaryKey'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 163

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'description': :'String',
    'catalog_id': :'String',
    'uri': :'String',
    'job_type': :'String',
    'lifecycle_state': :'String',
    'is_sample_data_extracted': :'BOOLEAN',
    'time_created': :'DateTime',
    'connection_key': :'String',
    'time_latest_execution_started': :'DateTime',
    'time_latest_execution_ended': :'DateTime',
    'job_execution_state': :'String',
    'schedule_type': :'String',
    'data_asset_key': :'String',
    'glossary_key': :'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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 360

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

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    description == other.description &&
    catalog_id == other.catalog_id &&
    uri == other.uri &&
    job_type == other.job_type &&
    lifecycle_state == other.lifecycle_state &&
    is_sample_data_extracted == other.is_sample_data_extracted &&
    time_created == other.time_created &&
    connection_key == other.connection_key &&
    time_latest_execution_started == other.time_latest_execution_started &&
    time_latest_execution_ended == other.time_latest_execution_ended &&
    job_execution_state == other.job_execution_state &&
    schedule_type == other.schedule_type &&
    data_asset_key == other.data_asset_key &&
    glossary_key == other.glossary_key
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



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 405

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


385
386
387
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 385

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [key, display_name, description, catalog_id, uri, job_type, lifecycle_state, is_sample_data_extracted, time_created, connection_key, time_latest_execution_started, time_latest_execution_ended, job_execution_state, schedule_type, data_asset_key, glossary_key].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



438
439
440
441
442
443
444
445
446
447
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 438

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



432
433
434
 
# File 'lib/oci/data_catalog/models/job_definition_summary.rb', line 432

def to_s
  to_hash.to_s
end