Class: OCI::Oda::Models::CompositeEntity

Inherits:
Entity
  • Object
show all
Defined in:
lib/oci/oda/models/composite_entity.rb

Overview

Metadata for a composite entity.

Constant Summary

Constants inherited from Entity

Entity::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Entity

#id, #name, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CompositeEntity

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/oda/models/composite_entity.rb', line 62

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'COMPOSITE'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

  self.natural_language_mapping = attributes[:'naturalLanguageMapping'] if attributes[:'naturalLanguageMapping']

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

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

Instance Attribute Details

#actions ⇒ Array<OCI::Oda::Models::EntityAction>

List of entity actions.

Returns:



18
19
20
 
# File 'lib/oci/oda/models/composite_entity.rb', line 18

def actions
  @actions
end

#attributes ⇒ Array<OCI::Oda::Models::EntityAttribute>

[Required] List of entity attributes.

Returns:



14
15
16
 
# File 'lib/oci/oda/models/composite_entity.rb', line 14

def attributes
  @attributes
end

#natural_language_mapping ⇒ OCI::Oda::Models::EntityNaturalLanguageMapping

Returns:



21
22
23
 
# File 'lib/oci/oda/models/composite_entity.rb', line 21

def natural_language_mapping
  @natural_language_mapping
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/oda/models/composite_entity.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'type': :'type',
    'attributes': :'attributes',
    'actions': :'actions',
    'natural_language_mapping': :'naturalLanguageMapping'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/oda/models/composite_entity.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'type': :'String',
    'attributes': :'Array<OCI::Oda::Models::EntityAttribute>',
    'actions': :'Array<OCI::Oda::Models::EntityAction>',
    'natural_language_mapping': :'OCI::Oda::Models::EntityNaturalLanguageMapping'
    # 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



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/oda/models/composite_entity.rb', line 90

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    type == other.type &&
    attributes == other.attributes &&
    actions == other.actions &&
    natural_language_mapping == other.natural_language_mapping
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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/oda/models/composite_entity.rb', line 125

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


105
106
107
 
# File 'lib/oci/oda/models/composite_entity.rb', line 105

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



114
115
116
 
# File 'lib/oci/oda/models/composite_entity.rb', line 114

def hash
  [id, name, type, attributes, actions, natural_language_mapping].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/oda/models/composite_entity.rb', line 158

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



152
153
154
 
# File 'lib/oci/oda/models/composite_entity.rb', line 152

def to_s
  to_hash.to_s
end