Google.Cloud.Location - Class Locations.LocationsClient (2.3.0)

Version latest

• 2.3.0 (latest)
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

public class Locations.LocationsClient : ClientBase<Locations.LocationsClient>

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

Client for Locations

Inheritance

object > ClientBase > ClientBaseLocationsLocationsClient > Locations.LocationsClient

Inherited Members

ClientBase<Locations.LocationsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Location

Assembly

Google.Cloud.Location.dll

Constructors

LocationsClient()

protected LocationsClient()

Protected parameterless constructor to allow creation of test doubles.

LocationsClient(CallInvoker)

public LocationsClient(CallInvoker callInvoker)

Creates a new client for Locations that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

LocationsClient(ChannelBase)

public LocationsClient(ChannelBase channel)

Creates a new client for Locations

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

LocationsClient(ClientBaseConfiguration)

protected LocationsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

GetLocation(GetLocationRequest, CallOptions)

public virtual Location GetLocation(GetLocationRequest request, CallOptions options)

Gets information about a location.

Parameters
Name	Description
request	GetLocationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Location	The response received from the server.

GetLocation(GetLocationRequest, Metadata, DateTime?, CancellationToken)

public virtual Location GetLocation(GetLocationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a location.

Parameters
Name	Description
request	GetLocationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Location	The response received from the server.

GetLocationAsync(GetLocationRequest, CallOptions)

public virtual AsyncUnaryCall<Location> GetLocationAsync(GetLocationRequest request, CallOptions options)

Gets information about a location.

Parameters
Name	Description
request	GetLocationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallLocation	The call object.

GetLocationAsync(GetLocationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Location> GetLocationAsync(GetLocationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a location.

Parameters
Name	Description
request	GetLocationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallLocation	The call object.

ListLocations(ListLocationsRequest, CallOptions)

public virtual ListLocationsResponse ListLocations(ListLocationsRequest request, CallOptions options)

Lists information about the supported locations for this service.

Parameters
Name	Description
request	ListLocationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListLocationsResponse	The response received from the server.

ListLocations(ListLocationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListLocationsResponse ListLocations(ListLocationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists information about the supported locations for this service.

Parameters
Name	Description
request	ListLocationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListLocationsResponse	The response received from the server.

ListLocationsAsync(ListLocationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListLocationsResponse> ListLocationsAsync(ListLocationsRequest request, CallOptions options)

Lists information about the supported locations for this service.

Parameters
Name	Description
request	ListLocationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListLocationsResponse	The call object.

ListLocationsAsync(ListLocationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListLocationsResponse> ListLocationsAsync(ListLocationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists information about the supported locations for this service.

Parameters
Name	Description
request	ListLocationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListLocationsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Locations.LocationsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
LocationsLocationsClient

Overrides

ClientBase<Locations.LocationsClient>.NewInstance(ClientBase.ClientBaseConfiguration)