Represents a Task.
Package
@googlemaps/fleetengine-deliveryConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.delivery.v1.ITask);
Constructs a new Task.
Parameter | |
---|---|
Name | Description |
properties |
ITask
Properties to set |
Properties
attributes
public attributes: maps.fleetengine.delivery.v1.ITaskAttribute[];
Task attributes.
deliveryVehicleId
public deliveryVehicleId: string;
Task deliveryVehicleId.
journeySharingInfo
public journeySharingInfo?: (maps.fleetengine.delivery.v1.Task.IJourneySharingInfo|null);
Task journeySharingInfo.
name
public name: string;
Task name.
plannedLocation
public plannedLocation?: (maps.fleetengine.delivery.v1.ILocationInfo|null);
Task plannedLocation.
state
public state: (maps.fleetengine.delivery.v1.Task.State|keyof typeof maps.fleetengine.delivery.v1.Task.State);
Task state.
targetTimeWindow
public targetTimeWindow?: (maps.fleetengine.delivery.v1.ITimeWindow|null);
Task targetTimeWindow.
taskDuration
public taskDuration?: (google.protobuf.IDuration|null);
Task taskDuration.
taskOutcome
public taskOutcome: (maps.fleetengine.delivery.v1.Task.TaskOutcome|keyof typeof maps.fleetengine.delivery.v1.Task.TaskOutcome);
Task taskOutcome.
taskOutcomeLocation
public taskOutcomeLocation?: (maps.fleetengine.delivery.v1.ILocationInfo|null);
Task taskOutcomeLocation.
taskOutcomeLocationSource
public taskOutcomeLocationSource: (maps.fleetengine.delivery.v1.Task.TaskOutcomeLocationSource|keyof typeof maps.fleetengine.delivery.v1.Task.TaskOutcomeLocationSource);
Task taskOutcomeLocationSource.
taskOutcomeTime
public taskOutcomeTime?: (google.protobuf.ITimestamp|null);
Task taskOutcomeTime.
taskTrackingViewConfig
public taskTrackingViewConfig?: (maps.fleetengine.delivery.v1.ITaskTrackingViewConfig|null);
Task taskTrackingViewConfig.
trackingId
public trackingId: string;
Task trackingId.
type
public type: (maps.fleetengine.delivery.v1.Task.Type|keyof typeof maps.fleetengine.delivery.v1.Task.Type);
Task type.
Methods
create(properties)
public static create(properties?: maps.fleetengine.delivery.v1.ITask): maps.fleetengine.delivery.v1.Task;
Creates a new Task instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ITask
Properties to set |
Returns | |
---|---|
Type | Description |
Task |
Task instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.delivery.v1.Task;
Decodes a Task message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
Task |
Task |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.delivery.v1.Task;
Decodes a Task message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Task |
Task |
encode(message, writer)
public static encode(message: maps.fleetengine.delivery.v1.ITask, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Task message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITask
Task message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: maps.fleetengine.delivery.v1.ITask, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Task message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITask
Task message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): maps.fleetengine.delivery.v1.Task;
Creates a Task message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
Task |
Task |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Task
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Task to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.delivery.v1.Task, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Task message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Task
Task |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Task message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|