Class IsochroneServiceClient
IsochroneService client wrapper, for convenient use.
Namespace: Google.Maps.Isochrones.V1
Assembly: Google.Maps.Isochrones.V1.dll
Syntax
public abstract class IsochroneServiceClient
Remarks
Service for calculating isochrones. An isochrone is an area of reachability from a given origin point within a specified travel time.
Properties
DefaultEndpoint
The default endpoint for the IsochroneService service, which is a host of "isochrones.googleapis.com" and a port of 443.
Declaration
public static string DefaultEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| string |
DefaultScopes
The default IsochroneService scopes.
Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<string> |
Remarks
The default IsochroneService scopes are:
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/maps-platform.isochrones
GrpcClient
The underlying gRPC IsochroneService client
Declaration
public virtual IsochroneService.IsochroneServiceClient GrpcClient { get; }
Property Value
| Type | Description |
|---|---|
| IsochroneService.IsochroneServiceClient |
ServiceMetadata
The service metadata associated with this client type.
Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
| Type | Description |
|---|---|
| ServiceMetadata |
Methods
Create()
Synchronously creates a IsochroneServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IsochroneServiceClientBuilder.
Declaration
public static IsochroneServiceClient Create()
Returns
| Type | Description |
|---|---|
| IsochroneServiceClient | The created IsochroneServiceClient. |
CreateAsync(CancellationToken)
Asynchronously creates a IsochroneServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IsochroneServiceClientBuilder.
Declaration
public static Task<IsochroneServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | The CancellationToken to use while creating the client. |
Returns
| Type | Description |
|---|---|
| Task<IsochroneServiceClient> | The task representing the created IsochroneServiceClient. |
GenerateIsochrone(GenerateIsochroneRequest, CallSettings)
Calculates and returns a single isochrone for a given set of parameters.
Declaration
public virtual GenerateIsochroneResponse GenerateIsochrone(GenerateIsochroneRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateIsochroneRequest | 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 |
|---|---|
| GenerateIsochroneResponse | The RPC response. |
Sample code
// Create client
IsochroneServiceClient isochroneServiceClient = IsochroneServiceClient.Create();
// Initialize request argument(s)
GenerateIsochroneRequest request = new GenerateIsochroneRequest
{
Location = new LatLng(),
TravelDuration = new Duration(),
TravelMode = GenerateIsochroneRequest.Types.TravelMode.Unspecified,
TravelDirection = GenerateIsochroneRequest.Types.TravelDirection.Unspecified,
RoutingPreference = GenerateIsochroneRequest.Types.RoutingPreference.Unspecified,
EnableSmoothing = false,
PolygonFidelity = GenerateIsochroneRequest.Types.PolygonFidelity.Unspecified,
};
// Make the request
GenerateIsochroneResponse response = isochroneServiceClient.GenerateIsochrone(request);
GenerateIsochroneAsync(GenerateIsochroneRequest, CallSettings)
Calculates and returns a single isochrone for a given set of parameters.
Declaration
public virtual Task<GenerateIsochroneResponse> GenerateIsochroneAsync(GenerateIsochroneRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateIsochroneRequest | 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<GenerateIsochroneResponse> | A Task containing the RPC response. |
Sample code
// Create client
IsochroneServiceClient isochroneServiceClient = await IsochroneServiceClient.CreateAsync();
// Initialize request argument(s)
GenerateIsochroneRequest request = new GenerateIsochroneRequest
{
Location = new LatLng(),
TravelDuration = new Duration(),
TravelMode = GenerateIsochroneRequest.Types.TravelMode.Unspecified,
TravelDirection = GenerateIsochroneRequest.Types.TravelDirection.Unspecified,
RoutingPreference = GenerateIsochroneRequest.Types.RoutingPreference.Unspecified,
EnableSmoothing = false,
PolygonFidelity = GenerateIsochroneRequest.Types.PolygonFidelity.Unspecified,
};
// Make the request
GenerateIsochroneResponse response = await isochroneServiceClient.GenerateIsochroneAsync(request);
GenerateIsochroneAsync(GenerateIsochroneRequest, CancellationToken)
Calculates and returns a single isochrone for a given set of parameters.
Declaration
public virtual Task<GenerateIsochroneResponse> GenerateIsochroneAsync(GenerateIsochroneRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateIsochroneRequest | request | The request object containing all of the parameters for the API call. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<GenerateIsochroneResponse> | A Task containing the RPC response. |
Sample code
// Create client
IsochroneServiceClient isochroneServiceClient = await IsochroneServiceClient.CreateAsync();
// Initialize request argument(s)
GenerateIsochroneRequest request = new GenerateIsochroneRequest
{
Location = new LatLng(),
TravelDuration = new Duration(),
TravelMode = GenerateIsochroneRequest.Types.TravelMode.Unspecified,
TravelDirection = GenerateIsochroneRequest.Types.TravelDirection.Unspecified,
RoutingPreference = GenerateIsochroneRequest.Types.RoutingPreference.Unspecified,
EnableSmoothing = false,
PolygonFidelity = GenerateIsochroneRequest.Types.PolygonFidelity.Unspecified,
};
// Make the request
GenerateIsochroneResponse response = await isochroneServiceClient.GenerateIsochroneAsync(request);
ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Declaration
public static Task ShutdownDefaultChannelsAsync()
Returns
| Type | Description |
|---|---|
| Task | A task representing the asynchronous shutdown operation. |
Remarks
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.