public class FleetRouting.FleetRoutingClient : ClientBase<FleetRouting.FleetRoutingClient>Reference documentation and code samples for the Cloud Optimization v1 API class FleetRouting.FleetRoutingClient.
Client for FleetRouting
Inheritance
object > ClientBase > ClientBaseFleetRoutingFleetRoutingClient > FleetRouting.FleetRoutingClientNamespace
Google.Cloud.Optimization.V1Assembly
Google.Cloud.Optimization.V1.dll
Constructors
FleetRoutingClient()
protected FleetRoutingClient()Protected parameterless constructor to allow creation of test doubles.
FleetRoutingClient(CallInvoker)
public FleetRoutingClient(CallInvoker callInvoker)Creates a new client for FleetRouting that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker | CallInvokerThe callInvoker to use to make remote calls. |
FleetRoutingClient(ChannelBase)
public FleetRoutingClient(ChannelBase channel)Creates a new client for FleetRouting
| Parameter | |
|---|---|
| Name | Description |
channel | ChannelBaseThe channel to use to make remote calls. |
FleetRoutingClient(ClientBaseConfiguration)
protected FleetRoutingClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfigurationThe client configuration. |
Methods
BatchOptimizeTours(BatchOptimizeToursRequest, CallOptions)
public virtual Operation BatchOptimizeTours(BatchOptimizeToursRequest request, CallOptions options)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 | BatchOptimizeToursRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
BatchOptimizeTours(BatchOptimizeToursRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation BatchOptimizeTours(BatchOptimizeToursRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | BatchOptimizeToursRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
BatchOptimizeToursAsync(BatchOptimizeToursRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> BatchOptimizeToursAsync(BatchOptimizeToursRequest request, CallOptions options)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 | BatchOptimizeToursRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
BatchOptimizeToursAsync(BatchOptimizeToursRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> BatchOptimizeToursAsync(BatchOptimizeToursRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | BatchOptimizeToursRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
OperationsOperationsClient | A new Operations client for the same target as this client. |
NewInstance(ClientBaseConfiguration)
protected override FleetRouting.FleetRoutingClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
FleetRoutingFleetRoutingClient | |
OptimizeTours(OptimizeToursRequest, CallOptions)
public virtual OptimizeToursResponse OptimizeTours(OptimizeToursRequest request, CallOptions options)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 | OptimizeToursRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
OptimizeToursResponse | The response received from the server. |
OptimizeTours(OptimizeToursRequest, Metadata, DateTime?, CancellationToken)
public virtual OptimizeToursResponse OptimizeTours(OptimizeToursRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | OptimizeToursRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
OptimizeToursResponse | The response received from the server. |
OptimizeToursAsync(OptimizeToursRequest, CallOptions)
public virtual AsyncUnaryCall<OptimizeToursResponse> OptimizeToursAsync(OptimizeToursRequest request, CallOptions options)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 | OptimizeToursRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOptimizeToursResponse | The call object. |
OptimizeToursAsync(OptimizeToursRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<OptimizeToursResponse> OptimizeToursAsync(OptimizeToursRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | OptimizeToursRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOptimizeToursResponse | The call object. |