Class: OryClient::GenericErrorContent

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/generic_error_content.rb

Overview

Error response

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ GenericErrorContent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ory-client/models/generic_error_content.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::GenericErrorContent` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::GenericErrorContent`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'debug')
    self.debug = attributes[:'debug']
  end

  if attributes.key?(:'error')
    self.error = attributes[:'error']
  end

  if attributes.key?(:'error_description')
    self.error_description = attributes[:'error_description']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

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

  if attributes.key?(:'status_code')
    self.status_code = attributes[:'status_code']
  end
end

Instance Attribute Details

#debug ⇒ Object

Debug contains debug information. This is usually not available and has to be enabled.



20
21
22
 
# File 'lib/ory-client/models/generic_error_content.rb', line 20

def debug
  @debug
end

#error ⇒ Object

Name is the error name.



23
24
25
 
# File 'lib/ory-client/models/generic_error_content.rb', line 23

def error
  @error
end

#error_description ⇒ Object

Description contains further information on the nature of the error.



26
27
28
 
# File 'lib/ory-client/models/generic_error_content.rb', line 26

def error_description
  @error_description
end

#id ⇒ Object

ID is a unique error ID. feature_not_available ErrFeatureNotAvailable quota_exceeded ErrQuotaExceeded



29
30
31
 
# File 'lib/ory-client/models/generic_error_content.rb', line 29

def id
  @id
end

#message ⇒ Object

Message contains the error message.



32
33
34
 
# File 'lib/ory-client/models/generic_error_content.rb', line 32

def message
  @message
end

#status_code ⇒ Object

Code represents the error status code (404, 403, 401, …).



35
36
37
 
# File 'lib/ory-client/models/generic_error_content.rb', line 35

def status_code
  @status_code
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



72
73
74
 
# File 'lib/ory-client/models/generic_error_content.rb', line 72

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/ory-client/models/generic_error_content.rb', line 77

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ory-client/models/generic_error_content.rb', line 60

def self.attribute_map
  {
    :'debug' => :'debug',
    :'error' => :'error',
    :'error_description' => :'error_description',
    :'id' => :'id',
    :'message' => :'message',
    :'status_code' => :'status_code'
  }
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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ory-client/models/generic_error_content.rb', line 195

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/ory-client/models/generic_error_content.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/ory-client/models/generic_error_content.rb', line 82

def self.openapi_types
  {
    :'debug' => :'String',
    :'error' => :'String',
    :'error_description' => :'String',
    :'id' => :'String',
    :'message' => :'String',
    :'status_code' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/ory-client/models/generic_error_content.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      debug == o.debug &&
      error == o.error &&
      error_description == o.error_description &&
      id == o.id &&
      message == o.message &&
      status_code == o.status_code
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


182
183
184
 
# File 'lib/ory-client/models/generic_error_content.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



188
189
190
 
# File 'lib/ory-client/models/generic_error_content.rb', line 188

def hash
  [debug, error, error_description, id, message, status_code].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



142
143
144
145
146
 
# File 'lib/ory-client/models/generic_error_content.rb', line 142

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/ory-client/models/generic_error_content.rb', line 217

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



150
151
152
153
154
155
 
# File 'lib/ory-client/models/generic_error_content.rb', line 150

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  id_validator = EnumAttributeValidator.new('String', ["feature_not_available", "quota_exceeded"])
  return false unless id_validator.valid?(@id)
  true
end