Class: OCI::Oda::Models::EntityActionArgument

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

Overview

Argument of an entity action

Constant Summary collapse

TYPE_ENUM =
[
  TYPE_TEXT = 'TEXT'.freeze,
  TYPE_NUMBER = 'NUMBER'.freeze,
  TYPE_DATE_TIME = 'DATE_TIME'.freeze,
  TYPE_DATE = 'DATE'.freeze,
  TYPE_ENTITY = 'ENTITY'.freeze,
  TYPE_COMPOSITE_ENTITY = 'COMPOSITE_ENTITY'.freeze,
  TYPE_ATTRIBUTE_REFERENCE = 'ATTRIBUTE_REFERENCE'.freeze,
  TYPE_BOOLEAN = 'BOOLEAN'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EntityActionArgument

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
# File 'lib/oci/oda/models/entity_action_argument.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.name = attributes[:'name'] if attributes[:'name']

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

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

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

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

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

  self.is_multi_value = attributes[:'isMultiValue'] unless attributes[:'isMultiValue'].nil?

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

  self.is_multi_value = attributes[:'is_multi_value'] unless attributes[:'is_multi_value'].nil?

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

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

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

Instance Attribute Details

#entity_nameString

Name of referenced entity.

Returns:

  • (String)


43
44
45
# File 'lib/oci/oda/models/entity_action_argument.rb', line 43

def entity_name
  @entity_name
end

#is_multi_valueBOOLEAN

Is the entity action argument multi-value

Returns:

  • (BOOLEAN)


39
40
41
# File 'lib/oci/oda/models/entity_action_argument.rb', line 39

def is_multi_value
  @is_multi_value
end

#meta_typeString

Metatype of an entity action argument

Returns:

  • (String)


32
33
34
# File 'lib/oci/oda/models/entity_action_argument.rb', line 32

def meta_type
  @meta_type
end

#nameString

[Required] Name of an entity action argument

Returns:

  • (String)


24
25
26
# File 'lib/oci/oda/models/entity_action_argument.rb', line 24

def name
  @name
end

#natural_language_mappingOCI::Oda::Models::EntityActionArgumentNaturalLanguageMapping



35
36
37
# File 'lib/oci/oda/models/entity_action_argument.rb', line 35

def natural_language_mapping
  @natural_language_mapping
end

#typeString

[Required] Type of an entity action argument

Returns:

  • (String)


28
29
30
# File 'lib/oci/oda/models/entity_action_argument.rb', line 28

def type
  @type
end

Class Method Details

.attribute_mapObject

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/oda/models/entity_action_argument.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'type': :'type',
    'meta_type': :'metaType',
    'natural_language_mapping': :'naturalLanguageMapping',
    'is_multi_value': :'isMultiValue',
    'entity_name': :'entityName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'type': :'String',
    'meta_type': :'String',
    'natural_language_mapping': :'OCI::Oda::Models::EntityActionArgumentNaturalLanguageMapping',
    'is_multi_value': :'BOOLEAN',
    'entity_name': :'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



135
136
137
138
139
140
141
142
143
144
145
# File 'lib/oci/oda/models/entity_action_argument.rb', line 135

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

  self.class == other.class &&
    name == other.name &&
    type == other.type &&
    meta_type == other.meta_type &&
    natural_language_mapping == other.natural_language_mapping &&
    is_multi_value == other.is_multi_value &&
    entity_name == other.entity_name
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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/oci/oda/models/entity_action_argument.rb', line 170

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


150
151
152
# File 'lib/oci/oda/models/entity_action_argument.rb', line 150

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



159
160
161
# File 'lib/oci/oda/models/entity_action_argument.rb', line 159

def hash
  [name, type, meta_type, natural_language_mapping, is_multi_value, entity_name].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



203
204
205
206
207
208
209
210
211
212
# File 'lib/oci/oda/models/entity_action_argument.rb', line 203

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



197
198
199
# File 'lib/oci/oda/models/entity_action_argument.rb', line 197

def to_s
  to_hash.to_s
end