Cloud Location Finder v1 API - Class CloudLocationFinder.CloudLocationFinderClient (1.0.0-beta01) 

public class CloudLocationFinder.CloudLocationFinderClient : ClientBase<CloudLocationFinder.CloudLocationFinderClient>

Reference documentation and code samples for the Cloud Location Finder v1 API class CloudLocationFinder.CloudLocationFinderClient.

Client for CloudLocationFinder

Inheritance

object > ClientBase > ClientBaseCloudLocationFinderCloudLocationFinderClient > CloudLocationFinder.CloudLocationFinderClient

Namespace

Google.Cloud.LocationFinder.V1

Assembly

Google.Cloud.LocationFinder.V1.dll

Constructors

CloudLocationFinderClient()

protected CloudLocationFinderClient()

Protected parameterless constructor to allow creation of test doubles.

CloudLocationFinderClient(CallInvoker)

public CloudLocationFinderClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

CloudLocationFinderClient(ChannelBase)

public CloudLocationFinderClient(ChannelBase channel)

Creates a new client for CloudLocationFinder

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

CloudLocationFinderClient(ClientBaseConfiguration)

protected CloudLocationFinderClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

GetCloudLocation(GetCloudLocationRequest, CallOptions)

public virtual CloudLocation GetCloudLocation(GetCloudLocationRequest request, CallOptions options)

Retrieves a resource containing information about a cloud location.

Parameters
Name Description
request GetCloudLocationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
CloudLocation

The response received from the server.

GetCloudLocation(GetCloudLocationRequest, Metadata, DateTime?, CancellationToken)

public virtual CloudLocation GetCloudLocation(GetCloudLocationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a resource containing information about a cloud location.

Parameters
Name Description
request GetCloudLocationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
CloudLocation

The response received from the server.

GetCloudLocationAsync(GetCloudLocationRequest, CallOptions)

public virtual AsyncUnaryCall<CloudLocation> GetCloudLocationAsync(GetCloudLocationRequest request, CallOptions options)

Retrieves a resource containing information about a cloud location.

Parameters
Name Description
request GetCloudLocationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCloudLocation

The call object.

GetCloudLocationAsync(GetCloudLocationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CloudLocation> GetCloudLocationAsync(GetCloudLocationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a resource containing information about a cloud location.

Parameters
Name Description
request GetCloudLocationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallCloudLocation

The call object.

ListCloudLocations(ListCloudLocationsRequest, CallOptions)

public virtual ListCloudLocationsResponse ListCloudLocations(ListCloudLocationsRequest request, CallOptions options)

Lists cloud locations under a given project and location.

Parameters
Name Description
request ListCloudLocationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListCloudLocationsResponse

The response received from the server.

ListCloudLocations(ListCloudLocationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCloudLocationsResponse ListCloudLocations(ListCloudLocationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists cloud locations under a given project and location.

Parameters
Name Description
request ListCloudLocationsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
ListCloudLocationsResponse

The response received from the server.

ListCloudLocationsAsync(ListCloudLocationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCloudLocationsResponse> ListCloudLocationsAsync(ListCloudLocationsRequest request, CallOptions options)

Lists cloud locations under a given project and location.

Parameters
Name Description
request ListCloudLocationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListCloudLocationsResponse

The call object.

ListCloudLocationsAsync(ListCloudLocationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCloudLocationsResponse> ListCloudLocationsAsync(ListCloudLocationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists cloud locations under a given project and location.

Parameters
Name Description
request ListCloudLocationsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallListCloudLocationsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override CloudLocationFinder.CloudLocationFinderClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
CloudLocationFinderCloudLocationFinderClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.LocationFinder.V1.CloudLocationFinder.CloudLocationFinderClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SearchCloudLocations(SearchCloudLocationsRequest, CallOptions)

public virtual SearchCloudLocationsResponse SearchCloudLocations(SearchCloudLocationsRequest request, CallOptions options)

Searches for cloud locations from a given source location.

Parameters
Name Description
request SearchCloudLocationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
SearchCloudLocationsResponse

The response received from the server.

SearchCloudLocations(SearchCloudLocationsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchCloudLocationsResponse SearchCloudLocations(SearchCloudLocationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches for cloud locations from a given source location.

Parameters
Name Description
request SearchCloudLocationsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
SearchCloudLocationsResponse

The response received from the server.

SearchCloudLocationsAsync(SearchCloudLocationsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchCloudLocationsResponse> SearchCloudLocationsAsync(SearchCloudLocationsRequest request, CallOptions options)

Searches for cloud locations from a given source location.

Parameters
Name Description
request SearchCloudLocationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSearchCloudLocationsResponse

The call object.

SearchCloudLocationsAsync(SearchCloudLocationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchCloudLocationsResponse> SearchCloudLocationsAsync(SearchCloudLocationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches for cloud locations from a given source location.

Parameters
Name Description
request SearchCloudLocationsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallSearchCloudLocationsResponse

The call object.