Class: Google::Maps::FleetEngine::Delivery::V1::CreateTaskRequest

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 CreateTask 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:



233
234
235
236
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 233

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

#parent ⇒ ::String

Returns Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Returns:

  • (::String) —

    Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.



233
234
235
236
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 233

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

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

Returns Required. The Task entity to create. When creating a Task, the following fields are required:

  • type
  • state (must be set to OPEN)
  • tracking_id (must not be set for UNAVAILABLE or SCHEDULED_STOP tasks, but required for all other task types)
  • planned_location (optional for UNAVAILABLE tasks)
  • task_duration

Note: The Task's name field is ignored. All other Task fields must not be set; otherwise, an error is returned.

Returns:

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

    Required. The Task entity to create. When creating a Task, the following fields are required:

    • type
    • state (must be set to OPEN)
    • tracking_id (must not be set for UNAVAILABLE or SCHEDULED_STOP tasks, but required for all other task types)
    • planned_location (optional for UNAVAILABLE tasks)
    • task_duration

    Note: The Task's name field is ignored. All other Task fields must not be set; otherwise, an error is returned.



233
234
235
236
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 233

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

#task_id ⇒ ::String

Returns Required. The Task ID must be unique, but it should be not a shipment tracking ID. To store a shipment tracking ID, use the tracking_id field. Note that multiple tasks can have the same tracking_id. 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.
  • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.

Returns:

  • (::String) —

    Required. The Task ID must be unique, but it should be not a shipment tracking ID. To store a shipment tracking ID, use the tracking_id field. Note that multiple tasks can have the same tracking_id. 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.
    • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.


233
234
235
236
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 233

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