Show / Hide Table of Contents

Class CreateTaskRequest

The CreateTask request message.

Inheritance
object
CreateTaskRequest
Implements
IMessage<CreateTaskRequest>
IEquatable<CreateTaskRequest>
IDeepCloneable<CreateTaskRequest>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Maps.FleetEngine.Delivery.V1
Assembly: Google.Maps.FleetEngine.Delivery.V1.dll
Syntax
public sealed class CreateTaskRequest : IMessage<CreateTaskRequest>, IEquatable<CreateTaskRequest>, IDeepCloneable<CreateTaskRequest>, IBufferMessage, IMessage

Constructors

CreateTaskRequest()

Declaration
public CreateTaskRequest()

CreateTaskRequest(CreateTaskRequest)

Declaration
public CreateTaskRequest(CreateTaskRequest other)
Parameters
Type Name Description
CreateTaskRequest other

Properties

Header

Optional. The standard Delivery API request header.

Declaration
public DeliveryRequestHeader Header { get; set; }
Property Value
Type Description
DeliveryRequestHeader

Parent

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

Declaration
public string Parent { get; set; }
Property Value
Type Description
string

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

The following fields can be optionally set:

  • target_time_window
  • task_tracking_view_config
  • attributes

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

Declaration
public Task Task { get; set; }
Property Value
Type Description
Task

TaskId

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] (http://www.unicode.org/reports/tr15/).
  • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.
Declaration
public string TaskId { get; set; }
Property Value
Type Description
string
In this article
Back to top Generated by DocFX