Class: Google::Maps::FleetEngine::Delivery::V1::UpdateTaskRequest

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

Overview

The UpdateTask request message.

Instance Attribute Summary collapse

Instance Attribute Details

#header ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryRequestHeader

Returns Optional. The standard Delivery API request header.

Returns:



316
317
318
319
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 316

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

#task ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

Returns Required. The Task associated with the update. The following fields are maintained by Fleet Engine. Do not update them using Task.update.

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

Note: You cannot change the value of task_outcome once you set it.

If the Task has been assigned to a delivery vehicle, then don't set the Task state to CLOSED using Task.update. Instead, remove the VehicleStop that contains the Task from the delivery vehicle, which automatically sets the Task state to CLOSED.

Returns:

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

    Required. The Task associated with the update. The following fields are maintained by Fleet Engine. Do not update them using Task.update.

    • last_location.
    • last_location_snappable.
    • name.
    • remaining_vehicle_journey_segments.
    • task_outcome_location_source.

    Note: You cannot change the value of task_outcome once you set it.

    If the Task has been assigned to a delivery vehicle, then don't set the Task state to CLOSED using Task.update. Instead, remove the VehicleStop that contains the Task from the delivery vehicle, which automatically sets the Task state to CLOSED.



316
317
318
319
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 316

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

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns Required. The field mask that indicates which Task fields to update. Note: The update_mask must contain at least one field.

This is a comma-separated list of fully qualified names of fields. Example: "task_outcome,task_outcome_time,task_outcome_location".

Returns:

  • (::Google::Protobuf::FieldMask) —

    Required. The field mask that indicates which Task fields to update. Note: The update_mask must contain at least one field.

    This is a comma-separated list of fully qualified names of fields. Example: "task_outcome,task_outcome_time,task_outcome_location".



316
317
318
319
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 316

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