Class: OCI::IdentityDomains::Models::ExtensionMessagesError

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/extension_messages_error.rb

Overview

Extension schema for error messages providing more details with the exception status. Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtensionMessagesError

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :message_id (String) —

    The value to assign to the #message_id property

  • :additional_data (Object) —

    The value to assign to the #additional_data property



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 48

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

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

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

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

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

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

Instance Attribute Details

#additional_data ⇒ Object

Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

Returns:

  • (Object) 


18
19
20
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 18

def additional_data
  @additional_data
end

#message_id ⇒ String

Internal error keyword pointing to the exception status message. REQUIRED.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 14

def message_id
  @message_id
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 21

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'message_id': :'messageId',
    'additional_data': :'additionalData'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



31
32
33
34
35
36
37
38
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 31

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'message_id': :'String',
    'additional_data': :'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



74
75
76
77
78
79
80
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 74

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

  self.class == other.class &&
    message_id == other.message_id &&
    additional_data == other.additional_data
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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 105

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


85
86
87
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 85

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



94
95
96
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 94

def hash
  [message_id, additional_data].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 138

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



132
133
134
 
# File 'lib/oci/identity_domains/models/extension_messages_error.rb', line 132

def to_s
  to_hash.to_s
end