Class: GoogleMapsPlatform::SnapToRoadsResponse

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

Overview

SnapToRoadsResponse 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(snapped_points: SKIP, warning_message: SKIP, additional_properties: nil) ⇒ SnapToRoadsResponse 



41
42
43
44
45
46
47
48
49
 
# File 'lib/google_maps_platform/models/snap_to_roads_response.rb', line 41

def initialize(snapped_points: SKIP, warning_message: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @snapped_points = snapped_points unless snapped_points == SKIP
  @warning_message = warning_message unless warning_message == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#snapped_points ⇒ Array[SnappedPoint]

An array of snapped points.



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

def snapped_points
  @snapped_points
end

#warning_message ⇒ String

A string containing a user-visible warning.



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

def warning_message
  @warning_message
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google_maps_platform/models/snap_to_roads_response.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  snapped_points = nil
  unless hash['snappedPoints'].nil?
    snapped_points = []
    hash['snappedPoints'].each do |structure|
      snapped_points << (SnappedPoint.from_hash(structure) if structure)
    end
  end

  snapped_points = SKIP unless hash.key?('snappedPoints')
  warning_message =
    hash.key?('warningMessage') ? hash['warningMessage'] : SKIP

  # 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.
  SnapToRoadsResponse.new(snapped_points: snapped_points,
                          warning_message: warning_message,
                          additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/google_maps_platform/models/snap_to_roads_response.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['snapped_points'] = 'snappedPoints'
  @_hash['warning_message'] = 'warningMessage'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/google_maps_platform/models/snap_to_roads_response.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/google_maps_platform/models/snap_to_roads_response.rb', line 29

def self.optionals
  %w[
    snapped_points
    warning_message
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



90
91
92
93
94
 
# File 'lib/google_maps_platform/models/snap_to_roads_response.rb', line 90

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} snapped_points: #{@snapped_points.inspect}, warning_message:"\
  " #{@warning_message.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



83
84
85
86
87
 
# File 'lib/google_maps_platform/models/snap_to_roads_response.rb', line 83

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} snapped_points: #{@snapped_points}, warning_message: #{@warning_message},"\
  " additional_properties: #{@additional_properties}>"
end