Class: OCI::DataCatalog::Models::RecommendationDetails

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

Overview

Details of a recommendation.

Constant Summary collapse

RECOMMENDATION_TYPE_ENUM =
[
  RECOMMENDATION_TYPE_LINK_GLOSSARY_TERM = 'LINK_GLOSSARY_TERM'.freeze,
  RECOMMENDATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
RECOMMENDATION_STATUS_ENUM =
[
  RECOMMENDATION_STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  RECOMMENDATION_STATUS_REJECTED = 'REJECTED'.freeze,
  RECOMMENDATION_STATUS_INFERRED = 'INFERRED'.freeze,
  RECOMMENDATION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SOURCE_OBJECT_TYPE_ENUM =
[
  SOURCE_OBJECT_TYPE_DATA_ENTITY = 'DATA_ENTITY'.freeze,
  SOURCE_OBJECT_TYPE_ATTRIBUTE = 'ATTRIBUTE'.freeze,
  SOURCE_OBJECT_TYPE_TERM = 'TERM'.freeze,
  SOURCE_OBJECT_TYPE_CATEGORY = 'CATEGORY'.freeze,
  SOURCE_OBJECT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TARGET_OBJECT_TYPE_ENUM =
[
  TARGET_OBJECT_TYPE_DATA_ENTITY = 'DATA_ENTITY'.freeze,
  TARGET_OBJECT_TYPE_ATTRIBUTE = 'ATTRIBUTE'.freeze,
  TARGET_OBJECT_TYPE_TERM = 'TERM'.freeze,
  TARGET_OBJECT_TYPE_CATEGORY = 'CATEGORY'.freeze,
  TARGET_OBJECT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecommendationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 149

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

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

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

  self.recommendation_type = attributes[:'recommendationType'] if attributes[:'recommendationType']

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

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

  self.recommendation_status = attributes[:'recommendationStatus'] if attributes[:'recommendationStatus']

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

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

  self.confidence_score = attributes[:'confidenceScore'] if attributes[:'confidenceScore']

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

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

  self.source_object_key = attributes[:'sourceObjectKey'] if attributes[:'sourceObjectKey']

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

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

  self.source_object_name = attributes[:'sourceObjectName'] if attributes[:'sourceObjectName']

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

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

  self.source_object_type = attributes[:'sourceObjectType'] if attributes[:'sourceObjectType']

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

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

  self.target_object_key = attributes[:'targetObjectKey'] if attributes[:'targetObjectKey']

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

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

  self.target_object_name = attributes[:'targetObjectName'] if attributes[:'targetObjectName']

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

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

  self.target_object_type = attributes[:'targetObjectType'] if attributes[:'targetObjectType']

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

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

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

Instance Attribute Details

#confidence_scoreFloat

Level of confidence, on a scale between 0 and 1, that the recommendation is applicable.

Returns:

  • (Float)


54
55
56
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 54

def confidence_score
  @confidence_score
end

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

A map of maps that contains additional properties which are specific to the associated objects. Each associated object defines it's set of required and optional properties. Example: { \"DataEntity\": { \"parentId\": \"entityId\" }, \"Term\": { \"parentId\": \"glossaryId\" } }

Returns:

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


92
93
94
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 92

def properties
  @properties
end

#recommendation_keyString

[Required] Unique identifier of the recommendation.

Returns:

  • (String)


42
43
44
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 42

def recommendation_key
  @recommendation_key
end

#recommendation_statusString

[Required] Status of a recommendation.

Returns:

  • (String)


50
51
52
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 50

def recommendation_status
  @recommendation_status
end

#recommendation_typeString

[Required] Type of recommendation.

Returns:

  • (String)


46
47
48
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 46

def recommendation_type
  @recommendation_type
end

#source_object_keyString

Unique identifier of the source object; the one for which a recommendation is made.

Returns:

  • (String)


58
59
60
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 58

def source_object_key
  @source_object_key
end

#source_object_nameString

Name of the source object; the one for which a recommendation is made.

Returns:

  • (String)


62
63
64
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 62

def source_object_name
  @source_object_name
end

#source_object_typeString

Type of the source object; the one for which a recommendation is made.

Returns:

  • (String)


66
67
68
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 66

def source_object_type
  @source_object_type
end

#target_object_keyString

Unique identifier of the target object; the one which has been recommended.

Returns:

  • (String)


70
71
72
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 70

def target_object_key
  @target_object_key
end

#target_object_nameString

Name of the target object; the one which has been recommended.

Returns:

  • (String)


74
75
76
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 74

def target_object_name
  @target_object_name
end

#target_object_typeString

Type of the target object; the one which has been recommended.

Returns:

  • (String)


78
79
80
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 78

def target_object_type
  @target_object_type
end

Class Method Details

.attribute_mapObject

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 95

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'recommendation_key': :'recommendationKey',
    'recommendation_type': :'recommendationType',
    'recommendation_status': :'recommendationStatus',
    'confidence_score': :'confidenceScore',
    'source_object_key': :'sourceObjectKey',
    'source_object_name': :'sourceObjectName',
    'source_object_type': :'sourceObjectType',
    'target_object_key': :'targetObjectKey',
    'target_object_name': :'targetObjectName',
    'target_object_type': :'targetObjectType',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 114

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'recommendation_key': :'String',
    'recommendation_type': :'String',
    'recommendation_status': :'String',
    'confidence_score': :'Float',
    'source_object_key': :'String',
    'source_object_name': :'String',
    'source_object_type': :'String',
    'target_object_key': :'String',
    'target_object_name': :'String',
    'target_object_type': :'String',
    '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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 277

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

  self.class == other.class &&
    recommendation_key == other.recommendation_key &&
    recommendation_type == other.recommendation_type &&
    recommendation_status == other.recommendation_status &&
    confidence_score == other.confidence_score &&
    source_object_key == other.source_object_key &&
    source_object_name == other.source_object_name &&
    source_object_type == other.source_object_type &&
    target_object_key == other.target_object_key &&
    target_object_name == other.target_object_name &&
    target_object_type == other.target_object_type &&
    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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 317

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


297
298
299
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 297

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



306
307
308
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 306

def hash
  [recommendation_key, recommendation_type, recommendation_status, confidence_score, source_object_key, source_object_name, source_object_type, target_object_key, target_object_name, target_object_type, properties].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



350
351
352
353
354
355
356
357
358
359
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 350

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



344
345
346
# File 'lib/oci/data_catalog/models/recommendation_details.rb', line 344

def to_s
  to_hash.to_s
end