Class DeliveryServiceClientImpl
DeliveryService client wrapper implementation, for convenient use.
Inherited Members
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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. |