Class: OCI::DataCatalog::Models::CreateJobDefinitionDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/create_job_definition_details.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.

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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateJobDefinitionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description 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

  • :glossary_key (String) —

    The value to assign to the #glossary_key property

  • :connection_key (String) —

    The value to assign to the #connection_key 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



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

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.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.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?
  self.is_incremental = false if is_incremental.nil? && !attributes.key?(:'isIncremental') # rubocop:disable Style/StringLiterals

  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.is_incremental = false if is_incremental.nil? && !attributes.key?(:'isIncremental') && !attributes.key?(:'is_incremental') # rubocop:disable Style/StringLiterals

  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']

  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.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

#connection_key ⇒ String

The key of the connection resource to be used for the job.

Returns:

  • (String) 


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

def connection_key
  @connection_key
end

#data_asset_key ⇒ String

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

Returns:

  • (String) 


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

def data_asset_key
  @data_asset_key
end

#description ⇒ String

Detailed description of the job definition.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 40

def display_name
  @display_name
end

#glossary_key ⇒ String

Unique key of the glossary to which this job applies.

Returns:

  • (String) 


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

def glossary_key
  @glossary_key
end

#is_incremental ⇒ BOOLEAN

Specifies if the job definition is incremental or full.

Returns:

  • (BOOLEAN) 


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

def is_incremental
  @is_incremental
end

#is_sample_data_extracted ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


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

def is_sample_data_extracted
  @is_sample_data_extracted
end

#job_type ⇒ String

[Required] Type of the job definition.

Returns:

  • (String) 


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

def job_type
  @job_type
end

#properties ⇒ Hash<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>>) 


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

def properties
  @properties
end

#sample_data_size_in_mbs ⇒ Integer

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

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 72

def sample_data_size_in_mbs
  @sample_data_size_in_mbs
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 84

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'job_type': :'jobType',
    'is_incremental': :'isIncremental',
    'data_asset_key': :'dataAssetKey',
    'glossary_key': :'glossaryKey',
    'connection_key': :'connectionKey',
    'is_sample_data_extracted': :'isSampleDataExtracted',
    'sample_data_size_in_mbs': :'sampleDataSizeInMBs',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 102

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'job_type': :'String',
    'is_incremental': :'BOOLEAN',
    'data_asset_key': :'String',
    'glossary_key': :'String',
    'connection_key': :'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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 213

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    job_type == other.job_type &&
    is_incremental == other.is_incremental &&
    data_asset_key == other.data_asset_key &&
    glossary_key == other.glossary_key &&
    connection_key == other.connection_key &&
    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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 252

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


232
233
234
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 232

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 241

def hash
  [display_name, description, job_type, is_incremental, data_asset_key, glossary_key, connection_key, is_sample_data_extracted, sample_data_size_in_mbs, properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 285

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



279
280
281
 
# File 'lib/oci/data_catalog/models/create_job_definition_details.rb', line 279

def to_s
  to_hash.to_s
end