Class: Google::Maps::FleetEngine::V1::VehicleLocation

Inherits:

Object

• Object
• Google::Maps::FleetEngine::V1::VehicleLocation

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/maps/fleetengine/v1/fleetengine.rb

Overview

The location, speed, and heading of a vehicle at a point in time.

Instance Attribute Summary

• #altitude ⇒ ::Google::Protobuf::DoubleValue

  Altitude in meters above WGS84.

• #altitude_accuracy ⇒ ::Google::Protobuf::DoubleValue

  Accuracy of altitude in meters.

• #bearing_accuracy ⇒ ::Google::Protobuf::DoubleValue deprecated Deprecated.

  This field is deprecated and may be removed in the next major version update.

• #heading ⇒ ::Google::Protobuf::Int32Value

  Direction the vehicle is moving in degrees.

• #heading_accuracy ⇒ ::Google::Protobuf::DoubleValue

  Accuracy of heading in degrees.

• #horizontal_accuracy ⇒ ::Google::Protobuf::DoubleValue deprecated Deprecated.

  This field is deprecated and may be removed in the next major version update.

• #is_gps_sensor_enabled ⇒ ::Google::Protobuf::BoolValue

  Input only.

• #is_road_snapped ⇒ ::Google::Protobuf::BoolValue

  Whether location is snapped to a road.

• #latlng_accuracy ⇒ ::Google::Protobuf::DoubleValue

  Accuracy of location in meters as a radius.

• #location ⇒ ::Google::Type::LatLng

  The location of the vehicle.

• #location_sensor ⇒ ::Google::Maps::FleetEngine::V1::LocationSensor

  Provider of location data (for example, GPS).

• #num_stale_updates ⇒ ::Google::Protobuf::Int32Value deprecated Deprecated.

  This field is deprecated and may be removed in the next major version update.

• #raw_location ⇒ ::Google::Type::LatLng

  Raw vehicle location (unprocessed by road-snapper).

• #raw_location_accuracy ⇒ ::Google::Protobuf::DoubleValue

  Accuracy of raw_location as a radius, in meters.

• #raw_location_sensor ⇒ ::Google::Maps::FleetEngine::V1::LocationSensor

  Source of the raw location.

• #raw_location_time ⇒ ::Google::Protobuf::Timestamp

  Timestamp associated with the raw location.

• #road_snapped ⇒ ::Boolean deprecated Deprecated.

  This field is deprecated and may be removed in the next major version update.

• #server_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #speed ⇒ ::Google::Protobuf::DoubleValue

  Speed of the vehicle in meters/second.

• #speed_accuracy ⇒ ::Google::Protobuf::DoubleValue

  Accuracy of speed in meters/second.

• #speed_kmph ⇒ ::Google::Protobuf::Int32Value deprecated Deprecated.

  This field is deprecated and may be removed in the next major version update.

• #supplemental_location ⇒ ::Google::Type::LatLng

  Supplemental location provided by the integrating app.

• #supplemental_location_accuracy ⇒ ::Google::Protobuf::DoubleValue

  Accuracy of supplemental_location as a radius, in meters.

• #supplemental_location_sensor ⇒ ::Google::Maps::FleetEngine::V1::LocationSensor

  Source of the supplemental location.

• #supplemental_location_time ⇒ ::Google::Protobuf::Timestamp

  Timestamp associated with the supplemental location.

• #time_since_update ⇒ ::Google::Protobuf::Int32Value

  Input only.

• #update_time ⇒ ::Google::Protobuf::Timestamp

  The time when location was reported by the sensor according to the sensor's clock.

• #vertical_accuracy ⇒ ::Google::Protobuf::DoubleValue deprecated Deprecated.

  This field is deprecated and may be removed in the next major version update.

Instance Attribute Details

#altitude ⇒ ::Google::Protobuf::DoubleValue

Returns Altitude in meters above WGS84.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Altitude in meters above WGS84.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#altitude_accuracy ⇒ ::Google::Protobuf::DoubleValue

Returns Accuracy of altitude in meters.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Accuracy of altitude in meters.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#bearing_accuracy ⇒ ::Google::Protobuf::DoubleValue

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: Use heading_accuracy instead.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Deprecated: Use heading_accuracy instead.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#heading ⇒ ::Google::Protobuf::Int32Value

Returns Direction the vehicle is moving in degrees. 0 represents North. The valid range is [0,360).

Returns:

• (::Google::Protobuf::Int32Value) —

  Direction the vehicle is moving in degrees. 0 represents North. The valid range is [0,360).

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#heading_accuracy ⇒ ::Google::Protobuf::DoubleValue

Returns Accuracy of heading in degrees.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Accuracy of heading in degrees.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#horizontal_accuracy ⇒ ::Google::Protobuf::DoubleValue

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: Use latlng_accuracy instead.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Deprecated: Use latlng_accuracy instead.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#is_gps_sensor_enabled ⇒ ::Google::Protobuf::BoolValue

Returns Input only. Indicates whether the GPS sensor is enabled on the mobile device.

Returns:

• (::Google::Protobuf::BoolValue) —

  Input only. Indicates whether the GPS sensor is enabled on the mobile device.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#is_road_snapped ⇒ ::Google::Protobuf::BoolValue

Returns Whether location is snapped to a road.

Returns:

• (::Google::Protobuf::BoolValue) —

  Whether location is snapped to a road.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#latlng_accuracy ⇒ ::Google::Protobuf::DoubleValue

Returns Accuracy of location in meters as a radius.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Accuracy of location in meters as a radius.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#location ⇒ ::Google::Type::LatLng

Returns The location of the vehicle. When it is sent to Fleet Engine, the vehicle's location is a GPS location. When you receive it in a response, the vehicle's location can be either a GPS location, a supplemental location, or some other estimated location. The source is specified in location_sensor.

Returns:

• (::Google::Type::LatLng) —

  The location of the vehicle. When it is sent to Fleet Engine, the vehicle's location is a GPS location. When you receive it in a response, the vehicle's location can be either a GPS location, a supplemental location, or some other estimated location. The source is specified in location_sensor.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#location_sensor ⇒ ::Google::Maps::FleetEngine::V1::LocationSensor

Returns Provider of location data (for example, GPS).

Returns:

• (::Google::Maps::FleetEngine::V1::LocationSensor) —

  Provider of location data (for example, GPS).

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#num_stale_updates ⇒ ::Google::Protobuf::Int32Value

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Input only. Deprecated: Other signals are now used to determine if a location is stale.

Returns:

• (::Google::Protobuf::Int32Value) —

  Input only. Deprecated: Other signals are now used to determine if a location is stale.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#raw_location ⇒ ::Google::Type::LatLng

Returns Raw vehicle location (unprocessed by road-snapper).

Returns:

• (::Google::Type::LatLng) —

  Raw vehicle location (unprocessed by road-snapper).

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#raw_location_accuracy ⇒ ::Google::Protobuf::DoubleValue

Returns Accuracy of raw_location as a radius, in meters.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Accuracy of raw_location as a radius, in meters.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#raw_location_sensor ⇒ ::Google::Maps::FleetEngine::V1::LocationSensor

Returns Source of the raw location. Defaults to GPS.

Returns:

• (::Google::Maps::FleetEngine::V1::LocationSensor) —

  Source of the raw location. Defaults to GPS.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#raw_location_time ⇒ ::Google::Protobuf::Timestamp

Returns Timestamp associated with the raw location.

Returns:

• (::Google::Protobuf::Timestamp) —

  Timestamp associated with the raw location.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#road_snapped ⇒ ::Boolean

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: Use is_road_snapped instead.

Returns:

• (::Boolean) —

  Deprecated: Use is_road_snapped instead.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#server_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the server received the location information.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. The time when the server received the location information.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#speed ⇒ ::Google::Protobuf::DoubleValue

Returns Speed of the vehicle in meters/second.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Speed of the vehicle in meters/second

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#speed_accuracy ⇒ ::Google::Protobuf::DoubleValue

Returns Accuracy of speed in meters/second.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Accuracy of speed in meters/second.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#speed_kmph ⇒ ::Google::Protobuf::Int32Value

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Speed of the vehicle in kilometers per hour. Deprecated: Use speed instead.

Returns:

• (::Google::Protobuf::Int32Value) —

  Speed of the vehicle in kilometers per hour. Deprecated: Use speed instead.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#supplemental_location ⇒ ::Google::Type::LatLng

Returns Supplemental location provided by the integrating app.

Returns:

• (::Google::Type::LatLng) —

  Supplemental location provided by the integrating app.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#supplemental_location_accuracy ⇒ ::Google::Protobuf::DoubleValue

Returns Accuracy of supplemental_location as a radius, in meters.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Accuracy of supplemental_location as a radius, in meters.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#supplemental_location_sensor ⇒ ::Google::Maps::FleetEngine::V1::LocationSensor

Returns Source of the supplemental location. Defaults to CUSTOMER_SUPPLIED_LOCATION.

Returns:

• (::Google::Maps::FleetEngine::V1::LocationSensor) —

  Source of the supplemental location. Defaults to CUSTOMER_SUPPLIED_LOCATION.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#supplemental_location_time ⇒ ::Google::Protobuf::Timestamp

Returns Timestamp associated with the supplemental location.

Returns:

• (::Google::Protobuf::Timestamp) —

  Timestamp associated with the supplemental location.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#time_since_update ⇒ ::Google::Protobuf::Int32Value

Returns Input only. Time (in seconds) since this location was first sent to the server. This will be zero for the first update. If the time is unknown (for example, when the app restarts), this value resets to zero.

Returns:

• (::Google::Protobuf::Int32Value) —

  Input only. Time (in seconds) since this location was first sent to the server. This will be zero for the first update. If the time is unknown (for example, when the app restarts), this value resets to zero.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when location was reported by the sensor according to the sensor's clock.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time when location was reported by the sensor according to the sensor's clock.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#vertical_accuracy ⇒ ::Google::Protobuf::DoubleValue

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: Use altitude_accuracy instead.

Returns:

• (::Google::Protobuf::DoubleValue) —

  Deprecated: Use altitude_accuracy instead.

# File 'proto_docs/google/maps/fleetengine/v1/fleetengine.rb', line 243

class VehicleLocation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end