Show / Hide Table of Contents

Class DeliveryServiceClientImpl

DeliveryService client wrapper implementation, for convenient use.

Inheritance
object
DeliveryServiceClient
DeliveryServiceClientImpl
Inherited Members
DeliveryServiceClient.DefaultEndpoint
DeliveryServiceClient.DefaultScopes
DeliveryServiceClient.ServiceMetadata
DeliveryServiceClient.CreateAsync(CancellationToken)
DeliveryServiceClient.Create()
DeliveryServiceClient.ShutdownDefaultChannelsAsync()
DeliveryServiceClient.CreateDeliveryVehicleAsync(CreateDeliveryVehicleRequest, CancellationToken)
DeliveryServiceClient.CreateDeliveryVehicle(string, DeliveryVehicle, string, CallSettings)
DeliveryServiceClient.CreateDeliveryVehicleAsync(string, DeliveryVehicle, string, CallSettings)
DeliveryServiceClient.CreateDeliveryVehicleAsync(string, DeliveryVehicle, string, CancellationToken)
DeliveryServiceClient.GetDeliveryVehicleAsync(GetDeliveryVehicleRequest, CancellationToken)
DeliveryServiceClient.GetDeliveryVehicle(string, CallSettings)
DeliveryServiceClient.GetDeliveryVehicleAsync(string, CallSettings)
DeliveryServiceClient.GetDeliveryVehicleAsync(string, CancellationToken)
DeliveryServiceClient.GetDeliveryVehicle(DeliveryVehicleName, CallSettings)
DeliveryServiceClient.GetDeliveryVehicleAsync(DeliveryVehicleName, CallSettings)
DeliveryServiceClient.GetDeliveryVehicleAsync(DeliveryVehicleName, CancellationToken)
DeliveryServiceClient.DeleteDeliveryVehicleAsync(DeleteDeliveryVehicleRequest, CancellationToken)
DeliveryServiceClient.DeleteDeliveryVehicle(string, CallSettings)
DeliveryServiceClient.DeleteDeliveryVehicleAsync(string, CallSettings)
DeliveryServiceClient.DeleteDeliveryVehicleAsync(string, CancellationToken)
DeliveryServiceClient.DeleteDeliveryVehicle(DeliveryVehicleName, CallSettings)
DeliveryServiceClient.DeleteDeliveryVehicleAsync(DeliveryVehicleName, CallSettings)
DeliveryServiceClient.DeleteDeliveryVehicleAsync(DeliveryVehicleName, CancellationToken)
DeliveryServiceClient.UpdateDeliveryVehicleAsync(UpdateDeliveryVehicleRequest, CancellationToken)
DeliveryServiceClient.UpdateDeliveryVehicle(DeliveryVehicle, FieldMask, CallSettings)
DeliveryServiceClient.UpdateDeliveryVehicleAsync(DeliveryVehicle, FieldMask, CallSettings)
DeliveryServiceClient.UpdateDeliveryVehicleAsync(DeliveryVehicle, FieldMask, CancellationToken)
DeliveryServiceClient.BatchCreateTasksAsync(BatchCreateTasksRequest, CancellationToken)
DeliveryServiceClient.CreateTaskAsync(CreateTaskRequest, CancellationToken)
DeliveryServiceClient.CreateTask(string, Task, string, CallSettings)
DeliveryServiceClient.CreateTaskAsync(string, Task, string, CallSettings)
DeliveryServiceClient.CreateTaskAsync(string, Task, string, CancellationToken)
DeliveryServiceClient.GetTaskAsync(GetTaskRequest, CancellationToken)
DeliveryServiceClient.GetTask(string, CallSettings)
DeliveryServiceClient.GetTaskAsync(string, CallSettings)
DeliveryServiceClient.GetTaskAsync(string, CancellationToken)
DeliveryServiceClient.GetTask(TaskName, CallSettings)
DeliveryServiceClient.GetTaskAsync(TaskName, CallSettings)
DeliveryServiceClient.GetTaskAsync(TaskName, CancellationToken)
DeliveryServiceClient.DeleteTaskAsync(DeleteTaskRequest, CancellationToken)
DeliveryServiceClient.DeleteTask(string, CallSettings)
DeliveryServiceClient.DeleteTaskAsync(string, CallSettings)
DeliveryServiceClient.DeleteTaskAsync(string, CancellationToken)
DeliveryServiceClient.DeleteTask(TaskName, CallSettings)
DeliveryServiceClient.DeleteTaskAsync(TaskName, CallSettings)
DeliveryServiceClient.DeleteTaskAsync(TaskName, CancellationToken)
DeliveryServiceClient.UpdateTaskAsync(UpdateTaskRequest, CancellationToken)
DeliveryServiceClient.UpdateTask(Task, FieldMask, CallSettings)
DeliveryServiceClient.UpdateTaskAsync(Task, FieldMask, CallSettings)
DeliveryServiceClient.UpdateTaskAsync(Task, FieldMask, CancellationToken)
DeliveryServiceClient.ListTasks(string, string, int?, CallSettings)
DeliveryServiceClient.ListTasksAsync(string, string, int?, CallSettings)
DeliveryServiceClient.ListTasks(ProviderName, string, int?, CallSettings)
DeliveryServiceClient.ListTasksAsync(ProviderName, string, int?, CallSettings)
DeliveryServiceClient.GetTaskTrackingInfoAsync(GetTaskTrackingInfoRequest, CancellationToken)
DeliveryServiceClient.GetTaskTrackingInfo(string, CallSettings)
DeliveryServiceClient.GetTaskTrackingInfoAsync(string, CallSettings)
DeliveryServiceClient.GetTaskTrackingInfoAsync(string, CancellationToken)
DeliveryServiceClient.GetTaskTrackingInfo(TaskTrackingInfoName, CallSettings)
DeliveryServiceClient.GetTaskTrackingInfoAsync(TaskTrackingInfoName, CallSettings)
DeliveryServiceClient.GetTaskTrackingInfoAsync(TaskTrackingInfoName, CancellationToken)
DeliveryServiceClient.ListDeliveryVehicles(string, string, int?, CallSettings)
DeliveryServiceClient.ListDeliveryVehiclesAsync(string, string, int?, CallSettings)
DeliveryServiceClient.ListDeliveryVehicles(ProviderName, string, int?, CallSettings)
DeliveryServiceClient.ListDeliveryVehiclesAsync(ProviderName, string, int?, CallSettings)
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Maps.FleetEngine.Delivery.V1
Assembly: Google.Maps.FleetEngine.Delivery.V1.dll
Syntax
public sealed class DeliveryServiceClientImpl : DeliveryServiceClient
Remarks

The Last Mile Delivery service.

Constructors

DeliveryServiceClientImpl(DeliveryServiceClient, DeliveryServiceSettings, ILogger)

Constructs a client wrapper for the DeliveryService service, with the specified gRPC client and settings.

Declaration
public DeliveryServiceClientImpl(DeliveryService.DeliveryServiceClient grpcClient, DeliveryServiceSettings settings, ILogger logger)
Parameters
Type Name Description
DeliveryService.DeliveryServiceClient grpcClient

The underlying gRPC client.

DeliveryServiceSettings settings

The base DeliveryServiceSettings used within this client.

ILogger logger

Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC DeliveryService client

Declaration
public override DeliveryService.DeliveryServiceClient GrpcClient { get; }
Property Value
Type Description
DeliveryService.DeliveryServiceClient
Overrides
DeliveryServiceClient.GrpcClient

Methods

BatchCreateTasks(BatchCreateTasksRequest, CallSettings)

Creates and returns a batch of new Task objects.

Declaration
public override BatchCreateTasksResponse BatchCreateTasks(BatchCreateTasksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchCreateTasksRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchCreateTasksResponse

The RPC response.

Overrides
DeliveryServiceClient.BatchCreateTasks(BatchCreateTasksRequest, CallSettings)

BatchCreateTasksAsync(BatchCreateTasksRequest, CallSettings)

Creates and returns a batch of new Task objects.

Declaration
public override Task<BatchCreateTasksResponse> BatchCreateTasksAsync(BatchCreateTasksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchCreateTasksRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchCreateTasksResponse>

A Task containing the RPC response.

Overrides
DeliveryServiceClient.BatchCreateTasksAsync(BatchCreateTasksRequest, CallSettings)

CreateDeliveryVehicle(CreateDeliveryVehicleRequest, CallSettings)

Creates and returns a new DeliveryVehicle.

Declaration
public override DeliveryVehicle CreateDeliveryVehicle(CreateDeliveryVehicleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateDeliveryVehicleRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DeliveryVehicle

The RPC response.

Overrides
DeliveryServiceClient.CreateDeliveryVehicle(CreateDeliveryVehicleRequest, CallSettings)

CreateDeliveryVehicleAsync(CreateDeliveryVehicleRequest, CallSettings)

Creates and returns a new DeliveryVehicle.

Declaration
public override Task<DeliveryVehicle> CreateDeliveryVehicleAsync(CreateDeliveryVehicleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateDeliveryVehicleRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<DeliveryVehicle>

A Task containing the RPC response.

Overrides
DeliveryServiceClient.CreateDeliveryVehicleAsync(CreateDeliveryVehicleRequest, CallSettings)

CreateTask(CreateTaskRequest, CallSettings)

Creates and returns a new Task object.

Declaration
public override Task CreateTask(CreateTaskRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateTaskRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

The RPC response.

Overrides
DeliveryServiceClient.CreateTask(CreateTaskRequest, CallSettings)

CreateTaskAsync(CreateTaskRequest, CallSettings)

Creates and returns a new Task object.

Declaration
public override Task<Task> CreateTaskAsync(CreateTaskRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateTaskRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<Task>

A Task containing the RPC response.

Overrides
DeliveryServiceClient.CreateTaskAsync(CreateTaskRequest, CallSettings)

DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest, CallSettings)

Deletes a DeliveryVehicle from the Fleet Engine.

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

Declaration
public override void DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDeliveryVehicleRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Overrides
DeliveryServiceClient.DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest, CallSettings)

DeleteDeliveryVehicleAsync(DeleteDeliveryVehicleRequest, CallSettings)

Deletes a DeliveryVehicle from the Fleet Engine.

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

Declaration
public override Task DeleteDeliveryVehicleAsync(DeleteDeliveryVehicleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDeliveryVehicleRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Overrides
DeliveryServiceClient.DeleteDeliveryVehicleAsync(DeleteDeliveryVehicleRequest, CallSettings)

DeleteTask(DeleteTaskRequest, CallSettings)

Deletes a single Task.

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

Declaration
public override void DeleteTask(DeleteTaskRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteTaskRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Overrides
DeliveryServiceClient.DeleteTask(DeleteTaskRequest, CallSettings)

DeleteTaskAsync(DeleteTaskRequest, CallSettings)

Deletes a single Task.

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

Declaration
public override Task DeleteTaskAsync(DeleteTaskRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteTaskRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Overrides
DeliveryServiceClient.DeleteTaskAsync(DeleteTaskRequest, CallSettings)

GetDeliveryVehicle(GetDeliveryVehicleRequest, CallSettings)

Returns the specified DeliveryVehicle instance.

Declaration
public override DeliveryVehicle GetDeliveryVehicle(GetDeliveryVehicleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDeliveryVehicleRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DeliveryVehicle

The RPC response.

Overrides
DeliveryServiceClient.GetDeliveryVehicle(GetDeliveryVehicleRequest, CallSettings)

GetDeliveryVehicleAsync(GetDeliveryVehicleRequest, CallSettings)

Returns the specified DeliveryVehicle instance.

Declaration
public override Task<DeliveryVehicle> GetDeliveryVehicleAsync(GetDeliveryVehicleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDeliveryVehicleRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<DeliveryVehicle>

A Task containing the RPC response.

Overrides
DeliveryServiceClient.GetDeliveryVehicleAsync(GetDeliveryVehicleRequest, CallSettings)

GetTask(GetTaskRequest, CallSettings)

Gets information about a Task.

Declaration
public override Task GetTask(GetTaskRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetTaskRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

The RPC response.

Overrides
DeliveryServiceClient.GetTask(GetTaskRequest, CallSettings)

GetTaskAsync(GetTaskRequest, CallSettings)

Gets information about a Task.

Declaration
public override Task<Task> GetTaskAsync(GetTaskRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetTaskRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<Task>

A Task containing the RPC response.

Overrides
DeliveryServiceClient.GetTaskAsync(GetTaskRequest, CallSettings)

GetTaskTrackingInfo(GetTaskTrackingInfoRequest, CallSettings)

Returns the specified TaskTrackingInfo instance.

Declaration
public override TaskTrackingInfo GetTaskTrackingInfo(GetTaskTrackingInfoRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetTaskTrackingInfoRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTrackingInfo

The RPC response.

Overrides
DeliveryServiceClient.GetTaskTrackingInfo(GetTaskTrackingInfoRequest, CallSettings)

GetTaskTrackingInfoAsync(GetTaskTrackingInfoRequest, CallSettings)

Returns the specified TaskTrackingInfo instance.

Declaration
public override Task<TaskTrackingInfo> GetTaskTrackingInfoAsync(GetTaskTrackingInfoRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetTaskTrackingInfoRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<TaskTrackingInfo>

A Task containing the RPC response.

Overrides
DeliveryServiceClient.GetTaskTrackingInfoAsync(GetTaskTrackingInfoRequest, CallSettings)

ListDeliveryVehicles(ListDeliveryVehiclesRequest, CallSettings)

Gets all DeliveryVehicles that meet the specified filtering criteria.

Declaration
public override PagedEnumerable<ListDeliveryVehiclesResponse, DeliveryVehicle> ListDeliveryVehicles(ListDeliveryVehiclesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDeliveryVehiclesRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListDeliveryVehiclesResponse, DeliveryVehicle>

A pageable sequence of DeliveryVehicle resources.

Overrides
DeliveryServiceClient.ListDeliveryVehicles(ListDeliveryVehiclesRequest, CallSettings)

ListDeliveryVehiclesAsync(ListDeliveryVehiclesRequest, CallSettings)

Gets all DeliveryVehicles that meet the specified filtering criteria.

Declaration
public override PagedAsyncEnumerable<ListDeliveryVehiclesResponse, DeliveryVehicle> ListDeliveryVehiclesAsync(ListDeliveryVehiclesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDeliveryVehiclesRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListDeliveryVehiclesResponse, DeliveryVehicle>

A pageable asynchronous sequence of DeliveryVehicle resources.

Overrides
DeliveryServiceClient.ListDeliveryVehiclesAsync(ListDeliveryVehiclesRequest, CallSettings)

ListTasks(ListTasksRequest, CallSettings)

Gets all Tasks that meet the specified filtering criteria.

Declaration
public override PagedEnumerable<ListTasksResponse, Task> ListTasks(ListTasksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListTasksRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListTasksResponse, Task>

A pageable sequence of Task resources.

Overrides
DeliveryServiceClient.ListTasks(ListTasksRequest, CallSettings)

ListTasksAsync(ListTasksRequest, CallSettings)

Gets all Tasks that meet the specified filtering criteria.

Declaration
public override PagedAsyncEnumerable<ListTasksResponse, Task> ListTasksAsync(ListTasksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListTasksRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListTasksResponse, Task>

A pageable asynchronous sequence of Task resources.

Overrides
DeliveryServiceClient.ListTasksAsync(ListTasksRequest, CallSettings)

UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest, CallSettings)

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 override DeliveryVehicle UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDeliveryVehicleRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DeliveryVehicle

The RPC response.

Overrides
DeliveryServiceClient.UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest, CallSettings)

UpdateDeliveryVehicleAsync(UpdateDeliveryVehicleRequest, CallSettings)

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 override Task<DeliveryVehicle> UpdateDeliveryVehicleAsync(UpdateDeliveryVehicleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDeliveryVehicleRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<DeliveryVehicle>

A Task containing the RPC response.

Overrides
DeliveryServiceClient.UpdateDeliveryVehicleAsync(UpdateDeliveryVehicleRequest, CallSettings)

UpdateTask(UpdateTaskRequest, CallSettings)

Updates Task data.

Declaration
public override Task UpdateTask(UpdateTaskRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateTaskRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

The RPC response.

Overrides
DeliveryServiceClient.UpdateTask(UpdateTaskRequest, CallSettings)

UpdateTaskAsync(UpdateTaskRequest, CallSettings)

Updates Task data.

Declaration
public override Task<Task> UpdateTaskAsync(UpdateTaskRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateTaskRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<Task>

A Task containing the RPC response.

Overrides
DeliveryServiceClient.UpdateTaskAsync(UpdateTaskRequest, CallSettings)
In this article
Back to top Generated by DocFX