Class RouteOptimization.RouteOptimizationClient

Client for RouteOptimization

Inheritance

object

ClientBase

ClientBase<RouteOptimization.RouteOptimizationClient>

RouteOptimization.RouteOptimizationClient

Inherited Members

ClientBase<RouteOptimization.RouteOptimizationClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Maps.RouteOptimization.V1

Assembly: Google.Maps.RouteOptimization.V1.dll

Syntax

public class RouteOptimization.RouteOptimizationClient : ClientBase<RouteOptimization.RouteOptimizationClient>

Constructors

RouteOptimizationClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected RouteOptimizationClient()

RouteOptimizationClient(CallInvoker)

Creates a new client for RouteOptimization that uses a custom CallInvoker.

Declaration

public RouteOptimizationClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

RouteOptimizationClient(ChannelBase)

Creates a new client for RouteOptimization

Declaration

public RouteOptimizationClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

RouteOptimizationClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected RouteOptimizationClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

BatchOptimizeTours(BatchOptimizeToursRequest, CallOptions)

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 from and written to Cloud Storage in user-specified format. Like the OptimizeTours method, each OptimizeToursRequest contains a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoute fields, which are a set of routes to be performed by vehicles minimizing the overall cost.

The user can poll operations.get to check the status of the LRO:

If the LRO done field is false, then at least one request is still being processed. Other requests may have completed successfully and their results are available in Cloud Storage.

If the LRO's done field is true, then all requests have been processed. Any successfully processed requests will have their results available in Cloud Storage. Any requests that failed will not have their results available in Cloud Storage. If the LRO's error field is set, then it contains the error from one of the failed requests.

Declaration

public virtual Operation BatchOptimizeTours(BatchOptimizeToursRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchOptimizeToursRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Operation	The response received from the server.

BatchOptimizeTours(BatchOptimizeToursRequest, Metadata, DateTime?, CancellationToken)

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 from and written to Cloud Storage in user-specified format. Like the OptimizeTours method, each OptimizeToursRequest contains a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoute fields, which are a set of routes to be performed by vehicles minimizing the overall cost.

The user can poll operations.get to check the status of the LRO:

If the LRO done field is false, then at least one request is still being processed. Other requests may have completed successfully and their results are available in Cloud Storage.

If the LRO's done field is true, then all requests have been processed. Any successfully processed requests will have their results available in Cloud Storage. Any requests that failed will not have their results available in Cloud Storage. If the LRO's error field is set, then it contains the error from one of the failed requests.

Declaration

public virtual Operation BatchOptimizeTours(BatchOptimizeToursRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchOptimizeToursRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Operation	The response received from the server.

BatchOptimizeToursAsync(BatchOptimizeToursRequest, CallOptions)

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 from and written to Cloud Storage in user-specified format. Like the OptimizeTours method, each OptimizeToursRequest contains a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoute fields, which are a set of routes to be performed by vehicles minimizing the overall cost.

The user can poll operations.get to check the status of the LRO:

If the LRO done field is false, then at least one request is still being processed. Other requests may have completed successfully and their results are available in Cloud Storage.

If the LRO's done field is true, then all requests have been processed. Any successfully processed requests will have their results available in Cloud Storage. Any requests that failed will not have their results available in Cloud Storage. If the LRO's error field is set, then it contains the error from one of the failed requests.

Declaration

public virtual AsyncUnaryCall<Operation> BatchOptimizeToursAsync(BatchOptimizeToursRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchOptimizeToursRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

BatchOptimizeToursAsync(BatchOptimizeToursRequest, Metadata, DateTime?, CancellationToken)

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 from and written to Cloud Storage in user-specified format. Like the OptimizeTours method, each OptimizeToursRequest contains a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoute fields, which are a set of routes to be performed by vehicles minimizing the overall cost.

The user can poll operations.get to check the status of the LRO:

If the LRO done field is false, then at least one request is still being processed. Other requests may have completed successfully and their results are available in Cloud Storage.

If the LRO's done field is true, then all requests have been processed. Any successfully processed requests will have their results available in Cloud Storage. Any requests that failed will not have their results available in Cloud Storage. If the LRO's error field is set, then it contains the error from one of the failed requests.

Declaration

public virtual AsyncUnaryCall<Operation> BatchOptimizeToursAsync(BatchOptimizeToursRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchOptimizeToursRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateOperationsClient()

Creates a new instance of Google.LongRunning.Operations.OperationsClient using the same call invoker as this client.

Declaration

public virtual Operations.OperationsClient CreateOperationsClient()

Returns

Type	Description
Operations.OperationsClient	A new Operations client for the same target as this client.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override RouteOptimization.RouteOptimizationClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
RouteOptimization.RouteOptimizationClient

Overrides

Grpc.Core.ClientBase<Google.Maps.RouteOptimization.V1.RouteOptimization.RouteOptimizationClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

OptimizeTours(OptimizeToursRequest, CallOptions)

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.

Declaration

public virtual OptimizeToursResponse OptimizeTours(OptimizeToursRequest request, CallOptions options)

Parameters

Type	Name	Description
OptimizeToursRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
OptimizeToursResponse	The response received from the server.

OptimizeTours(OptimizeToursRequest, Metadata, DateTime?, CancellationToken)

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.

Declaration

public virtual OptimizeToursResponse OptimizeTours(OptimizeToursRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OptimizeToursRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
OptimizeToursResponse	The response received from the server.

OptimizeToursAsync(OptimizeToursRequest, CallOptions)

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.

Declaration

public virtual AsyncUnaryCall<OptimizeToursResponse> OptimizeToursAsync(OptimizeToursRequest request, CallOptions options)

Parameters

Type	Name	Description
OptimizeToursRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<OptimizeToursResponse>	The call object.

OptimizeToursAsync(OptimizeToursRequest, Metadata, DateTime?, CancellationToken)

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.

Declaration

public virtual AsyncUnaryCall<OptimizeToursResponse> OptimizeToursAsync(OptimizeToursRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OptimizeToursRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<OptimizeToursResponse>	The call object.