Class: Google::Maps::FleetEngine::Delivery::V1::TaskTrackingInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb

Overview

The TaskTrackingInfo message. The message contains task tracking information which will be used for display. If a tracking ID is associated with multiple Tasks, Fleet Engine uses a heuristic to decide which Task's TaskTrackingInfo to select.

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ ::Array<::Google::Maps::FleetEngine::Delivery::V1::TaskAttribute>

Returns The custom attributes set on the task.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#estimated_arrival_time ⇒ ::Google::Protobuf::Timestamp

Returns The timestamp that indicates the estimated arrival time to the stop location.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#estimated_task_completion_time ⇒ ::Google::Protobuf::Timestamp

Returns The timestamp that indicates the estimated completion time of a Task.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#name ⇒ ::String

Returns Must be in the format providers/{provider}/taskTrackingInfo/{tracking}, where tracking represents the tracking ID.

Returns:

  • (::String) —

    Must be in the format providers/{provider}/taskTrackingInfo/{tracking}, where tracking represents the tracking ID.



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#planned_location ⇒ ::Google::Maps::FleetEngine::Delivery::V1::LocationInfo

Returns Immutable. The location where the Task will be completed.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#remaining_driving_distance_meters ⇒ ::Google::Protobuf::Int32Value

Returns The total remaining distance in meters to the VehicleStop of interest.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#remaining_stop_count ⇒ ::Google::Protobuf::Int32Value

Returns Indicates the number of stops the vehicle remaining until the task stop is reached, including the task stop. For example, if the vehicle's next stop is the task stop, the value will be 1.

Returns:

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

    Indicates the number of stops the vehicle remaining until the task stop is reached, including the task stop. For example, if the vehicle's next stop is the task stop, the value will be 1.



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#route_polyline_points ⇒ ::Array<::Google::Type::LatLng>

Returns A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task.

Returns:

  • (::Array<::Google::Type::LatLng>) —

    A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task.



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#state ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task::State

Returns The current execution state of the Task.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#target_time_window ⇒ ::Google::Maps::FleetEngine::Delivery::V1::TimeWindow

Returns The time window during which the task should be completed.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#task_outcome ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task::TaskOutcome

Returns The outcome of attempting to execute a Task.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#task_outcome_time ⇒ ::Google::Protobuf::Timestamp

Returns The timestamp that indicates when the Task's outcome was set by the provider.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#tracking_id ⇒ ::String

Returns Immutable. The tracking ID of a Task.

  • Must be a valid Unicode string.
  • Limited to a maximum length of 64 characters.
  • Normalized according to Unicode Normalization Form C.
  • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.

Returns:

  • (::String) —

    Immutable. The tracking ID of a Task.

    • Must be a valid Unicode string.
    • Limited to a maximum length of 64 characters.
    • Normalized according to Unicode Normalization Form C.
    • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.


83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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

#vehicle_location ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicleLocation

Returns The vehicle's last location.

Returns:



83
84
85
86
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb', line 83

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