Class: OCI::DataCatalog::Models::JobDefinition

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

Overview

Representation of a job definition resource. 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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobDefinition

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

  • :catalog_id (String)

    The value to assign to the #catalog_id property

  • :job_type (String)

    The value to assign to the #job_type property

  • :is_incremental (BOOLEAN)

    The value to assign to the #is_incremental property

  • :data_asset_key (String)

    The value to assign to the #data_asset_key property

  • :description (String)

    The value to assign to the #description property

  • :connection_key (String)

    The value to assign to the #connection_key property

  • :internal_version (String)

    The value to assign to the #internal_version 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_updated (DateTime)

    The value to assign to the #time_updated property

  • :created_by_id (String)

    The value to assign to the #created_by_id property

  • :updated_by_id (String)

    The value to assign to the #updated_by_id property

  • :uri (String)

    The value to assign to the #uri property

  • :is_sample_data_extracted (BOOLEAN)

    The value to assign to the #is_sample_data_extracted property

  • :sample_data_size_in_mbs (Integer)

    The value to assign to the #sample_data_size_in_mbs property

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

    The value to assign to the #properties property



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

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.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.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.is_incremental = attributes[:'isIncremental'] unless attributes[:'isIncremental'].nil?

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

  self.is_incremental = attributes[:'is_incremental'] unless attributes[:'is_incremental'].nil?

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

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

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

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

  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_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  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_id = attributes[:'updatedById'] if attributes[:'updatedById']

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

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

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

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

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

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

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

Instance Attribute Details

#catalog_idString

The data catalog's OCID.

Returns:

  • (String)


25
26
27
# File 'lib/oci/data_catalog/models/job_definition.rb', line 25

def catalog_id
  @catalog_id
end

#connection_keyString

The key of the default connection resource to be used for harvest, sampling, profiling jobs. This may be overridden in each job instance.

Returns:

  • (String)


47
48
49
# File 'lib/oci/data_catalog/models/job_definition.rb', line 47

def connection_key
  @connection_key
end

#created_by_idString

OCID of the user who created this job definition.

Returns:

  • (String)


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

def created_by_id
  @created_by_id
end

#data_asset_keyString

The key of the data asset for which the job is defined.

Returns:

  • (String)


37
38
39
# File 'lib/oci/data_catalog/models/job_definition.rb', line 37

def data_asset_key
  @data_asset_key
end

#descriptionString

Detailed description of the job definition.

Returns:

  • (String)


41
42
43
# File 'lib/oci/data_catalog/models/job_definition.rb', line 41

def description
  @description
end

#display_nameString

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

Returns:

  • (String)


21
22
23
# File 'lib/oci/data_catalog/models/job_definition.rb', line 21

def display_name
  @display_name
end

#internal_versionString

Version of the job definition object. Used internally but can be visible to users.

Returns:

  • (String)


51
52
53
# File 'lib/oci/data_catalog/models/job_definition.rb', line 51

def internal_version
  @internal_version
end

#is_incrementalBOOLEAN

Specifies if the job definition is incremental or full.

Returns:

  • (BOOLEAN)


33
34
35
# File 'lib/oci/data_catalog/models/job_definition.rb', line 33

def is_incremental
  @is_incremental
end

#is_sample_data_extractedBOOLEAN

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

Returns:

  • (BOOLEAN)


81
82
83
# File 'lib/oci/data_catalog/models/job_definition.rb', line 81

def is_sample_data_extracted
  @is_sample_data_extracted
end

#job_typeString

Type of the job definition.

Returns:

  • (String)


29
30
31
# File 'lib/oci/data_catalog/models/job_definition.rb', line 29

def job_type
  @job_type
end

#keyString

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

Returns:

  • (String)


15
16
17
# File 'lib/oci/data_catalog/models/job_definition.rb', line 15

def key
  @key
end

#lifecycle_stateString

Lifecycle state of the job definition.

Returns:

  • (String)


55
56
57
# File 'lib/oci/data_catalog/models/job_definition.rb', line 55

def lifecycle_state
  @lifecycle_state
end

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

A map of maps that contains the properties which are specific to the job type. Each job type definition 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 definitions have required properties within the "default" category. Example: {\"properties\": { \"default\": { \"host\": \"host1\", \"port\": \"1521\", \"database\": \"orcl\"}}}

Returns:

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


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

def properties
  @properties
end

#sample_data_size_in_mbsInteger

Specify the sample data size in MB, specified as number of rows, for this metadata harvest.

Returns:

  • (Integer)


85
86
87
# File 'lib/oci/data_catalog/models/job_definition.rb', line 85

def sample_data_size_in_mbs
  @sample_data_size_in_mbs
end

#time_createdDateTime

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

Returns:

  • (DateTime)


61
62
63
# File 'lib/oci/data_catalog/models/job_definition.rb', line 61

def time_created
  @time_created
end

#time_updatedDateTime

The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


65
66
67
# File 'lib/oci/data_catalog/models/job_definition.rb', line 65

def time_updated
  @time_updated
end

#updated_by_idString

OCID of the user who updated this job definition.

Returns:

  • (String)


73
74
75
# File 'lib/oci/data_catalog/models/job_definition.rb', line 73

def updated_by_id
  @updated_by_id
end

#uriString

URI to the job definition instance in the API.

Returns:

  • (String)


77
78
79
# File 'lib/oci/data_catalog/models/job_definition.rb', line 77

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/oci/data_catalog/models/job_definition.rb', line 97

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'catalog_id': :'catalogId',
    'job_type': :'jobType',
    'is_incremental': :'isIncremental',
    'data_asset_key': :'dataAssetKey',
    'description': :'description',
    'connection_key': :'connectionKey',
    'internal_version': :'internalVersion',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by_id': :'createdById',
    'updated_by_id': :'updatedById',
    'uri': :'uri',
    'is_sample_data_extracted': :'isSampleDataExtracted',
    'sample_data_size_in_mbs': :'sampleDataSizeInMBs',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/oci/data_catalog/models/job_definition.rb', line 123

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'catalog_id': :'String',
    'job_type': :'String',
    'is_incremental': :'BOOLEAN',
    'data_asset_key': :'String',
    'description': :'String',
    'connection_key': :'String',
    'internal_version': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by_id': :'String',
    'updated_by_id': :'String',
    'uri': :'String',
    'is_sample_data_extracted': :'BOOLEAN',
    'sample_data_size_in_mbs': :'Integer',
    '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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/oci/data_catalog/models/job_definition.rb', line 280

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

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    catalog_id == other.catalog_id &&
    job_type == other.job_type &&
    is_incremental == other.is_incremental &&
    data_asset_key == other.data_asset_key &&
    description == other.description &&
    connection_key == other.connection_key &&
    internal_version == other.internal_version &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by_id == other.created_by_id &&
    updated_by_id == other.updated_by_id &&
    uri == other.uri &&
    is_sample_data_extracted == other.is_sample_data_extracted &&
    sample_data_size_in_mbs == other.sample_data_size_in_mbs &&
    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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/oci/data_catalog/models/job_definition.rb', line 327

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


307
308
309
# File 'lib/oci/data_catalog/models/job_definition.rb', line 307

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



316
317
318
# File 'lib/oci/data_catalog/models/job_definition.rb', line 316

def hash
  [key, display_name, catalog_id, job_type, is_incremental, data_asset_key, description, connection_key, internal_version, lifecycle_state, time_created, time_updated, created_by_id, updated_by_id, uri, is_sample_data_extracted, sample_data_size_in_mbs, properties].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



360
361
362
363
364
365
366
367
368
369
# File 'lib/oci/data_catalog/models/job_definition.rb', line 360

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



354
355
356
# File 'lib/oci/data_catalog/models/job_definition.rb', line 354

def to_s
  to_hash.to_s
end