Class: GoogleMapsPlatform::NearestRoadsResponse

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

Overview

NearestRoadsResponse 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, additional_properties: nil) ⇒ NearestRoadsResponse

Returns a new instance of NearestRoadsResponse.



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

def initialize(snapped_points: 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
  @additional_properties = additional_properties
end

Instance Attribute Details

#snapped_points ⇒ Array[SnappedPoint]

An array of snapped points. Sometimes containing several snapped points for the same point with differing placeId or location.

Returns:



15
16
17
 
# File 'lib/google_maps_platform/models/nearest_roads_response.rb', line 15

def snapped_points
  @snapped_points
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google_maps_platform/models/nearest_roads_response.rb', line 45

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')

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

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
 
# File 'lib/google_maps_platform/models/nearest_roads_response.rb', line 18

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

.nullables ⇒ Object

An array for nullable fields



32
33
34
 
# File 'lib/google_maps_platform/models/nearest_roads_response.rb', line 32

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



25
26
27
28
29
 
# File 'lib/google_maps_platform/models/nearest_roads_response.rb', line 25

def self.optionals
  %w[
    snapped_points
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



80
81
82
83
84
 
# File 'lib/google_maps_platform/models/nearest_roads_response.rb', line 80

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



73
74
75
76
77
 
# File 'lib/google_maps_platform/models/nearest_roads_response.rb', line 73

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