Class RoutesClientImpl

Routes client wrapper implementation, for convenient use.

Inheritance

object

RoutesClient

RoutesClientImpl

Inherited Members

RoutesClient.DefaultEndpoint

RoutesClient.DefaultScopes

RoutesClient.ServiceMetadata

RoutesClient.CreateAsync(CancellationToken)

RoutesClient.Create()

RoutesClient.ShutdownDefaultChannelsAsync()

RoutesClient.ComputeRoutesAsync(ComputeRoutesRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Maps.Routing.V2

Assembly: Google.Maps.Routing.V2.dll

Syntax

public sealed class RoutesClientImpl : RoutesClient

Remarks

The Routes API.

Constructors

RoutesClientImpl(RoutesClient, RoutesSettings, ILogger)

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

Declaration

public RoutesClientImpl(Routes.RoutesClient grpcClient, RoutesSettings settings, ILogger logger)

Parameters

Type	Name	Description
Routes.RoutesClient	grpcClient	The underlying gRPC client.
RoutesSettings	settings	The base RoutesSettings used within this client.
ILogger	logger	Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC Routes client

Declaration

public override Routes.RoutesClient GrpcClient { get; }

Property Value

Type	Description
Routes.RoutesClient

Overrides

RoutesClient.GrpcClient

Methods

ComputeRouteMatrix(ComputeRouteMatrixRequest, CallSettings)

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 override RoutesClient.ComputeRouteMatrixStream ComputeRouteMatrix(ComputeRouteMatrixRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ComputeRouteMatrixRequest	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
RoutesClient.ComputeRouteMatrixStream	The server stream.

Overrides

RoutesClient.ComputeRouteMatrix(ComputeRouteMatrixRequest, CallSettings)

ComputeRoutes(ComputeRoutesRequest, CallSettings)

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 override ComputeRoutesResponse ComputeRoutes(ComputeRoutesRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ComputeRoutesRequest	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
ComputeRoutesResponse	The RPC response.

Overrides

RoutesClient.ComputeRoutes(ComputeRoutesRequest, CallSettings)

ComputeRoutesAsync(ComputeRoutesRequest, CallSettings)

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 override Task<ComputeRoutesResponse> ComputeRoutesAsync(ComputeRoutesRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ComputeRoutesRequest	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<ComputeRoutesResponse>	A Task containing the RPC response.

Overrides

RoutesClient.ComputeRoutesAsync(ComputeRoutesRequest, CallSettings)