Class: OCI::GenerativeAiData::Models::EnrichmentJob

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_data/models/enrichment_job.rb

Overview

Object representing to EnrichmentJob. ocidEntityType: generativeaiEnrichmentJob adLocality: regional

Constant Summary collapse

ENRICHMENT_JOB_TYPE_ENUM = 
[
  ENRICHMENT_JOB_TYPE_FULL_BUILD = 'FULL_BUILD'.freeze,
  ENRICHMENT_JOB_TYPE_PARTIAL_BUILD = 'PARTIAL_BUILD'.freeze,
  ENRICHMENT_JOB_TYPE_DELTA_REFRESH = 'DELTA_REFRESH'.freeze,
  ENRICHMENT_JOB_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.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 = {}) ⇒ EnrichmentJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 165

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

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

  self.semantic_store_id = attributes[:'semanticStoreId'] if attributes[:'semanticStoreId']

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

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

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

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

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

  self.enrichment_job_configuration = attributes[:'enrichmentJobConfiguration'] if attributes[:'enrichmentJobConfiguration']

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

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

  self.time_accepted = attributes[:'timeAccepted'] if attributes[:'timeAccepted']

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

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

  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_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.percent_complete = attributes[:'percentComplete'] if attributes[:'percentComplete']

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

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

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

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


90
91
92
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 90

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the EnrichmentJob.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 38

def description
  @description
end

#display_name ⇒ String

A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 46

def display_name
  @display_name
end

#enrichment_job_configuration ⇒ OCI::GenerativeAiData::Models::EnrichmentJobConfiguration

This attribute is required.

Returns:



54
55
56
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 54

def enrichment_job_configuration
  @enrichment_job_configuration
end

#enrichment_job_type ⇒ String

[Required] Enrichment job type. Currently supported Full Build (All supported objects in a given schema) and Partial Build (Selected tables and/or supported objects in a given schema).

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 50

def enrichment_job_type
  @enrichment_job_type
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


84
85
86
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 84

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 34

def id
  @id
end

#lifecycle_details ⇒ String

[Required] A message describing the current state in more detail that can provide actionable information.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 70

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The lifecycleState of GenerateSqlJob.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 78

def lifecycle_state
  @lifecycle_state
end

#percent_complete ⇒ Float

The percentage of the enrichment job that has been completed.

Returns:

  • (Float) 


74
75
76
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 74

def percent_complete
  @percent_complete
end

#semantic_store_id ⇒ String

[Required] Owning SemanticStore OCID for an EnrichmentJob.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 42

def semantic_store_id
  @semantic_store_id
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


96
97
98
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 96

def system_tags
  @system_tags
end

#time_accepted ⇒ DateTime

[Required] The date and time that the enrichment job was accepted in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 58

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time that the enrichment job was finished in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 66

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The date and time that the enrichment job was started in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 62

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'description': :'description',
    'semantic_store_id': :'semanticStoreId',
    'display_name': :'displayName',
    'enrichment_job_type': :'enrichmentJobType',
    'enrichment_job_configuration': :'enrichmentJobConfiguration',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'lifecycle_details': :'lifecycleDetails',
    'percent_complete': :'percentComplete',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 122

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'description': :'String',
    'semantic_store_id': :'String',
    'display_name': :'String',
    'enrichment_job_type': :'String',
    'enrichment_job_configuration': :'OCI::GenerativeAiData::Models::EnrichmentJobConfiguration',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'lifecycle_details': :'String',
    'percent_complete': :'Float',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 287

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

  self.class == other.class &&
    id == other.id &&
    description == other.description &&
    semantic_store_id == other.semantic_store_id &&
    display_name == other.display_name &&
    enrichment_job_type == other.enrichment_job_type &&
    enrichment_job_configuration == other.enrichment_job_configuration &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    lifecycle_details == other.lifecycle_details &&
    percent_complete == other.percent_complete &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 331

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


311
312
313
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 311

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



320
321
322
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 320

def hash
  [id, description, semantic_store_id, display_name, enrichment_job_type, enrichment_job_configuration, time_accepted, time_started, time_finished, lifecycle_details, percent_complete, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



364
365
366
367
368
369
370
371
372
373
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 364

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



358
359
360
 
# File 'lib/oci/generative_ai_data/models/enrichment_job.rb', line 358

def to_s
  to_hash.to_s
end