Class DeliveryService.DeliveryServiceBase

Base class for server-side implementations of DeliveryService

Inheritance

object

DeliveryService.DeliveryServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Maps.FleetEngine.Delivery.V1

Assembly: Google.Maps.FleetEngine.Delivery.V1.dll

Syntax

[BindServiceMethod(typeof(DeliveryService), "BindService")]
public abstract class DeliveryService.DeliveryServiceBase

Methods

BatchCreateTasks(BatchCreateTasksRequest, ServerCallContext)

Creates and returns a batch of new Task objects.

Declaration

public virtual Task<BatchCreateTasksResponse> BatchCreateTasks(BatchCreateTasksRequest request, ServerCallContext context)

Parameters

Type	Name	Description
BatchCreateTasksRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<BatchCreateTasksResponse>	The response to send back to the client (wrapped by a task).

CreateDeliveryVehicle(CreateDeliveryVehicleRequest, ServerCallContext)

Creates and returns a new DeliveryVehicle.

Declaration

public virtual Task<DeliveryVehicle> CreateDeliveryVehicle(CreateDeliveryVehicleRequest request, ServerCallContext context)

Parameters

Type	Name	Description
CreateDeliveryVehicleRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DeliveryVehicle>	The response to send back to the client (wrapped by a task).

CreateTask(CreateTaskRequest, ServerCallContext)

Creates and returns a new Task object.

Declaration

public virtual Task<Task> CreateTask(CreateTaskRequest request, ServerCallContext context)

Parameters

Type	Name	Description
CreateTaskRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Task>	The response to send back to the client (wrapped by a task).

DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest, ServerCallContext)

Deletes a DeliveryVehicle from the Fleet Engine.

Returns FAILED_PRECONDITION if the DeliveryVehicle has OPEN Tasks assigned to it.

Declaration

public virtual Task<Empty> DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest request, ServerCallContext context)

Parameters

Type	Name	Description
DeleteDeliveryVehicleRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

DeleteTask(DeleteTaskRequest, ServerCallContext)

Deletes a single Task.

Returns FAILED_PRECONDITION if the Task is OPEN and assigned to a DeliveryVehicle.

Declaration

public virtual Task<Empty> DeleteTask(DeleteTaskRequest request, ServerCallContext context)

Parameters

Type	Name	Description
DeleteTaskRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

GetDeliveryVehicle(GetDeliveryVehicleRequest, ServerCallContext)

Returns the specified DeliveryVehicle instance.

Declaration

public virtual Task<DeliveryVehicle> GetDeliveryVehicle(GetDeliveryVehicleRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetDeliveryVehicleRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DeliveryVehicle>	The response to send back to the client (wrapped by a task).

GetTask(GetTaskRequest, ServerCallContext)

Gets information about a Task.

Declaration

public virtual Task<Task> GetTask(GetTaskRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetTaskRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Task>	The response to send back to the client (wrapped by a task).

GetTaskTrackingInfo(GetTaskTrackingInfoRequest, ServerCallContext)

Returns the specified TaskTrackingInfo instance.

Declaration

public virtual Task<TaskTrackingInfo> GetTaskTrackingInfo(GetTaskTrackingInfoRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetTaskTrackingInfoRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<TaskTrackingInfo>	The response to send back to the client (wrapped by a task).

ListDeliveryVehicles(ListDeliveryVehiclesRequest, ServerCallContext)

Gets all DeliveryVehicles that meet the specified filtering criteria.

Declaration

public virtual Task<ListDeliveryVehiclesResponse> ListDeliveryVehicles(ListDeliveryVehiclesRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ListDeliveryVehiclesRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListDeliveryVehiclesResponse>	The response to send back to the client (wrapped by a task).

ListTasks(ListTasksRequest, ServerCallContext)

Gets all Tasks that meet the specified filtering criteria.

Declaration

public virtual Task<ListTasksResponse> ListTasks(ListTasksRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ListTasksRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListTasksResponse>	The response to send back to the client (wrapped by a task).

UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest, ServerCallContext)

Writes updated DeliveryVehicle data to Fleet Engine, and assigns Tasks to the DeliveryVehicle. You cannot update the name of the DeliveryVehicle. You can update remaining_vehicle_journey_segments, but it must contain all of the VehicleJourneySegments to be persisted on the DeliveryVehicle. The task_ids are retrieved from remaining_vehicle_journey_segments, and their corresponding Tasks are assigned to the DeliveryVehicle if they have not yet been assigned.

Declaration

public virtual Task<DeliveryVehicle> UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest request, ServerCallContext context)

Parameters

Type	Name	Description
UpdateDeliveryVehicleRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DeliveryVehicle>	The response to send back to the client (wrapped by a task).

UpdateTask(UpdateTaskRequest, ServerCallContext)

Updates Task data.

Declaration

public virtual Task<Task> UpdateTask(UpdateTaskRequest request, ServerCallContext context)

Parameters

Type	Name	Description
UpdateTaskRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Task>	The response to send back to the client (wrapped by a task).