Class protos.maps.fleetengine.delivery.v1.DeliveryService (0.2.0)

Represents a DeliveryService

Inheritance

$protobuf.rpc.Service > protos.maps.fleetengine.delivery.v1.DeliveryService

Package

@googlemaps/fleetengine-delivery

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new DeliveryService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchCreateTasks(request, callback)

public batchCreateTasks(request: maps.fleetengine.delivery.v1.IBatchCreateTasksRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.BatchCreateTasksCallback): void;

Calls BatchCreateTasks.

Parameters
Name Description
request IBatchCreateTasksRequest

BatchCreateTasksRequest message or plain object
callback BatchCreateTasksCallback

Node-style callback called with the error, if any, and BatchCreateTasksResponse
Returns
Type Description
void

batchCreateTasks(request)

public batchCreateTasks(request: maps.fleetengine.delivery.v1.IBatchCreateTasksRequest): Promise<maps.fleetengine.delivery.v1.BatchCreateTasksResponse>;

Calls BatchCreateTasks.

Parameter
Name Description
request IBatchCreateTasksRequest

BatchCreateTasksRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.BatchCreateTasksResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DeliveryService;

Creates new DeliveryService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
DeliveryService

RPC service. Useful where requests and/or responses are streamed.

createDeliveryVehicle(request, callback)

public createDeliveryVehicle(request: maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.CreateDeliveryVehicleCallback): void;

Calls CreateDeliveryVehicle.

Parameters
Name Description
request ICreateDeliveryVehicleRequest

CreateDeliveryVehicleRequest message or plain object
callback CreateDeliveryVehicleCallback

Node-style callback called with the error, if any, and DeliveryVehicle
Returns
Type Description
void

createDeliveryVehicle(request)

public createDeliveryVehicle(request: maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest): Promise<maps.fleetengine.delivery.v1.DeliveryVehicle>;

Calls CreateDeliveryVehicle.

Parameter
Name Description
request ICreateDeliveryVehicleRequest

CreateDeliveryVehicleRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.DeliveryVehicle>

Promise

createTask(request, callback)

public createTask(request: maps.fleetengine.delivery.v1.ICreateTaskRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.CreateTaskCallback): void;

Calls CreateTask.

Parameters
Name Description
request ICreateTaskRequest

CreateTaskRequest message or plain object
callback CreateTaskCallback

Node-style callback called with the error, if any, and Task
Returns
Type Description
void

createTask(request)

public createTask(request: maps.fleetengine.delivery.v1.ICreateTaskRequest): Promise<maps.fleetengine.delivery.v1.Task>;

Calls CreateTask.

Parameter
Name Description
request ICreateTaskRequest

CreateTaskRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.Task>

Promise

getDeliveryVehicle(request, callback)

public getDeliveryVehicle(request: maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.GetDeliveryVehicleCallback): void;

Calls GetDeliveryVehicle.

Parameters
Name Description
request IGetDeliveryVehicleRequest

GetDeliveryVehicleRequest message or plain object
callback GetDeliveryVehicleCallback

Node-style callback called with the error, if any, and DeliveryVehicle
Returns
Type Description
void

getDeliveryVehicle(request)

public getDeliveryVehicle(request: maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest): Promise<maps.fleetengine.delivery.v1.DeliveryVehicle>;

Calls GetDeliveryVehicle.

Parameter
Name Description
request IGetDeliveryVehicleRequest

GetDeliveryVehicleRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.DeliveryVehicle>

Promise

getTask(request, callback)

public getTask(request: maps.fleetengine.delivery.v1.IGetTaskRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.GetTaskCallback): void;

Calls GetTask.

Parameters
Name Description
request IGetTaskRequest

GetTaskRequest message or plain object
callback GetTaskCallback

Node-style callback called with the error, if any, and Task
Returns
Type Description
void

getTask(request)

public getTask(request: maps.fleetengine.delivery.v1.IGetTaskRequest): Promise<maps.fleetengine.delivery.v1.Task>;

Calls GetTask.

Parameter
Name Description
request IGetTaskRequest

GetTaskRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.Task>

Promise

getTaskTrackingInfo(request, callback)

public getTaskTrackingInfo(request: maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.GetTaskTrackingInfoCallback): void;

Calls GetTaskTrackingInfo.

Parameters
Name Description
request IGetTaskTrackingInfoRequest

GetTaskTrackingInfoRequest message or plain object
callback GetTaskTrackingInfoCallback

Node-style callback called with the error, if any, and TaskTrackingInfo
Returns
Type Description
void

getTaskTrackingInfo(request)

public getTaskTrackingInfo(request: maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest): Promise<maps.fleetengine.delivery.v1.TaskTrackingInfo>;

Calls GetTaskTrackingInfo.

Parameter
Name Description
request IGetTaskTrackingInfoRequest

GetTaskTrackingInfoRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.TaskTrackingInfo>

Promise

listDeliveryVehicles(request, callback)

public listDeliveryVehicles(request: maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.ListDeliveryVehiclesCallback): void;

Calls ListDeliveryVehicles.

Parameters
Name Description
request IListDeliveryVehiclesRequest

ListDeliveryVehiclesRequest message or plain object
callback ListDeliveryVehiclesCallback

Node-style callback called with the error, if any, and ListDeliveryVehiclesResponse
Returns
Type Description
void

listDeliveryVehicles(request)

public listDeliveryVehicles(request: maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest): Promise<maps.fleetengine.delivery.v1.ListDeliveryVehiclesResponse>;

Calls ListDeliveryVehicles.

Parameter
Name Description
request IListDeliveryVehiclesRequest

ListDeliveryVehiclesRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.ListDeliveryVehiclesResponse>

Promise

listTasks(request, callback)

public listTasks(request: maps.fleetengine.delivery.v1.IListTasksRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.ListTasksCallback): void;

Calls ListTasks.

Parameters
Name Description
request IListTasksRequest

ListTasksRequest message or plain object
callback ListTasksCallback

Node-style callback called with the error, if any, and ListTasksResponse
Returns
Type Description
void

listTasks(request)

public listTasks(request: maps.fleetengine.delivery.v1.IListTasksRequest): Promise<maps.fleetengine.delivery.v1.ListTasksResponse>;

Calls ListTasks.

Parameter
Name Description
request IListTasksRequest

ListTasksRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.ListTasksResponse>

Promise

updateDeliveryVehicle(request, callback)

public updateDeliveryVehicle(request: maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.UpdateDeliveryVehicleCallback): void;

Calls UpdateDeliveryVehicle.

Parameters
Name Description
request IUpdateDeliveryVehicleRequest

UpdateDeliveryVehicleRequest message or plain object
callback UpdateDeliveryVehicleCallback

Node-style callback called with the error, if any, and DeliveryVehicle
Returns
Type Description
void

updateDeliveryVehicle(request)

public updateDeliveryVehicle(request: maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest): Promise<maps.fleetengine.delivery.v1.DeliveryVehicle>;

Calls UpdateDeliveryVehicle.

Parameter
Name Description
request IUpdateDeliveryVehicleRequest

UpdateDeliveryVehicleRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.DeliveryVehicle>

Promise

updateTask(request, callback)

public updateTask(request: maps.fleetengine.delivery.v1.IUpdateTaskRequest, callback: maps.fleetengine.delivery.v1.DeliveryService.UpdateTaskCallback): void;

Calls UpdateTask.

Parameters
Name Description
request IUpdateTaskRequest

UpdateTaskRequest message or plain object
callback UpdateTaskCallback

Node-style callback called with the error, if any, and Task
Returns
Type Description
void

updateTask(request)

public updateTask(request: maps.fleetengine.delivery.v1.IUpdateTaskRequest): Promise<maps.fleetengine.delivery.v1.Task>;

Calls UpdateTask.

Parameter
Name Description
request IUpdateTaskRequest

UpdateTaskRequest message or plain object
Returns
Type Description
Promise<maps.fleetengine.delivery.v1.Task>

Promise