Class: OCI::GenerativeAiData::Models::EnrichmentJobSummary

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

Overview

Object representing EnrichmentJobSummary resource.

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 = {}) ⇒ EnrichmentJobSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :semantic_store_id (String) —

    The value to assign to the #semantic_store_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :enrichment_job_type (String) —

    The value to assign to the #enrichment_job_type property

  • :time_accepted (DateTime) —

    The value to assign to the #time_accepted property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 120

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


63
64
65
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 63

def defined_tags
  @defined_tags
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) 


39
40
41
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 39

def display_name
  @display_name
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) 


43
44
45
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 43

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


57
58
59
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 57

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 31

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The lifecycleState of GenerateSqlJob.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 51

def lifecycle_state
  @lifecycle_state
end

#semantic_store_id ⇒ String

[Required] Owning SemanticStore OCID for a GenerateSqlJob.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 35

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


69
70
71
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 69

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) 


47
48
49
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 47

def time_accepted
  @time_accepted
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'semantic_store_id': :'semanticStoreId',
    'display_name': :'displayName',
    'enrichment_job_type': :'enrichmentJobType',
    'time_accepted': :'timeAccepted',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 89

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'semantic_store_id': :'String',
    'display_name': :'String',
    'enrichment_job_type': :'String',
    'time_accepted': :'DateTime',
    '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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 210

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

  self.class == other.class &&
    id == other.id &&
    semantic_store_id == other.semantic_store_id &&
    display_name == other.display_name &&
    enrichment_job_type == other.enrichment_job_type &&
    time_accepted == other.time_accepted &&
    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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 248

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


228
229
230
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 228

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



237
238
239
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 237

def hash
  [id, semantic_store_id, display_name, enrichment_job_type, time_accepted, 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



281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 281

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



275
276
277
 
# File 'lib/oci/generative_ai_data/models/enrichment_job_summary.rb', line 275

def to_s
  to_hash.to_s
end