Represents a CreateTaskRequest.
Package
@googlemaps/fleetengine-deliveryConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.delivery.v1.ICreateTaskRequest);Constructs a new CreateTaskRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICreateTaskRequest
Properties to set |
Properties
header
public header?: (maps.fleetengine.delivery.v1.IDeliveryRequestHeader|null);CreateTaskRequest header.
parent
public parent: string;CreateTaskRequest parent.
task
public task?: (maps.fleetengine.delivery.v1.ITask|null);CreateTaskRequest task.
taskId
public taskId: string;CreateTaskRequest taskId.
Methods
create(properties)
public static create(properties?: maps.fleetengine.delivery.v1.ICreateTaskRequest): maps.fleetengine.delivery.v1.CreateTaskRequest;Creates a new CreateTaskRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICreateTaskRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CreateTaskRequest |
CreateTaskRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.delivery.v1.CreateTaskRequest;Decodes a CreateTaskRequest 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 |
CreateTaskRequest |
CreateTaskRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.delivery.v1.CreateTaskRequest;Decodes a CreateTaskRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CreateTaskRequest |
CreateTaskRequest |
encode(message, writer)
public static encode(message: maps.fleetengine.delivery.v1.ICreateTaskRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CreateTaskRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICreateTaskRequest
CreateTaskRequest 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.ICreateTaskRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CreateTaskRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICreateTaskRequest
CreateTaskRequest 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.CreateTaskRequest;Creates a CreateTaskRequest 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 |
CreateTaskRequest |
CreateTaskRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CreateTaskRequest
| 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 CreateTaskRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.delivery.v1.CreateTaskRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CreateTaskRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CreateTaskRequest
CreateTaskRequest |
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 CreateTaskRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|