Class: GoogleMapsPlatform::ErrorObject

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/google_maps_platform/models/error_object.rb

Overview

ErrorObject Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(code:, message:, errors:, status: SKIP, details: SKIP, additional_properties: nil) ⇒ ErrorObject

Returns a new instance of ErrorObject.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/google_maps_platform/models/error_object.rb', line 57

def initialize(code:, message:, errors:, status: SKIP, details: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @code = code
  @message = message
  @errors = errors
  @status = status unless status == SKIP
  @details = details unless details == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#code ⇒ Float

This is the same as the HTTP status of the response.

Returns:

  • (Float) 


14
15
16
 
# File 'lib/google_maps_platform/models/error_object.rb', line 14

def code
  @code
end

#details ⇒ Array[ErrorDetail]

Additional details about the error.

Returns:



31
32
33
 
# File 'lib/google_maps_platform/models/error_object.rb', line 31

def details
  @details
end

#errors ⇒ Array[ErrorDetail]

A list of errors which occurred. Each error contains an identifier for the type of error and a short description.

Returns:



23
24
25
 
# File 'lib/google_maps_platform/models/error_object.rb', line 23

def errors
  @errors
end

#message ⇒ String

A short description of the error.

Returns:

  • (String) 


18
19
20
 
# File 'lib/google_maps_platform/models/error_object.rb', line 18

def message
  @message
end

#status ⇒ String

A status code that indicates the error type.

Returns:

  • (String) 


27
28
29
 
# File 'lib/google_maps_platform/models/error_object.rb', line 27

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
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
 
# File 'lib/google_maps_platform/models/error_object.rb', line 71

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  code = hash.key?('code') ? hash['code'] : nil
  message = hash.key?('message') ? hash['message'] : nil
  # Parameter is an array, so we need to iterate through it

  errors = nil
  unless hash['errors'].nil?
    errors = []
    hash['errors'].each do |structure|
      errors << (ErrorDetail.from_hash(structure) if structure)
    end
  end

  errors = nil unless hash.key?('errors')
  status = hash.key?('status') ? hash['status'] : SKIP
  # Parameter is an array, so we need to iterate through it

  details = nil
  unless hash['details'].nil?
    details = []
    hash['details'].each do |structure|
      details << (ErrorDetail.from_hash(structure) if structure)
    end
  end

  details = SKIP unless hash.key?('details')

  # Create a new hash for additional properties, removing known properties.

  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.

  ErrorObject.new(code: code,
                  message: message,
                  errors: errors,
                  status: status,
                  details: details,
                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



34
35
36
37
38
39
40
41
42
 
# File 'lib/google_maps_platform/models/error_object.rb', line 34

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['code'] = 'code'
  @_hash['message'] = 'message'
  @_hash['errors'] = 'errors'
  @_hash['status'] = 'status'
  @_hash['details'] = 'details'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



53
54
55
 
# File 'lib/google_maps_platform/models/error_object.rb', line 53

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



45
46
47
48
49
50
 
# File 'lib/google_maps_platform/models/error_object.rb', line 45

def self.optionals
  %w[
    status
    details
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



123
124
125
126
127
128
 
# File 'lib/google_maps_platform/models/error_object.rb', line 123

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} code: #{@code.inspect}, message: #{@message.inspect}, errors:"\
  " #{@errors.inspect}, status: #{@status.inspect}, details: #{@details.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



116
117
118
119
120
 
# File 'lib/google_maps_platform/models/error_object.rb', line 116

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} code: #{@code}, message: #{@message}, errors: #{@errors}, status:"\
  " #{@status}, details: #{@details}, additional_properties: #{@additional_properties}>"
end