Compute Engine v1 API - Class TargetPoolsClientImpl (2.9.0)

Version 2.9.0

• 3.1.0 (latest)
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.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

Inherited Members

TargetPoolsClient.DefaultEndpoint

TargetPoolsClient.DefaultScopes

TargetPoolsClient.ServiceMetadata

TargetPoolsClient.CreateAsync(CancellationToken)

TargetPoolsClient.Create()

TargetPoolsClient.ShutdownDefaultChannelsAsync()

TargetPoolsClient.AddHealthCheckAsync(AddHealthCheckTargetPoolRequest, CancellationToken)

TargetPoolsClient.PollOnceAddHealthCheck(string, CallSettings)

TargetPoolsClient.PollOnceAddHealthCheckAsync(string, CallSettings)

TargetPoolsClient.AddHealthCheck(string, string, string, TargetPoolsAddHealthCheckRequest, CallSettings)

TargetPoolsClient.AddHealthCheckAsync(string, string, string, TargetPoolsAddHealthCheckRequest, CallSettings)

TargetPoolsClient.AddHealthCheckAsync(string, string, string, TargetPoolsAddHealthCheckRequest, CancellationToken)

TargetPoolsClient.AddInstanceAsync(AddInstanceTargetPoolRequest, CancellationToken)

TargetPoolsClient.PollOnceAddInstance(string, CallSettings)

TargetPoolsClient.PollOnceAddInstanceAsync(string, CallSettings)

TargetPoolsClient.AddInstance(string, string, string, TargetPoolsAddInstanceRequest, CallSettings)

TargetPoolsClient.AddInstanceAsync(string, string, string, TargetPoolsAddInstanceRequest, CallSettings)

TargetPoolsClient.AddInstanceAsync(string, string, string, TargetPoolsAddInstanceRequest, CancellationToken)

TargetPoolsClient.AggregatedList(string, string, int?, CallSettings)

TargetPoolsClient.AggregatedListAsync(string, string, int?, CallSettings)

TargetPoolsClient.DeleteAsync(DeleteTargetPoolRequest, CancellationToken)

TargetPoolsClient.PollOnceDelete(string, CallSettings)

TargetPoolsClient.PollOnceDeleteAsync(string, CallSettings)

TargetPoolsClient.Delete(string, string, string, CallSettings)

TargetPoolsClient.DeleteAsync(string, string, string, CallSettings)

TargetPoolsClient.DeleteAsync(string, string, string, CancellationToken)

TargetPoolsClient.GetAsync(GetTargetPoolRequest, CancellationToken)

TargetPoolsClient.Get(string, string, string, CallSettings)

TargetPoolsClient.GetAsync(string, string, string, CallSettings)

TargetPoolsClient.GetAsync(string, string, string, CancellationToken)

TargetPoolsClient.GetHealthAsync(GetHealthTargetPoolRequest, CancellationToken)

TargetPoolsClient.GetHealth(string, string, string, InstanceReference, CallSettings)

TargetPoolsClient.GetHealthAsync(string, string, string, InstanceReference, CallSettings)

TargetPoolsClient.GetHealthAsync(string, string, string, InstanceReference, CancellationToken)

TargetPoolsClient.InsertAsync(InsertTargetPoolRequest, CancellationToken)

TargetPoolsClient.PollOnceInsert(string, CallSettings)

TargetPoolsClient.PollOnceInsertAsync(string, CallSettings)

TargetPoolsClient.Insert(string, string, TargetPool, CallSettings)

TargetPoolsClient.InsertAsync(string, string, TargetPool, CallSettings)

TargetPoolsClient.InsertAsync(string, string, TargetPool, CancellationToken)

TargetPoolsClient.List(string, string, string, int?, CallSettings)

TargetPoolsClient.ListAsync(string, string, string, int?, CallSettings)

TargetPoolsClient.RemoveHealthCheckAsync(RemoveHealthCheckTargetPoolRequest, CancellationToken)

TargetPoolsClient.PollOnceRemoveHealthCheck(string, CallSettings)

TargetPoolsClient.PollOnceRemoveHealthCheckAsync(string, CallSettings)

TargetPoolsClient.RemoveHealthCheck(string, string, string, TargetPoolsRemoveHealthCheckRequest, CallSettings)

TargetPoolsClient.RemoveHealthCheckAsync(string, string, string, TargetPoolsRemoveHealthCheckRequest, CallSettings)

TargetPoolsClient.RemoveHealthCheckAsync(string, string, string, TargetPoolsRemoveHealthCheckRequest, CancellationToken)

TargetPoolsClient.RemoveInstanceAsync(RemoveInstanceTargetPoolRequest, CancellationToken)

TargetPoolsClient.PollOnceRemoveInstance(string, CallSettings)

TargetPoolsClient.PollOnceRemoveInstanceAsync(string, CallSettings)

TargetPoolsClient.RemoveInstance(string, string, string, TargetPoolsRemoveInstanceRequest, CallSettings)

TargetPoolsClient.RemoveInstanceAsync(string, string, string, TargetPoolsRemoveInstanceRequest, CallSettings)

TargetPoolsClient.RemoveInstanceAsync(string, string, string, TargetPoolsRemoveInstanceRequest, CancellationToken)

TargetPoolsClient.SetBackupAsync(SetBackupTargetPoolRequest, CancellationToken)

TargetPoolsClient.PollOnceSetBackup(string, CallSettings)

TargetPoolsClient.PollOnceSetBackupAsync(string, CallSettings)

TargetPoolsClient.SetBackup(string, string, string, TargetReference, CallSettings)

TargetPoolsClient.SetBackupAsync(string, string, string, TargetReference, CallSettings)

TargetPoolsClient.SetBackupAsync(string, string, string, TargetReference, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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
Name	Description
grpcClient	TargetPoolsTargetPoolsClient The underlying gRPC client.
settings	TargetPoolsSettings The base TargetPoolsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

AddHealthCheckOperationsClient

public override OperationsClient AddHealthCheckOperationsClient { get; }

The long-running operations client for AddHealthCheck.

Property Value
Type	Description
OperationsClient

Overrides

TargetPoolsClient.AddHealthCheckOperationsClient

AddInstanceOperationsClient

public override OperationsClient AddInstanceOperationsClient { get; }

The long-running operations client for AddInstance.

Property Value
Type	Description
OperationsClient

Overrides

TargetPoolsClient.AddInstanceOperationsClient

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

Overrides

TargetPoolsClient.DeleteOperationsClient

GrpcClient

public override TargetPools.TargetPoolsClient GrpcClient { get; }

The underlying gRPC TargetPools client

Property Value
Type	Description
TargetPoolsTargetPoolsClient

Overrides

TargetPoolsClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Overrides

TargetPoolsClient.InsertOperationsClient

RemoveHealthCheckOperationsClient

public override OperationsClient RemoveHealthCheckOperationsClient { get; }

The long-running operations client for RemoveHealthCheck.

Property Value
Type	Description
OperationsClient

Overrides

TargetPoolsClient.RemoveHealthCheckOperationsClient

RemoveInstanceOperationsClient

public override OperationsClient RemoveInstanceOperationsClient { get; }

The long-running operations client for RemoveInstance.

Property Value
Type	Description
OperationsClient

Overrides

TargetPoolsClient.RemoveInstanceOperationsClient

SetBackupOperationsClient

public override OperationsClient SetBackupOperationsClient { get; }

The long-running operations client for SetBackup.

Property Value
Type	Description
OperationsClient

Overrides

TargetPoolsClient.SetBackupOperationsClient

Methods

AddHealthCheck(AddHealthCheckTargetPoolRequest, CallSettings)

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

Adds health check URLs to a target pool.

Parameters
Name	Description
request	AddHealthCheckTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

TargetPoolsClient.AddHealthCheck(AddHealthCheckTargetPoolRequest, CallSettings)

AddHealthCheckAsync(AddHealthCheckTargetPoolRequest, CallSettings)

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

Adds health check URLs to a target pool.

Parameters
Name	Description
request	AddHealthCheckTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

TargetPoolsClient.AddHealthCheckAsync(AddHealthCheckTargetPoolRequest, CallSettings)

AddInstance(AddInstanceTargetPoolRequest, CallSettings)

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

Adds an instance to a target pool.

Parameters
Name	Description
request	AddInstanceTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

TargetPoolsClient.AddInstance(AddInstanceTargetPoolRequest, CallSettings)

AddInstanceAsync(AddInstanceTargetPoolRequest, CallSettings)

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

Adds an instance to a target pool.

Parameters
Name	Description
request	AddInstanceTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

TargetPoolsClient.AddInstanceAsync(AddInstanceTargetPoolRequest, CallSettings)

AggregatedList(AggregatedListTargetPoolsRequest, CallSettings)

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

Retrieves an aggregated list of target pools.

Parameters
Name	Description
request	AggregatedListTargetPoolsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableTargetPoolAggregatedListKeyValuePairstringTargetPoolsScopedList	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Overrides

TargetPoolsClient.AggregatedList(AggregatedListTargetPoolsRequest, CallSettings)

AggregatedListAsync(AggregatedListTargetPoolsRequest, CallSettings)

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

Retrieves an aggregated list of target pools.

Parameters
Name	Description
request	AggregatedListTargetPoolsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableTargetPoolAggregatedListKeyValuePairstringTargetPoolsScopedList	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Overrides

TargetPoolsClient.AggregatedListAsync(AggregatedListTargetPoolsRequest, CallSettings)

Delete(DeleteTargetPoolRequest, CallSettings)

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

Deletes the specified target pool.

Parameters
Name	Description
request	DeleteTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

TargetPoolsClient.Delete(DeleteTargetPoolRequest, CallSettings)

DeleteAsync(DeleteTargetPoolRequest, CallSettings)

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

Deletes the specified target pool.

Parameters
Name	Description
request	DeleteTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

TargetPoolsClient.DeleteAsync(DeleteTargetPoolRequest, CallSettings)

Get(GetTargetPoolRequest, CallSettings)

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

Returns the specified target pool.

Parameters
Name	Description
request	GetTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TargetPool	The RPC response.

Overrides

TargetPoolsClient.Get(GetTargetPoolRequest, CallSettings)

GetAsync(GetTargetPoolRequest, CallSettings)

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

Returns the specified target pool.

Parameters
Name	Description
request	GetTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTargetPool	A Task containing the RPC response.

Overrides

TargetPoolsClient.GetAsync(GetTargetPoolRequest, CallSettings)

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
Name	Description
request	GetHealthTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TargetPoolInstanceHealth	The RPC response.

Overrides

TargetPoolsClient.GetHealth(GetHealthTargetPoolRequest, CallSettings)

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
Name	Description
request	GetHealthTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTargetPoolInstanceHealth	A Task containing the RPC response.

Overrides

TargetPoolsClient.GetHealthAsync(GetHealthTargetPoolRequest, CallSettings)

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
Name	Description
request	InsertTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

TargetPoolsClient.Insert(InsertTargetPoolRequest, CallSettings)

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
Name	Description
request	InsertTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

TargetPoolsClient.InsertAsync(InsertTargetPoolRequest, CallSettings)

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
Name	Description
request	ListTargetPoolsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableTargetPoolListTargetPool	A pageable sequence of TargetPool resources.

Overrides

TargetPoolsClient.List(ListTargetPoolsRequest, CallSettings)

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
Name	Description
request	ListTargetPoolsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableTargetPoolListTargetPool	A pageable asynchronous sequence of TargetPool resources.

Overrides

TargetPoolsClient.ListAsync(ListTargetPoolsRequest, CallSettings)

RemoveHealthCheck(RemoveHealthCheckTargetPoolRequest, CallSettings)

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

Removes health check URL from a target pool.

Parameters
Name	Description
request	RemoveHealthCheckTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

TargetPoolsClient.RemoveHealthCheck(RemoveHealthCheckTargetPoolRequest, CallSettings)

RemoveHealthCheckAsync(RemoveHealthCheckTargetPoolRequest, CallSettings)

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

Removes health check URL from a target pool.

Parameters
Name	Description
request	RemoveHealthCheckTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

TargetPoolsClient.RemoveHealthCheckAsync(RemoveHealthCheckTargetPoolRequest, CallSettings)

RemoveInstance(RemoveInstanceTargetPoolRequest, CallSettings)

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

Removes instance URL from a target pool.

Parameters
Name	Description
request	RemoveInstanceTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

TargetPoolsClient.RemoveInstance(RemoveInstanceTargetPoolRequest, CallSettings)

RemoveInstanceAsync(RemoveInstanceTargetPoolRequest, CallSettings)

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

Removes instance URL from a target pool.

Parameters
Name	Description
request	RemoveInstanceTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

TargetPoolsClient.RemoveInstanceAsync(RemoveInstanceTargetPoolRequest, CallSettings)

SetBackup(SetBackupTargetPoolRequest, CallSettings)

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

Changes a backup target pool's configurations.

Parameters
Name	Description
request	SetBackupTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

TargetPoolsClient.SetBackup(SetBackupTargetPoolRequest, CallSettings)

SetBackupAsync(SetBackupTargetPoolRequest, CallSettings)

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

Changes a backup target pool's configurations.

Parameters
Name	Description
request	SetBackupTargetPoolRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

TargetPoolsClient.SetBackupAsync(SetBackupTargetPoolRequest, CallSettings)