Class: Google::Maps::FleetEngine::Delivery::V1::VehicleStop

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

Overview

Describes a point where a Vehicle stops to perform one or more Tasks.

Defined Under Namespace

Modules: State Classes: TaskInfo

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Required. The location of the stop. Note that the locations in the Tasks might not exactly match this location, but will be within a short distance of it. This field won't be populated in the response of a GetTask call.

Returns:

  • (::Google::Maps::FleetEngine::Delivery::V1::LocationInfo) —

    Required. The location of the stop. Note that the locations in the Tasks might not exactly match this location, but will be within a short distance of it. This field won't be populated in the response of a GetTask call.



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_vehicles.rb', line 221

class VehicleStop
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Additional information about the Task performed at this stop.
  # @!attribute [rw] task_id
  #   @return [::String]
  #     The Task ID. This field won't be populated in the response of a `GetTask`
  #     call. Task IDs are subject to the following restrictions:
  #
  #     * Must be a valid Unicode string.
  #     * Limited to a maximum length of 64 characters.
  #     * Normalized according to [Unicode Normalization Form C]
  #     (http://www.unicode.org/reports/tr15/).
  #     * May not contain any of the following ASCII characters: '/', ':', '?',
  #     ',', or '#'.
  # @!attribute [r] task_duration
  #   @return [::Google::Protobuf::Duration]
  #     Output only. The time required to perform the Task.
  # @!attribute [r] target_time_window
  #   @return [::Google::Maps::FleetEngine::Delivery::V1::TimeWindow]
  #     Output only. The time window during which the task should be completed.
  #     This is only set in the response to `GetDeliveryVehicle`.
  class TaskInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of a `VehicleStop`.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Created, but not actively routing.
    NEW = 1

    # Assigned and actively routing.
    ENROUTE = 2

    # Arrived at stop. Assumes that when the Vehicle is routing to the next
    # stop, that all previous stops have been completed.
    ARRIVED = 3
  end
end

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

Returns The state of the VehicleStop. This field won't be populated in the response of a GetTask call.

Returns:



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_vehicles.rb', line 221

class VehicleStop
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Additional information about the Task performed at this stop.
  # @!attribute [rw] task_id
  #   @return [::String]
  #     The Task ID. This field won't be populated in the response of a `GetTask`
  #     call. Task IDs are subject to the following restrictions:
  #
  #     * Must be a valid Unicode string.
  #     * Limited to a maximum length of 64 characters.
  #     * Normalized according to [Unicode Normalization Form C]
  #     (http://www.unicode.org/reports/tr15/).
  #     * May not contain any of the following ASCII characters: '/', ':', '?',
  #     ',', or '#'.
  # @!attribute [r] task_duration
  #   @return [::Google::Protobuf::Duration]
  #     Output only. The time required to perform the Task.
  # @!attribute [r] target_time_window
  #   @return [::Google::Maps::FleetEngine::Delivery::V1::TimeWindow]
  #     Output only. The time window during which the task should be completed.
  #     This is only set in the response to `GetDeliveryVehicle`.
  class TaskInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of a `VehicleStop`.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Created, but not actively routing.
    NEW = 1

    # Assigned and actively routing.
    ENROUTE = 2

    # Arrived at stop. Assumes that when the Vehicle is routing to the next
    # stop, that all previous stops have been completed.
    ARRIVED = 3
  end
end

#tasks ⇒ ::Array<::Google::Maps::FleetEngine::Delivery::V1::VehicleStop::TaskInfo>

Returns The list of Tasks to be performed at this stop. This field won't be populated in the response of a GetTask call.

Returns:



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_vehicles.rb', line 221

class VehicleStop
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Additional information about the Task performed at this stop.
  # @!attribute [rw] task_id
  #   @return [::String]
  #     The Task ID. This field won't be populated in the response of a `GetTask`
  #     call. Task IDs are subject to the following restrictions:
  #
  #     * Must be a valid Unicode string.
  #     * Limited to a maximum length of 64 characters.
  #     * Normalized according to [Unicode Normalization Form C]
  #     (http://www.unicode.org/reports/tr15/).
  #     * May not contain any of the following ASCII characters: '/', ':', '?',
  #     ',', or '#'.
  # @!attribute [r] task_duration
  #   @return [::Google::Protobuf::Duration]
  #     Output only. The time required to perform the Task.
  # @!attribute [r] target_time_window
  #   @return [::Google::Maps::FleetEngine::Delivery::V1::TimeWindow]
  #     Output only. The time window during which the task should be completed.
  #     This is only set in the response to `GetDeliveryVehicle`.
  class TaskInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of a `VehicleStop`.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Created, but not actively routing.
    NEW = 1

    # Assigned and actively routing.
    ENROUTE = 2

    # Arrived at stop. Assumes that when the Vehicle is routing to the next
    # stop, that all previous stops have been completed.
    ARRIVED = 3
  end
end