Class LocationsClientImpl (1.0.0)

public sealed class LocationsClientImpl : LocationsClient

Locations client wrapper implementation, for convenient use.

Inheritance

Object > LocationsClient > LocationsClientImpl

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(Locations.LocationsClient, LocationsSettings, Logging.ILogger)

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

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

Parameters
NameDescription
grpcClientLocations.LocationsClient

The underlying gRPC client.

settingsLocationsSettings

The base LocationsSettings used within this client.

loggerLogging.ILogger

Optional to use within this client.

Properties

GrpcClient

public override Locations.LocationsClient GrpcClient { get; }

The underlying gRPC Locations client

Property Value
TypeDescription
Locations.LocationsClient
Overrides

Methods

GetLocation(GetLocationRequest, Api.Gax.Grpc.CallSettings)

public override Location GetLocation(GetLocationRequest request, Api.Gax.Grpc.CallSettings callSettings = null)

Gets information about a location.

Parameters
NameDescription
requestGetLocationRequest

The request object containing all of the parameters for the API call.

callSettingsApi.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Location

The RPC response.

Overrides

GetLocationAsync(GetLocationRequest, Api.Gax.Grpc.CallSettings)

public override System.Threading.Tasks.Task<Location> GetLocationAsync(GetLocationRequest request, Api.Gax.Grpc.CallSettings callSettings = null)

Gets information about a location.

Parameters
NameDescription
requestGetLocationRequest

The request object containing all of the parameters for the API call.

callSettingsApi.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
System.Threading.Tasks.Task<Location>

A Task containing the RPC response.

Overrides

ListLocations(ListLocationsRequest, Api.Gax.Grpc.CallSettings)

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

Lists information about the supported locations for this service.

Parameters
NameDescription
requestListLocationsRequest

The request object containing all of the parameters for the API call.

callSettingsApi.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Api.Gax.PagedEnumerable<ListLocationsResponse, Location>

A pageable sequence of Location resources.

Overrides

ListLocationsAsync(ListLocationsRequest, Api.Gax.Grpc.CallSettings)

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

Lists information about the supported locations for this service.

Parameters
NameDescription
requestListLocationsRequest

The request object containing all of the parameters for the API call.

callSettingsApi.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Api.Gax.PagedAsyncEnumerable<ListLocationsResponse, Location>

A pageable asynchronous sequence of Location resources.

Overrides