Class: GroupDocsViewerCloud::ApiError

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_viewer_cloud/models/api_error.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiError

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 63

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 }

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

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

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

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

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

end

Instance Attribute Details

#code ⇒ Object

Returns the value of attribute code.



33
34
35
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 33

def code
  @code
end

#date_time ⇒ Object

Returns the value of attribute date_time.



36
37
38
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 36

def date_time
  @date_time
end

#description ⇒ Object

Returns the value of attribute description.



35
36
37
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 35

def description
  @description
end

#inner_error ⇒ Object

Returns the value of attribute inner_error.



37
38
39
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 37

def inner_error
  @inner_error
end

#message ⇒ Object

Returns the value of attribute message.



34
35
36
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 34

def message
  @message
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 40

def self.attribute_map
  {
    :'code' => :'Code',
    :'message' => :'Message',
    :'description' => :'Description',
    :'date_time' => :'DateTime',
    :'inner_error' => :'InnerError'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 51

def self.swagger_types
  {
    :'code' => :'String',
    :'message' => :'String',
    :'description' => :'String',
    :'date_time' => :'DateTime',
    :'inner_error' => :'ApiError'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



106
107
108
109
110
111
112
113
114
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 106

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      code == other.code &&
      message == other.message &&
      description == other.description &&
      date_time == other.date_time &&
      inner_error == other.inner_error
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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 161

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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
    temp_model = GroupDocsViewerCloud.const_get(type).new
    temp_model.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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 228

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 137

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    if type =~ /\AArray<(.*)>/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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    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:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


118
119
120
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 124

def hash
  [code, message, description, date_time, inner_error].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



93
94
95
96
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 93

def list_invalid_properties
  invalid_properties = []
  return 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



208
209
210
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 208

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



214
215
216
217
218
219
220
221
222
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 214

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



202
203
204
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 202

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



130
131
132
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 130

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



100
101
102
 
# File 'lib/groupdocs_viewer_cloud/models/api_error.rb', line 100

def valid?
  return true
end