Google.Cloud.Location - Class LocationsClientImpl (2.3.0)

public sealed class LocationsClientImpl : LocationsClient

Reference documentation and code samples for the Google.Cloud.Location class LocationsClientImpl.

Locations client wrapper implementation, for convenient use.

Inheritance

object > LocationsClient > LocationsClientImpl

Inherited Members

LocationsClient.DefaultEndpoint

LocationsClient.DefaultScopes

LocationsClient.ServiceMetadata

LocationsClient.CreateAsync(CancellationToken)

LocationsClient.Create()

LocationsClient.ShutdownDefaultChannelsAsync()

LocationsClient.GetLocationAsync(GetLocationRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Location

Assembly

Google.Cloud.Location.dll

Remarks

An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the [Location.metadata][google.cloud.location.Location.metadata] field.

Constructors

LocationsClientImpl(LocationsClient, LocationsSettings, ILogger)

public LocationsClientImpl(Locations.LocationsClient grpcClient, LocationsSettings settings, ILogger logger)

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

Parameters
Name	Description
`grpcClient`	`LocationsLocationsClient` The underlying gRPC client.
`settings`	`LocationsSettings` The base LocationsSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override Locations.LocationsClient GrpcClient { get; }

The underlying gRPC Locations client

Property Value
Type	Description
`LocationsLocationsClient`

Overrides

LocationsClient.GrpcClient

Methods

GetLocation(GetLocationRequest, CallSettings)

public override Location GetLocation(GetLocationRequest request, CallSettings callSettings = null)

Gets information about a location.

Parameters
Name	Description
`request`	`GetLocationRequest` 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
`Location`	The RPC response.

Overrides

LocationsClient.GetLocation(GetLocationRequest, CallSettings)

GetLocationAsync(GetLocationRequest, CallSettings)

public override Task<Location> GetLocationAsync(GetLocationRequest request, CallSettings callSettings = null)

Gets information about a location.

Parameters
Name	Description
`request`	`GetLocationRequest` 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
`TaskLocation`	A Task containing the RPC response.

Overrides

LocationsClient.GetLocationAsync(GetLocationRequest, CallSettings)

ListLocations(ListLocationsRequest, CallSettings)

public override PagedEnumerable<ListLocationsResponse, Location> ListLocations(ListLocationsRequest request, CallSettings callSettings = null)

Lists information about the supported locations for this service.

Parameters
Name	Description
`request`	`ListLocationsRequest` 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
`PagedEnumerableListLocationsResponseLocation`	A pageable sequence of Location resources.

Overrides

LocationsClient.ListLocations(ListLocationsRequest, CallSettings)

ListLocationsAsync(ListLocationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListLocationsResponse, Location> ListLocationsAsync(ListLocationsRequest request, CallSettings callSettings = null)

Lists information about the supported locations for this service.

Parameters
Name	Description
`request`	`ListLocationsRequest` 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
`PagedAsyncEnumerableListLocationsResponseLocation`	A pageable asynchronous sequence of Location resources.

Overrides

LocationsClient.ListLocationsAsync(ListLocationsRequest, CallSettings)