Cloud Optimization v1 API - Class FleetRoutingClientImpl (2.4.0)

Version 2.4.0

• 2.6.0 (latest)
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0-beta01

public sealed class FleetRoutingClientImpl : FleetRoutingClient

Reference documentation and code samples for the Cloud Optimization v1 API class FleetRoutingClientImpl.

FleetRouting client wrapper implementation, for convenient use.

Inheritance

object > FleetRoutingClient > FleetRoutingClientImpl

Inherited Members

FleetRoutingClient.DefaultEndpoint

FleetRoutingClient.DefaultScopes

FleetRoutingClient.ServiceMetadata

FleetRoutingClient.CreateAsync(CancellationToken)

FleetRoutingClient.Create()

FleetRoutingClient.ShutdownDefaultChannelsAsync()

FleetRoutingClient.OptimizeToursAsync(OptimizeToursRequest, CancellationToken)

FleetRoutingClient.BatchOptimizeToursAsync(BatchOptimizeToursRequest, CancellationToken)

FleetRoutingClient.PollOnceBatchOptimizeTours(string, CallSettings)

FleetRoutingClient.PollOnceBatchOptimizeToursAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Optimization.V1

Assembly

Google.Cloud.Optimization.V1.dll

Remarks

A service for optimizing vehicle tours.

Validity of certain types of fields:

• google.protobuf.Timestamp
• Times are in Unix time: seconds since 1970-01-01T00:00:00+00:00.
• seconds must be in [0, 253402300799], i.e. in [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
• nanos must be unset or set to 0.
• google.protobuf.Duration
• seconds must be in [0, 253402300799], i.e. in [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
• nanos must be unset or set to 0.
• google.type.LatLng
• latitude must be in [-90.0, 90.0].
• longitude must be in [-180.0, 180.0].
• at least one of latitude and longitude must be non-zero.

Constructors

FleetRoutingClientImpl(FleetRoutingClient, FleetRoutingSettings, ILogger)

public FleetRoutingClientImpl(FleetRouting.FleetRoutingClient grpcClient, FleetRoutingSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	FleetRoutingFleetRoutingClient The underlying gRPC client.
settings	FleetRoutingSettings The base FleetRoutingSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

BatchOptimizeToursOperationsClient

public override OperationsClient BatchOptimizeToursOperationsClient { get; }

The long-running operations client for BatchOptimizeTours.

Property Value
Type	Description
OperationsClient

Overrides

FleetRoutingClient.BatchOptimizeToursOperationsClient

GrpcClient

public override FleetRouting.FleetRoutingClient GrpcClient { get; }

The underlying gRPC FleetRouting client

Property Value
Type	Description
FleetRoutingFleetRoutingClient

Overrides

FleetRoutingClient.GrpcClient

Methods

BatchOptimizeTours(BatchOptimizeToursRequest, CallSettings)

public override Operation<BatchOptimizeToursResponse, AsyncModelMetadata> BatchOptimizeTours(BatchOptimizeToursRequest request, CallSettings callSettings = null)

Optimizes vehicle tours for one or more OptimizeToursRequest messages as a batch.

This method is a Long Running Operation (LRO). The inputs for optimization (OptimizeToursRequest messages) and outputs (OptimizeToursResponse messages) are read/written from/to Cloud Storage in user-specified format. Like the OptimizeTours method, each OptimizeToursRequest contains a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoutes, which are a set of routes to be performed by vehicles minimizing the overall cost.

Parameters
Name	Description
request	BatchOptimizeToursRequest 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
OperationBatchOptimizeToursResponseAsyncModelMetadata	The RPC response.

Overrides

FleetRoutingClient.BatchOptimizeTours(BatchOptimizeToursRequest, CallSettings)

BatchOptimizeToursAsync(BatchOptimizeToursRequest, CallSettings)

public override Task<Operation<BatchOptimizeToursResponse, AsyncModelMetadata>> BatchOptimizeToursAsync(BatchOptimizeToursRequest request, CallSettings callSettings = null)

Optimizes vehicle tours for one or more OptimizeToursRequest messages as a batch.

This method is a Long Running Operation (LRO). The inputs for optimization (OptimizeToursRequest messages) and outputs (OptimizeToursResponse messages) are read/written from/to Cloud Storage in user-specified format. Like the OptimizeTours method, each OptimizeToursRequest contains a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoutes, which are a set of routes to be performed by vehicles minimizing the overall cost.

Parameters
Name	Description
request	BatchOptimizeToursRequest 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
TaskOperationBatchOptimizeToursResponseAsyncModelMetadata	A Task containing the RPC response.

Overrides

FleetRoutingClient.BatchOptimizeToursAsync(BatchOptimizeToursRequest, CallSettings)

OptimizeTours(OptimizeToursRequest, CallSettings)

public override OptimizeToursResponse OptimizeTours(OptimizeToursRequest request, CallSettings callSettings = null)

Sends an OptimizeToursRequest containing a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoutes, which are a set of routes to be performed by vehicles minimizing the overall cost.

A ShipmentModel model consists mainly of Shipments that need to be carried out and Vehicles that can be used to transport the Shipments. The ShipmentRoutes assign Shipments to Vehicles. More specifically, they assign a series of Visits to each vehicle, where a Visit corresponds to a VisitRequest, which is a pickup or delivery for a Shipment.

The goal is to provide an assignment of ShipmentRoutes to Vehicles that minimizes the total cost where cost has many components defined in the ShipmentModel.

Parameters
Name	Description
request	OptimizeToursRequest 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
OptimizeToursResponse	The RPC response.

Overrides

FleetRoutingClient.OptimizeTours(OptimizeToursRequest, CallSettings)

OptimizeToursAsync(OptimizeToursRequest, CallSettings)

public override Task<OptimizeToursResponse> OptimizeToursAsync(OptimizeToursRequest request, CallSettings callSettings = null)

Sends an OptimizeToursRequest containing a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoutes, which are a set of routes to be performed by vehicles minimizing the overall cost.

A ShipmentModel model consists mainly of Shipments that need to be carried out and Vehicles that can be used to transport the Shipments. The ShipmentRoutes assign Shipments to Vehicles. More specifically, they assign a series of Visits to each vehicle, where a Visit corresponds to a VisitRequest, which is a pickup or delivery for a Shipment.

The goal is to provide an assignment of ShipmentRoutes to Vehicles that minimizes the total cost where cost has many components defined in the ShipmentModel.

Parameters
Name	Description
request	OptimizeToursRequest 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
TaskOptimizeToursResponse	A Task containing the RPC response.

Overrides

FleetRoutingClient.OptimizeToursAsync(OptimizeToursRequest, CallSettings)