Class: AmznSpApi::ServicesApiModel::Error

Inherits:
Object
  • Object
show all
Defined in:
lib/services_api_model/models/error.rb

Overview

Error response returned when the request is unsuccessful.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Error

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/services_api_model/models/error.rb', line 75

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::ServicesApiModel::Error` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::ServicesApiModel::Error`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.code = attributes[:code] if attributes.key?(:code)

  self.message = attributes[:message] if attributes.key?(:message)

  self.details = attributes[:details] if attributes.key?(:details)

  return unless attributes.key?(:error_level)

  self.error_level = attributes[:error_level]
end

Instance Attribute Details

#code ⇒ Object

An error code that identifies the type of error that occurred.



16
17
18
 
# File 'lib/services_api_model/models/error.rb', line 16

def code
  @code
end

#details ⇒ Object

Additional details that can help the caller understand or fix the issue.



22
23
24
 
# File 'lib/services_api_model/models/error.rb', line 22

def details
  @details
end

#error_level ⇒ Object

The type of error.



25
26
27
 
# File 'lib/services_api_model/models/error.rb', line 25

def error_level
  @error_level
end

#message ⇒ Object

A message that describes the error condition in a human-readable form.



19
20
21
 
# File 'lib/services_api_model/models/error.rb', line 19

def message
  @message
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
 
# File 'lib/services_api_model/models/error.rb', line 49

def self.attribute_map
  {
    'code': :code,
    'message': :message,
    'details': :details,
    'error_level': :errorLevel
  }
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



155
156
157
 
# File 'lib/services_api_model/models/error.rb', line 155

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
 
# File 'lib/services_api_model/models/error.rb', line 69

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
 
# File 'lib/services_api_model/models/error.rb', line 59

def self.openapi_types
  {
    'code': :Object,
    'message': :Object,
    'details': :Object,
    'error_level': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



130
131
132
133
134
135
136
137
138
 
# File 'lib/services_api_model/models/error.rb', line 130

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

  self.class == other.class &&
    code == other.code &&
    message == other.message &&
    details == other.details &&
    error_level == other.error_level
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
217
218
219
 
# File 'lib/services_api_model/models/error.rb', line 184

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    AmznSpApi::ServicesApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/services_api_model/models/error.rb', line 253

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/services_api_model/models/error.rb', line 162

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


142
143
144
 
# File 'lib/services_api_model/models/error.rb', line 142

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



148
149
150
 
# File 'lib/services_api_model/models/error.rb', line 148

def hash
  [code, message, details, error_level].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



98
99
100
101
102
103
104
105
 
# File 'lib/services_api_model/models/error.rb', line 98

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "code", code cannot be nil.') if @code.nil?

  invalid_properties.push('invalid value for "message", message cannot be nil.') if @message.nil?

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



229
230
231
 
# File 'lib/services_api_model/models/error.rb', line 229

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/services_api_model/models/error.rb', line 235

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



223
224
225
 
# File 'lib/services_api_model/models/error.rb', line 223

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



109
110
111
112
113
114
115
116
117
 
# File 'lib/services_api_model/models/error.rb', line 109

def valid?
  return false if @code.nil?
  return false if @message.nil?

  error_level_validator = EnumAttributeValidator.new('Object', %w[ERROR WARNING])
  return false unless error_level_validator.valid?(@error_level)

  true
end