Compute Engine v1 API - Class TargetPoolsClientImpl (2.7.0)

public sealed class TargetPoolsClientImpl : TargetPoolsClient

Reference documentation and code samples for the Compute Engine v1 API class TargetPoolsClientImpl.

TargetPools client wrapper implementation, for convenient use.

Inheritance

object > TargetPoolsClient > TargetPoolsClientImpl

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The TargetPools API.

Constructors

TargetPoolsClientImpl(TargetPoolsClient, TargetPoolsSettings, ILogger)

public TargetPoolsClientImpl(TargetPools.TargetPoolsClient grpcClient, TargetPoolsSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientTargetPoolsTargetPoolsClient

The underlying gRPC client.

settingsTargetPoolsSettings

The base TargetPoolsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

AddHealthCheckOperationsClient

public override OperationsClient AddHealthCheckOperationsClient { get; }

The long-running operations client for AddHealthCheck.

Property Value
TypeDescription
OperationsClient
Overrides

AddInstanceOperationsClient

public override OperationsClient AddInstanceOperationsClient { get; }

The long-running operations client for AddInstance.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override TargetPools.TargetPoolsClient GrpcClient { get; }

The underlying gRPC TargetPools client

Property Value
TypeDescription
TargetPoolsTargetPoolsClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient
Overrides

RemoveHealthCheckOperationsClient

public override OperationsClient RemoveHealthCheckOperationsClient { get; }

The long-running operations client for RemoveHealthCheck.

Property Value
TypeDescription
OperationsClient
Overrides

RemoveInstanceOperationsClient

public override OperationsClient RemoveInstanceOperationsClient { get; }

The long-running operations client for RemoveInstance.

Property Value
TypeDescription
OperationsClient
Overrides

SetBackupOperationsClient

public override OperationsClient SetBackupOperationsClient { get; }

The long-running operations client for SetBackup.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

AddHealthCheck(AddHealthCheckTargetPoolRequest, CallSettings)

public override Operation<Operation, Operation> AddHealthCheck(AddHealthCheckTargetPoolRequest request, CallSettings callSettings = null)

Adds health check URLs to a target pool.

Parameters
NameDescription
requestAddHealthCheckTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

AddHealthCheckAsync(AddHealthCheckTargetPoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> AddHealthCheckAsync(AddHealthCheckTargetPoolRequest request, CallSettings callSettings = null)

Adds health check URLs to a target pool.

Parameters
NameDescription
requestAddHealthCheckTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

AddInstance(AddInstanceTargetPoolRequest, CallSettings)

public override Operation<Operation, Operation> AddInstance(AddInstanceTargetPoolRequest request, CallSettings callSettings = null)

Adds an instance to a target pool.

Parameters
NameDescription
requestAddInstanceTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

AddInstanceAsync(AddInstanceTargetPoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> AddInstanceAsync(AddInstanceTargetPoolRequest request, CallSettings callSettings = null)

Adds an instance to a target pool.

Parameters
NameDescription
requestAddInstanceTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

AggregatedList(AggregatedListTargetPoolsRequest, CallSettings)

public override PagedEnumerable<TargetPoolAggregatedList, KeyValuePair<string, TargetPoolsScopedList>> AggregatedList(AggregatedListTargetPoolsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of target pools.

Parameters
NameDescription
requestAggregatedListTargetPoolsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableTargetPoolAggregatedListKeyValuePairstringTargetPoolsScopedList

A pageable sequence of KeyValuePair<TKey,TValue> resources.

Overrides

AggregatedListAsync(AggregatedListTargetPoolsRequest, CallSettings)

public override PagedAsyncEnumerable<TargetPoolAggregatedList, KeyValuePair<string, TargetPoolsScopedList>> AggregatedListAsync(AggregatedListTargetPoolsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of target pools.

Parameters
NameDescription
requestAggregatedListTargetPoolsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableTargetPoolAggregatedListKeyValuePairstringTargetPoolsScopedList

A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Overrides

Delete(DeleteTargetPoolRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteTargetPoolRequest request, CallSettings callSettings = null)

Deletes the specified target pool.

Parameters
NameDescription
requestDeleteTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

DeleteAsync(DeleteTargetPoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteTargetPoolRequest request, CallSettings callSettings = null)

Deletes the specified target pool.

Parameters
NameDescription
requestDeleteTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

Get(GetTargetPoolRequest, CallSettings)

public override TargetPool Get(GetTargetPoolRequest request, CallSettings callSettings = null)

Returns the specified target pool. Gets a list of available target pools by making a list() request.

Parameters
NameDescription
requestGetTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TargetPool

The RPC response.

Overrides

GetAsync(GetTargetPoolRequest, CallSettings)

public override Task<TargetPool> GetAsync(GetTargetPoolRequest request, CallSettings callSettings = null)

Returns the specified target pool. Gets a list of available target pools by making a list() request.

Parameters
NameDescription
requestGetTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTargetPool

A Task containing the RPC response.

Overrides

GetHealth(GetHealthTargetPoolRequest, CallSettings)

public override TargetPoolInstanceHealth GetHealth(GetHealthTargetPoolRequest request, CallSettings callSettings = null)

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Parameters
NameDescription
requestGetHealthTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TargetPoolInstanceHealth

The RPC response.

Overrides

GetHealthAsync(GetHealthTargetPoolRequest, CallSettings)

public override Task<TargetPoolInstanceHealth> GetHealthAsync(GetHealthTargetPoolRequest request, CallSettings callSettings = null)

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Parameters
NameDescription
requestGetHealthTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTargetPoolInstanceHealth

A Task containing the RPC response.

Overrides

Insert(InsertTargetPoolRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertTargetPoolRequest request, CallSettings callSettings = null)

Creates a target pool in the specified project and region using the data included in the request.

Parameters
NameDescription
requestInsertTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

InsertAsync(InsertTargetPoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertTargetPoolRequest request, CallSettings callSettings = null)

Creates a target pool in the specified project and region using the data included in the request.

Parameters
NameDescription
requestInsertTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

List(ListTargetPoolsRequest, CallSettings)

public override PagedEnumerable<TargetPoolList, TargetPool> List(ListTargetPoolsRequest request, CallSettings callSettings = null)

Retrieves a list of target pools available to the specified project and region.

Parameters
NameDescription
requestListTargetPoolsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableTargetPoolListTargetPool

A pageable sequence of TargetPool resources.

Overrides

ListAsync(ListTargetPoolsRequest, CallSettings)

public override PagedAsyncEnumerable<TargetPoolList, TargetPool> ListAsync(ListTargetPoolsRequest request, CallSettings callSettings = null)

Retrieves a list of target pools available to the specified project and region.

Parameters
NameDescription
requestListTargetPoolsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableTargetPoolListTargetPool

A pageable asynchronous sequence of TargetPool resources.

Overrides

RemoveHealthCheck(RemoveHealthCheckTargetPoolRequest, CallSettings)

public override Operation<Operation, Operation> RemoveHealthCheck(RemoveHealthCheckTargetPoolRequest request, CallSettings callSettings = null)

Removes health check URL from a target pool.

Parameters
NameDescription
requestRemoveHealthCheckTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

RemoveHealthCheckAsync(RemoveHealthCheckTargetPoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> RemoveHealthCheckAsync(RemoveHealthCheckTargetPoolRequest request, CallSettings callSettings = null)

Removes health check URL from a target pool.

Parameters
NameDescription
requestRemoveHealthCheckTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

RemoveInstance(RemoveInstanceTargetPoolRequest, CallSettings)

public override Operation<Operation, Operation> RemoveInstance(RemoveInstanceTargetPoolRequest request, CallSettings callSettings = null)

Removes instance URL from a target pool.

Parameters
NameDescription
requestRemoveInstanceTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

RemoveInstanceAsync(RemoveInstanceTargetPoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> RemoveInstanceAsync(RemoveInstanceTargetPoolRequest request, CallSettings callSettings = null)

Removes instance URL from a target pool.

Parameters
NameDescription
requestRemoveInstanceTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

SetBackup(SetBackupTargetPoolRequest, CallSettings)

public override Operation<Operation, Operation> SetBackup(SetBackupTargetPoolRequest request, CallSettings callSettings = null)

Changes a backup target pool's configurations.

Parameters
NameDescription
requestSetBackupTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

SetBackupAsync(SetBackupTargetPoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetBackupAsync(SetBackupTargetPoolRequest request, CallSettings callSettings = null)

Changes a backup target pool's configurations.

Parameters
NameDescription
requestSetBackupTargetPoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides