Class: OCI::GenerativeAiData::Models::GenerateEnrichmentJobDetails

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

Overview

The details required to create an EnrichmentJob.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateEnrichmentJobDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 85

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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the EnrichmentJob.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 19

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) 


23
24
25
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 23

def display_name
  @display_name
end

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

This attribute is required.

Returns:



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

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) 


27
28
29
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 27

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


37
38
39
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 37

def freeform_tags
  @freeform_tags
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'display_name': :'displayName',
    'enrichment_job_type': :'enrichmentJobType',
    'enrichment_job_configuration': :'enrichmentJobConfiguration',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'display_name': :'String',
    'enrichment_job_type': :'String',
    'enrichment_job_configuration': :'OCI::GenerativeAiData::Models::EnrichmentJobConfiguration',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 139

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

  self.class == other.class &&
    description == other.description &&
    display_name == other.display_name &&
    enrichment_job_type == other.enrichment_job_type &&
    enrichment_job_configuration == other.enrichment_job_configuration &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



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/generative_ai_data/models/generate_enrichment_job_details.rb', line 174

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


154
155
156
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 163

def hash
  [description, display_name, enrichment_job_type, enrichment_job_configuration, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 207

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



201
202
203
 
# File 'lib/oci/generative_ai_data/models/generate_enrichment_job_details.rb', line 201

def to_s
  to_hash.to_s
end