Class Routes.RoutesClient

Client for Routes

Inheritance

object

ClientBase

ClientBase<Routes.RoutesClient>

Routes.RoutesClient

Inherited Members

ClientBase<Routes.RoutesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Maps.Routing.V2

Assembly: Google.Maps.Routing.V2.dll

Syntax

public class Routes.RoutesClient : ClientBase<Routes.RoutesClient>

Constructors

RoutesClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected RoutesClient()

RoutesClient(CallInvoker)

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

Declaration

public RoutesClient(CallInvoker callInvoker)

Parameters

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

RoutesClient(ChannelBase)

Creates a new client for Routes

Declaration

public RoutesClient(ChannelBase channel)

Parameters

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

RoutesClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected RoutesClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

ComputeRouteMatrix(ComputeRouteMatrixRequest, CallOptions)

Takes in a list of origins and destinations and returns a stream containing route information for each combination of origin and destination.

NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask (see the available URL parameters and headers). The value is a comma separated list of field paths. See this detailed documentation about how to construct the field paths.

For example, in this method:

Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
Field mask of route durations, distances, element status, condition, and element indices (an example production setup): X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

It is critical that you include status in your field mask as otherwise all messages will appear to be OK. Google discourages the use of the wildcard (*) response field mask, because:

Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

Declaration

public virtual AsyncServerStreamingCall<RouteMatrixElement> ComputeRouteMatrix(ComputeRouteMatrixRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncServerStreamingCall<RouteMatrixElement>	The call object.

ComputeRouteMatrix(ComputeRouteMatrixRequest, Metadata, DateTime?, CancellationToken)

Takes in a list of origins and destinations and returns a stream containing route information for each combination of origin and destination.

For example, in this method:

Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
Field mask of route durations, distances, element status, condition, and element indices (an example production setup): X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

It is critical that you include status in your field mask as otherwise all messages will appear to be OK. Google discourages the use of the wildcard (*) response field mask, because:

Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

Declaration

public virtual AsyncServerStreamingCall<RouteMatrixElement> ComputeRouteMatrix(ComputeRouteMatrixRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ComputeRouteMatrixRequest	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
AsyncServerStreamingCall<RouteMatrixElement>	The call object.

ComputeRoutes(ComputeRoutesRequest, CallOptions)

Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.

NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using URL parameter $fields or fields, or by using an HTTP/gRPC header X-Goog-FieldMask (see the available URL parameters and headers). The value is a comma separated list of field paths. See detailed documentation about how to construct the field paths.

For example, in this method:

Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
Field mask of Route-level duration, distance, and polyline (an example production setup): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google discourage the use of the wildcard (*) response field mask, or specifying the field mask at the top level (routes), because:

Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

Declaration

public virtual ComputeRoutesResponse ComputeRoutes(ComputeRoutesRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
ComputeRoutesResponse	The response received from the server.

ComputeRoutes(ComputeRoutesRequest, Metadata, DateTime?, CancellationToken)

Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.

For example, in this method:

Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
Field mask of Route-level duration, distance, and polyline (an example production setup): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google discourage the use of the wildcard (*) response field mask, or specifying the field mask at the top level (routes), because:

Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

Declaration

public virtual ComputeRoutesResponse ComputeRoutes(ComputeRoutesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ComputeRoutesRequest	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
ComputeRoutesResponse	The response received from the server.

ComputeRoutesAsync(ComputeRoutesRequest, CallOptions)

Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.

For example, in this method:

Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
Field mask of Route-level duration, distance, and polyline (an example production setup): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google discourage the use of the wildcard (*) response field mask, or specifying the field mask at the top level (routes), because:

Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

Declaration

public virtual AsyncUnaryCall<ComputeRoutesResponse> ComputeRoutesAsync(ComputeRoutesRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<ComputeRoutesResponse>	The call object.

ComputeRoutesAsync(ComputeRoutesRequest, Metadata, DateTime?, CancellationToken)

Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.

For example, in this method:

Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
Field mask of Route-level duration, distance, and polyline (an example production setup): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google discourage the use of the wildcard (*) response field mask, or specifying the field mask at the top level (routes), because:

Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

Declaration

public virtual AsyncUnaryCall<ComputeRoutesResponse> ComputeRoutesAsync(ComputeRoutesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ComputeRoutesRequest	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<ComputeRoutesResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override Routes.RoutesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
Routes.RoutesClient

Overrides

ClientBase<Routes.RoutesClient>.NewInstance(ClientBase.ClientBaseConfiguration)