public class LocationsClient : Grpc.Core.ClientBase<Locations.LocationsClient>Client for Locations
Namespace
Google.Cloud.LocationAssembly
Google.Cloud.Location.dll
Constructors
LocationsClient()
protected LocationsClient()Protected parameterless constructor to allow creation of test doubles.
LocationsClient(ClientBaseConfiguration)
protected LocationsClient(ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseConfigurationThe client configuration. |
LocationsClient(Grpc.Core.CallInvoker)
public LocationsClient(Grpc.Core.CallInvoker callInvoker)Creates a new client for Locations that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
Grpc.Core.CallInvokerThe callInvoker to use to make remote calls. |
LocationsClient(Grpc.Core.ChannelBase)
public LocationsClient(Grpc.Core.ChannelBase channel)Creates a new client for Locations
| Parameter | |
|---|---|
| Name | Description |
channel |
Grpc.Core.ChannelBaseThe channel to use to make remote calls. |
Methods
GetLocation(GetLocationRequest, Grpc.Core.CallOptions)
public virtual Location GetLocation(GetLocationRequest request, Grpc.Core.CallOptions options)Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
GetLocationRequestThe request to send to the server. |
options |
Grpc.Core.CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Location |
The response received from the server. |
GetLocation(GetLocationRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)
public virtual Location GetLocation(GetLocationRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
GetLocationRequestThe request to send to the server. |
headers |
Grpc.Core.MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<System.DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
System.Threading.CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Location |
The response received from the server. |
GetLocationAsync(GetLocationRequest, Grpc.Core.CallOptions)
public virtual Grpc.Core.AsyncUnaryCall<Location> GetLocationAsync(GetLocationRequest request, Grpc.Core.CallOptions options)Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
GetLocationRequestThe request to send to the server. |
options |
Grpc.Core.CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Grpc.Core.AsyncUnaryCall<Location> |
The call object. |
GetLocationAsync(GetLocationRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)
public virtual Grpc.Core.AsyncUnaryCall<Location> GetLocationAsync(GetLocationRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
GetLocationRequestThe request to send to the server. |
headers |
Grpc.Core.MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<System.DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
System.Threading.CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Grpc.Core.AsyncUnaryCall<Location> |
The call object. |
ListLocations(ListLocationsRequest, Grpc.Core.CallOptions)
public virtual ListLocationsResponse ListLocations(ListLocationsRequest request, Grpc.Core.CallOptions options)Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
ListLocationsRequestThe request to send to the server. |
options |
Grpc.Core.CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListLocationsResponse |
The response received from the server. |
ListLocations(ListLocationsRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)
public virtual ListLocationsResponse ListLocations(ListLocationsRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
ListLocationsRequestThe request to send to the server. |
headers |
Grpc.Core.MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<System.DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
System.Threading.CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListLocationsResponse |
The response received from the server. |
ListLocationsAsync(ListLocationsRequest, Grpc.Core.CallOptions)
public virtual Grpc.Core.AsyncUnaryCall<ListLocationsResponse> ListLocationsAsync(ListLocationsRequest request, Grpc.Core.CallOptions options)Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
ListLocationsRequestThe request to send to the server. |
options |
Grpc.Core.CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Grpc.Core.AsyncUnaryCall<ListLocationsResponse> |
The call object. |
ListLocationsAsync(ListLocationsRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)
public virtual Grpc.Core.AsyncUnaryCall<ListLocationsResponse> ListLocationsAsync(ListLocationsRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
ListLocationsRequestThe request to send to the server. |
headers |
Grpc.Core.MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<System.DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
System.Threading.CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Grpc.Core.AsyncUnaryCall<ListLocationsResponse> |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override Locations.LocationsClient NewInstance(ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
Locations.LocationsClient |
|