Compute Engine v1 API - Class TargetPoolsClient (2.17.0)

public abstract class TargetPoolsClient

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

TargetPools client wrapper, for convenient use.

Inheritance

object > TargetPoolsClient

Derived Types

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The TargetPools API.

Properties

AddHealthCheckOperationsClient

public virtual OperationsClient AddHealthCheckOperationsClient { get; }

The long-running operations client for AddHealthCheck.

Property Value
Type Description
OperationsClient

AddInstanceOperationsClient

public virtual OperationsClient AddInstanceOperationsClient { get; }

The long-running operations client for AddInstance.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the TargetPools service, which is a host of "compute.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default TargetPools scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual TargetPools.TargetPoolsClient GrpcClient { get; }

The underlying gRPC TargetPools client

Property Value
Type Description
TargetPoolsTargetPoolsClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient

RemoveHealthCheckOperationsClient

public virtual OperationsClient RemoveHealthCheckOperationsClient { get; }

The long-running operations client for RemoveHealthCheck.

Property Value
Type Description
OperationsClient

RemoveInstanceOperationsClient

public virtual OperationsClient RemoveInstanceOperationsClient { get; }

The long-running operations client for RemoveInstance.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

SetBackupOperationsClient

public virtual OperationsClient SetBackupOperationsClient { get; }

The long-running operations client for SetBackup.

Property Value
Type Description
OperationsClient

SetSecurityPolicyOperationsClient

public virtual OperationsClient SetSecurityPolicyOperationsClient { get; }

The long-running operations client for SetSecurityPolicy.

Property Value
Type Description
OperationsClient

Methods

AddHealthCheck(AddHealthCheckTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
AddHealthCheckTargetPoolRequest request = new AddHealthCheckTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
    TargetPoolsAddHealthCheckRequestResource = new TargetPoolsAddHealthCheckRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.AddHealthCheck(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceAddHealthCheck(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddHealthCheck(string, string, string, TargetPoolsAddHealthCheckRequest, CallSettings)

public virtual Operation<Operation, Operation> AddHealthCheck(string project, string region, string targetPool, TargetPoolsAddHealthCheckRequest targetPoolsAddHealthCheckRequestResource, CallSettings callSettings = null)

Adds health check URLs to a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the target pool to add a health check to.

targetPoolsAddHealthCheckRequestResource TargetPoolsAddHealthCheckRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsAddHealthCheckRequest targetPoolsAddHealthCheckRequestResource = new TargetPoolsAddHealthCheckRequest();
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.AddHealthCheck(project, region, targetPool, targetPoolsAddHealthCheckRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceAddHealthCheck(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddHealthCheckAsync(AddHealthCheckTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
AddHealthCheckTargetPoolRequest request = new AddHealthCheckTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
    TargetPoolsAddHealthCheckRequestResource = new TargetPoolsAddHealthCheckRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.AddHealthCheckAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceAddHealthCheckAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddHealthCheckAsync(AddHealthCheckTargetPoolRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> AddHealthCheckAsync(AddHealthCheckTargetPoolRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
AddHealthCheckTargetPoolRequest request = new AddHealthCheckTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
    TargetPoolsAddHealthCheckRequestResource = new TargetPoolsAddHealthCheckRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.AddHealthCheckAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceAddHealthCheckAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddHealthCheckAsync(string, string, string, TargetPoolsAddHealthCheckRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> AddHealthCheckAsync(string project, string region, string targetPool, TargetPoolsAddHealthCheckRequest targetPoolsAddHealthCheckRequestResource, CallSettings callSettings = null)

Adds health check URLs to a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the target pool to add a health check to.

targetPoolsAddHealthCheckRequestResource TargetPoolsAddHealthCheckRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsAddHealthCheckRequest targetPoolsAddHealthCheckRequestResource = new TargetPoolsAddHealthCheckRequest();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.AddHealthCheckAsync(project, region, targetPool, targetPoolsAddHealthCheckRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceAddHealthCheckAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddHealthCheckAsync(string, string, string, TargetPoolsAddHealthCheckRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> AddHealthCheckAsync(string project, string region, string targetPool, TargetPoolsAddHealthCheckRequest targetPoolsAddHealthCheckRequestResource, CancellationToken cancellationToken)

Adds health check URLs to a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the target pool to add a health check to.

targetPoolsAddHealthCheckRequestResource TargetPoolsAddHealthCheckRequest

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsAddHealthCheckRequest targetPoolsAddHealthCheckRequestResource = new TargetPoolsAddHealthCheckRequest();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.AddHealthCheckAsync(project, region, targetPool, targetPoolsAddHealthCheckRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceAddHealthCheckAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddInstance(AddInstanceTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
AddInstanceTargetPoolRequest request = new AddInstanceTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
    TargetPoolsAddInstanceRequestResource = new TargetPoolsAddInstanceRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.AddInstance(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceAddInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddInstance(string, string, string, TargetPoolsAddInstanceRequest, CallSettings)

public virtual Operation<Operation, Operation> AddInstance(string project, string region, string targetPool, TargetPoolsAddInstanceRequest targetPoolsAddInstanceRequestResource, CallSettings callSettings = null)

Adds an instance to a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to add instances to.

targetPoolsAddInstanceRequestResource TargetPoolsAddInstanceRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsAddInstanceRequest targetPoolsAddInstanceRequestResource = new TargetPoolsAddInstanceRequest();
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.AddInstance(project, region, targetPool, targetPoolsAddInstanceRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceAddInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddInstanceAsync(AddInstanceTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
AddInstanceTargetPoolRequest request = new AddInstanceTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
    TargetPoolsAddInstanceRequestResource = new TargetPoolsAddInstanceRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.AddInstanceAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceAddInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddInstanceAsync(AddInstanceTargetPoolRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> AddInstanceAsync(AddInstanceTargetPoolRequest request, CancellationToken cancellationToken)

Adds an instance to a target pool.

Parameters
Name Description
request AddInstanceTargetPoolRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
AddInstanceTargetPoolRequest request = new AddInstanceTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
    TargetPoolsAddInstanceRequestResource = new TargetPoolsAddInstanceRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.AddInstanceAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceAddInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddInstanceAsync(string, string, string, TargetPoolsAddInstanceRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> AddInstanceAsync(string project, string region, string targetPool, TargetPoolsAddInstanceRequest targetPoolsAddInstanceRequestResource, CallSettings callSettings = null)

Adds an instance to a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to add instances to.

targetPoolsAddInstanceRequestResource TargetPoolsAddInstanceRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsAddInstanceRequest targetPoolsAddInstanceRequestResource = new TargetPoolsAddInstanceRequest();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.AddInstanceAsync(project, region, targetPool, targetPoolsAddInstanceRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceAddInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AddInstanceAsync(string, string, string, TargetPoolsAddInstanceRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> AddInstanceAsync(string project, string region, string targetPool, TargetPoolsAddInstanceRequest targetPoolsAddInstanceRequestResource, CancellationToken cancellationToken)

Adds an instance to a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to add instances to.

targetPoolsAddInstanceRequestResource TargetPoolsAddInstanceRequest

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsAddInstanceRequest targetPoolsAddInstanceRequestResource = new TargetPoolsAddInstanceRequest();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.AddInstanceAsync(project, region, targetPool, targetPoolsAddInstanceRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceAddInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

AggregatedList(AggregatedListTargetPoolsRequest, CallSettings)

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

Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
AggregatedListTargetPoolsRequest request = new AggregatedListTargetPoolsRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<TargetPoolAggregatedList, KeyValuePair<string, TargetPoolsScopedList>> response = targetPoolsClient.AggregatedList(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, TargetPoolsScopedList> item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (TargetPoolAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, TargetPoolsScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, TargetPoolsScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, TargetPoolsScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

AggregatedList(string, string, int?, CallSettings)

public virtual PagedEnumerable<TargetPoolAggregatedList, KeyValuePair<string, TargetPoolsScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
project string

Project ID for this request.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableTargetPoolAggregatedListKeyValuePairstringTargetPoolsScopedList

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

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<TargetPoolAggregatedList, KeyValuePair<string, TargetPoolsScopedList>> response = targetPoolsClient.AggregatedList(project);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, TargetPoolsScopedList> item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (TargetPoolAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, TargetPoolsScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, TargetPoolsScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, TargetPoolsScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

AggregatedListAsync(AggregatedListTargetPoolsRequest, CallSettings)

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

Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
AggregatedListTargetPoolsRequest request = new AggregatedListTargetPoolsRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<TargetPoolAggregatedList, KeyValuePair<string, TargetPoolsScopedList>> response = targetPoolsClient.AggregatedListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, TargetPoolsScopedList> item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((TargetPoolAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, TargetPoolsScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, TargetPoolsScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, TargetPoolsScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

AggregatedListAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<TargetPoolAggregatedList, KeyValuePair<string, TargetPoolsScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
project string

Project ID for this request.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableTargetPoolAggregatedListKeyValuePairstringTargetPoolsScopedList

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

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<TargetPoolAggregatedList, KeyValuePair<string, TargetPoolsScopedList>> response = targetPoolsClient.AggregatedListAsync(project);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, TargetPoolsScopedList> item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((TargetPoolAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, TargetPoolsScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, TargetPoolsScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, TargetPoolsScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

Create()

public static TargetPoolsClient Create()

Synchronously creates a TargetPoolsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use TargetPoolsClientBuilder.

Returns
Type Description
TargetPoolsClient

The created TargetPoolsClient.

CreateAsync(CancellationToken)

public static Task<TargetPoolsClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a TargetPoolsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use TargetPoolsClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskTargetPoolsClient

The task representing the created TargetPoolsClient.

Delete(DeleteTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
DeleteTargetPoolRequest request = new DeleteTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.Delete(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Delete(string, string, string, CallSettings)

public virtual Operation<Operation, Operation> Delete(string project, string region, string targetPool, CallSettings callSettings = null)

Deletes the specified target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.Delete(project, region, targetPool);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
DeleteTargetPoolRequest request = new DeleteTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteTargetPoolRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteTargetPoolRequest request, CancellationToken cancellationToken)

Deletes the specified target pool.

Parameters
Name Description
request DeleteTargetPoolRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
DeleteTargetPoolRequest request = new DeleteTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(string, string, string, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string targetPool, CallSettings callSettings = null)

Deletes the specified target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.DeleteAsync(project, region, targetPool);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(string, string, string, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string targetPool, CancellationToken cancellationToken)

Deletes the specified target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to delete.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.DeleteAsync(project, region, targetPool);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Get(GetTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
GetTargetPoolRequest request = new GetTargetPoolRequest
{
    TargetPool = "",
    Region = "",
    Project = "",
};
// Make the request
TargetPool response = targetPoolsClient.Get(request);

Get(string, string, string, CallSettings)

public virtual TargetPool Get(string project, string region, string targetPool, CallSettings callSettings = null)

Returns the specified target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TargetPool

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
// Make the request
TargetPool response = targetPoolsClient.Get(project, region, targetPool);

GetAsync(GetTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
GetTargetPoolRequest request = new GetTargetPoolRequest
{
    TargetPool = "",
    Region = "",
    Project = "",
};
// Make the request
TargetPool response = await targetPoolsClient.GetAsync(request);

GetAsync(GetTargetPoolRequest, CancellationToken)

public virtual Task<TargetPool> GetAsync(GetTargetPoolRequest request, CancellationToken cancellationToken)

Returns the specified target pool.

Parameters
Name Description
request GetTargetPoolRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTargetPool

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
GetTargetPoolRequest request = new GetTargetPoolRequest
{
    TargetPool = "",
    Region = "",
    Project = "",
};
// Make the request
TargetPool response = await targetPoolsClient.GetAsync(request);

GetAsync(string, string, string, CallSettings)

public virtual Task<TargetPool> GetAsync(string project, string region, string targetPool, CallSettings callSettings = null)

Returns the specified target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTargetPool

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
// Make the request
TargetPool response = await targetPoolsClient.GetAsync(project, region, targetPool);

GetAsync(string, string, string, CancellationToken)

public virtual Task<TargetPool> GetAsync(string project, string region, string targetPool, CancellationToken cancellationToken)

Returns the specified target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to return.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTargetPool

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
// Make the request
TargetPool response = await targetPoolsClient.GetAsync(project, region, targetPool);

GetHealth(GetHealthTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
GetHealthTargetPoolRequest request = new GetHealthTargetPoolRequest
{
    TargetPool = "",
    Region = "",
    Project = "",
    InstanceReferenceResource = new InstanceReference(),
};
// Make the request
TargetPoolInstanceHealth response = targetPoolsClient.GetHealth(request);

GetHealth(string, string, string, InstanceReference, CallSettings)

public virtual TargetPoolInstanceHealth GetHealth(string project, string region, string targetPool, InstanceReference instanceReferenceResource, 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
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to which the queried instance belongs.

instanceReferenceResource InstanceReference

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TargetPoolInstanceHealth

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
InstanceReference instanceReferenceResource = new InstanceReference();
// Make the request
TargetPoolInstanceHealth response = targetPoolsClient.GetHealth(project, region, targetPool, instanceReferenceResource);

GetHealthAsync(GetHealthTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
GetHealthTargetPoolRequest request = new GetHealthTargetPoolRequest
{
    TargetPool = "",
    Region = "",
    Project = "",
    InstanceReferenceResource = new InstanceReference(),
};
// Make the request
TargetPoolInstanceHealth response = await targetPoolsClient.GetHealthAsync(request);

GetHealthAsync(GetHealthTargetPoolRequest, CancellationToken)

public virtual Task<TargetPoolInstanceHealth> GetHealthAsync(GetHealthTargetPoolRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTargetPoolInstanceHealth

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
GetHealthTargetPoolRequest request = new GetHealthTargetPoolRequest
{
    TargetPool = "",
    Region = "",
    Project = "",
    InstanceReferenceResource = new InstanceReference(),
};
// Make the request
TargetPoolInstanceHealth response = await targetPoolsClient.GetHealthAsync(request);

GetHealthAsync(string, string, string, InstanceReference, CallSettings)

public virtual Task<TargetPoolInstanceHealth> GetHealthAsync(string project, string region, string targetPool, InstanceReference instanceReferenceResource, 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
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to which the queried instance belongs.

instanceReferenceResource InstanceReference

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTargetPoolInstanceHealth

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
InstanceReference instanceReferenceResource = new InstanceReference();
// Make the request
TargetPoolInstanceHealth response = await targetPoolsClient.GetHealthAsync(project, region, targetPool, instanceReferenceResource);

GetHealthAsync(string, string, string, InstanceReference, CancellationToken)

public virtual Task<TargetPoolInstanceHealth> GetHealthAsync(string project, string region, string targetPool, InstanceReference instanceReferenceResource, CancellationToken cancellationToken)

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

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to which the queried instance belongs.

instanceReferenceResource InstanceReference

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTargetPoolInstanceHealth

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
InstanceReference instanceReferenceResource = new InstanceReference();
// Make the request
TargetPoolInstanceHealth response = await targetPoolsClient.GetHealthAsync(project, region, targetPool, instanceReferenceResource);

Insert(InsertTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
InsertTargetPoolRequest request = new InsertTargetPoolRequest
{
    RequestId = "",
    TargetPoolResource = new TargetPool(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.Insert(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Insert(string, string, TargetPool, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, string region, TargetPool targetPoolResource, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPoolResource TargetPool

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
TargetPool targetPoolResource = new TargetPool();
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.Insert(project, region, targetPoolResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
InsertTargetPoolRequest request = new InsertTargetPoolRequest
{
    RequestId = "",
    TargetPoolResource = new TargetPool(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertTargetPoolRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertTargetPoolRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
InsertTargetPoolRequest request = new InsertTargetPoolRequest
{
    RequestId = "",
    TargetPoolResource = new TargetPool(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(string, string, TargetPool, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, TargetPool targetPoolResource, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPoolResource TargetPool

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
TargetPool targetPoolResource = new TargetPool();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.InsertAsync(project, region, targetPoolResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(string, string, TargetPool, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, TargetPool targetPoolResource, CancellationToken cancellationToken)

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

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPoolResource TargetPool

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
TargetPool targetPoolResource = new TargetPool();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.InsertAsync(project, region, targetPoolResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

List(ListTargetPoolsRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
ListTargetPoolsRequest request = new ListTargetPoolsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<TargetPoolList, TargetPool> response = targetPoolsClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TargetPool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (TargetPoolList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TargetPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TargetPool> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TargetPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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

public virtual PagedEnumerable<TargetPoolList, TargetPool> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableTargetPoolListTargetPool

A pageable sequence of TargetPool resources.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<TargetPoolList, TargetPool> response = targetPoolsClient.List(project, region);

// Iterate over all response items, lazily performing RPCs as required
foreach (TargetPool item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (TargetPoolList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TargetPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TargetPool> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TargetPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAsync(ListTargetPoolsRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
ListTargetPoolsRequest request = new ListTargetPoolsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<TargetPoolList, TargetPool> response = targetPoolsClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TargetPool item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((TargetPoolList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TargetPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TargetPool> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TargetPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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

public virtual PagedAsyncEnumerable<TargetPoolList, TargetPool> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableTargetPoolListTargetPool

A pageable asynchronous sequence of TargetPool resources.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<TargetPoolList, TargetPool> response = targetPoolsClient.ListAsync(project, region);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TargetPool item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((TargetPoolList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TargetPool item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TargetPool> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TargetPool item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceAddHealthCheck(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceAddHealthCheck(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of AddHealthCheck.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceAddHealthCheckAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceAddHealthCheckAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of AddHealthCheck.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceAddInstance(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceAddInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of AddInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceAddInstanceAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceAddInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of AddInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceDelete(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceDelete(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Delete.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceDeleteAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceDeleteAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Delete .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceInsert(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceInsert(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Insert.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceInsertAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceInsertAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Insert .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceRemoveHealthCheck(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceRemoveHealthCheck(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of RemoveHealthCheck .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceRemoveHealthCheckAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceRemoveHealthCheckAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of RemoveHealthCheck.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceRemoveInstance(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceRemoveInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of RemoveInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceRemoveInstanceAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceRemoveInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of RemoveInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceSetBackup(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceSetBackup(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SetBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceSetBackupAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceSetBackupAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SetBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceSetSecurityPolicy(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceSetSecurityPolicy(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SetSecurityPolicy .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceSetSecurityPolicyAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceSetSecurityPolicyAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SetSecurityPolicy.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

RemoveHealthCheck(RemoveHealthCheckTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
RemoveHealthCheckTargetPoolRequest request = new RemoveHealthCheckTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
    TargetPoolsRemoveHealthCheckRequestResource = new TargetPoolsRemoveHealthCheckRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.RemoveHealthCheck(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceRemoveHealthCheck(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveHealthCheck(string, string, string, TargetPoolsRemoveHealthCheckRequest, CallSettings)

public virtual Operation<Operation, Operation> RemoveHealthCheck(string project, string region, string targetPool, TargetPoolsRemoveHealthCheckRequest targetPoolsRemoveHealthCheckRequestResource, CallSettings callSettings = null)

Removes health check URL from a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region for this request.

targetPool string

Name of the target pool to remove health checks from.

targetPoolsRemoveHealthCheckRequestResource TargetPoolsRemoveHealthCheckRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsRemoveHealthCheckRequest targetPoolsRemoveHealthCheckRequestResource = new TargetPoolsRemoveHealthCheckRequest();
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.RemoveHealthCheck(project, region, targetPool, targetPoolsRemoveHealthCheckRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceRemoveHealthCheck(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveHealthCheckAsync(RemoveHealthCheckTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
RemoveHealthCheckTargetPoolRequest request = new RemoveHealthCheckTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
    TargetPoolsRemoveHealthCheckRequestResource = new TargetPoolsRemoveHealthCheckRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.RemoveHealthCheckAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceRemoveHealthCheckAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveHealthCheckAsync(RemoveHealthCheckTargetPoolRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> RemoveHealthCheckAsync(RemoveHealthCheckTargetPoolRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
RemoveHealthCheckTargetPoolRequest request = new RemoveHealthCheckTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
    TargetPoolsRemoveHealthCheckRequestResource = new TargetPoolsRemoveHealthCheckRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.RemoveHealthCheckAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceRemoveHealthCheckAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveHealthCheckAsync(string, string, string, TargetPoolsRemoveHealthCheckRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> RemoveHealthCheckAsync(string project, string region, string targetPool, TargetPoolsRemoveHealthCheckRequest targetPoolsRemoveHealthCheckRequestResource, CallSettings callSettings = null)

Removes health check URL from a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region for this request.

targetPool string

Name of the target pool to remove health checks from.

targetPoolsRemoveHealthCheckRequestResource TargetPoolsRemoveHealthCheckRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsRemoveHealthCheckRequest targetPoolsRemoveHealthCheckRequestResource = new TargetPoolsRemoveHealthCheckRequest();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.RemoveHealthCheckAsync(project, region, targetPool, targetPoolsRemoveHealthCheckRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceRemoveHealthCheckAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveHealthCheckAsync(string, string, string, TargetPoolsRemoveHealthCheckRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> RemoveHealthCheckAsync(string project, string region, string targetPool, TargetPoolsRemoveHealthCheckRequest targetPoolsRemoveHealthCheckRequestResource, CancellationToken cancellationToken)

Removes health check URL from a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region for this request.

targetPool string

Name of the target pool to remove health checks from.

targetPoolsRemoveHealthCheckRequestResource TargetPoolsRemoveHealthCheckRequest

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsRemoveHealthCheckRequest targetPoolsRemoveHealthCheckRequestResource = new TargetPoolsRemoveHealthCheckRequest();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.RemoveHealthCheckAsync(project, region, targetPool, targetPoolsRemoveHealthCheckRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceRemoveHealthCheckAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveInstance(RemoveInstanceTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
RemoveInstanceTargetPoolRequest request = new RemoveInstanceTargetPoolRequest
{
    TargetPoolsRemoveInstanceRequestResource = new TargetPoolsRemoveInstanceRequest(),
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.RemoveInstance(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceRemoveInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveInstance(string, string, string, TargetPoolsRemoveInstanceRequest, CallSettings)

public virtual Operation<Operation, Operation> RemoveInstance(string project, string region, string targetPool, TargetPoolsRemoveInstanceRequest targetPoolsRemoveInstanceRequestResource, CallSettings callSettings = null)

Removes instance URL from a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to remove instances from.

targetPoolsRemoveInstanceRequestResource TargetPoolsRemoveInstanceRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsRemoveInstanceRequest targetPoolsRemoveInstanceRequestResource = new TargetPoolsRemoveInstanceRequest();
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.RemoveInstance(project, region, targetPool, targetPoolsRemoveInstanceRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceRemoveInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveInstanceAsync(RemoveInstanceTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
RemoveInstanceTargetPoolRequest request = new RemoveInstanceTargetPoolRequest
{
    TargetPoolsRemoveInstanceRequestResource = new TargetPoolsRemoveInstanceRequest(),
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.RemoveInstanceAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceRemoveInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveInstanceAsync(RemoveInstanceTargetPoolRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> RemoveInstanceAsync(RemoveInstanceTargetPoolRequest request, CancellationToken cancellationToken)

Removes instance URL from a target pool.

Parameters
Name Description
request RemoveInstanceTargetPoolRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
RemoveInstanceTargetPoolRequest request = new RemoveInstanceTargetPoolRequest
{
    TargetPoolsRemoveInstanceRequestResource = new TargetPoolsRemoveInstanceRequest(),
    RequestId = "",
    TargetPool = "",
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.RemoveInstanceAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceRemoveInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveInstanceAsync(string, string, string, TargetPoolsRemoveInstanceRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> RemoveInstanceAsync(string project, string region, string targetPool, TargetPoolsRemoveInstanceRequest targetPoolsRemoveInstanceRequestResource, CallSettings callSettings = null)

Removes instance URL from a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to remove instances from.

targetPoolsRemoveInstanceRequestResource TargetPoolsRemoveInstanceRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsRemoveInstanceRequest targetPoolsRemoveInstanceRequestResource = new TargetPoolsRemoveInstanceRequest();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.RemoveInstanceAsync(project, region, targetPool, targetPoolsRemoveInstanceRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceRemoveInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

RemoveInstanceAsync(string, string, string, TargetPoolsRemoveInstanceRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> RemoveInstanceAsync(string project, string region, string targetPool, TargetPoolsRemoveInstanceRequest targetPoolsRemoveInstanceRequestResource, CancellationToken cancellationToken)

Removes instance URL from a target pool.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to remove instances from.

targetPoolsRemoveInstanceRequestResource TargetPoolsRemoveInstanceRequest

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetPoolsRemoveInstanceRequest targetPoolsRemoveInstanceRequestResource = new TargetPoolsRemoveInstanceRequest();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.RemoveInstanceAsync(project, region, targetPool, targetPoolsRemoveInstanceRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceRemoveInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetBackup(SetBackupTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
SetBackupTargetPoolRequest request = new SetBackupTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    FailoverRatio = 0F,
    Project = "",
    TargetReferenceResource = new TargetReference(),
};
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.SetBackup(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceSetBackup(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetBackup(string, string, string, TargetReference, CallSettings)

public virtual Operation<Operation, Operation> SetBackup(string project, string region, string targetPool, TargetReference targetReferenceResource, CallSettings callSettings = null)

Changes a backup target pool's configurations.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to set a backup pool for.

targetReferenceResource TargetReference

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetReference targetReferenceResource = new TargetReference();
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.SetBackup(project, region, targetPool, targetReferenceResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceSetBackup(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetBackupAsync(SetBackupTargetPoolRequest, CallSettings)

public virtual 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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
SetBackupTargetPoolRequest request = new SetBackupTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    FailoverRatio = 0F,
    Project = "",
    TargetReferenceResource = new TargetReference(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.SetBackupAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceSetBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetBackupAsync(SetBackupTargetPoolRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> SetBackupAsync(SetBackupTargetPoolRequest request, CancellationToken cancellationToken)

Changes a backup target pool's configurations.

Parameters
Name Description
request SetBackupTargetPoolRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
SetBackupTargetPoolRequest request = new SetBackupTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    FailoverRatio = 0F,
    Project = "",
    TargetReferenceResource = new TargetReference(),
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.SetBackupAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceSetBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetBackupAsync(string, string, string, TargetReference, CallSettings)

public virtual Task<Operation<Operation, Operation>> SetBackupAsync(string project, string region, string targetPool, TargetReference targetReferenceResource, CallSettings callSettings = null)

Changes a backup target pool's configurations.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to set a backup pool for.

targetReferenceResource TargetReference

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetReference targetReferenceResource = new TargetReference();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.SetBackupAsync(project, region, targetPool, targetReferenceResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceSetBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetBackupAsync(string, string, string, TargetReference, CancellationToken)

public virtual Task<Operation<Operation, Operation>> SetBackupAsync(string project, string region, string targetPool, TargetReference targetReferenceResource, CancellationToken cancellationToken)

Changes a backup target pool's configurations.

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to set a backup pool for.

targetReferenceResource TargetReference

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
TargetReference targetReferenceResource = new TargetReference();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.SetBackupAsync(project, region, targetPool, targetReferenceResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceSetBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetSecurityPolicy(SetSecurityPolicyTargetPoolRequest, CallSettings)

public virtual Operation<Operation, Operation> SetSecurityPolicy(SetSecurityPolicyTargetPoolRequest request, CallSettings callSettings = null)

Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

Parameters
Name Description
request SetSecurityPolicyTargetPoolRequest

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.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
SetSecurityPolicyTargetPoolRequest request = new SetSecurityPolicyTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    SecurityPolicyReferenceResource = new SecurityPolicyReference(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.SetSecurityPolicy(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceSetSecurityPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetSecurityPolicy(string, string, string, SecurityPolicyReference, CallSettings)

public virtual Operation<Operation, Operation> SetSecurityPolicy(string project, string region, string targetPool, SecurityPolicyReference securityPolicyReferenceResource, CallSettings callSettings = null)

Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.

securityPolicyReferenceResource SecurityPolicyReference

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = TargetPoolsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
SecurityPolicyReference securityPolicyReferenceResource = new SecurityPolicyReference();
// Make the request
lro::Operation<Operation, Operation> response = targetPoolsClient.SetSecurityPolicy(project, region, targetPool, securityPolicyReferenceResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = targetPoolsClient.PollOnceSetSecurityPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetSecurityPolicyAsync(SetSecurityPolicyTargetPoolRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> SetSecurityPolicyAsync(SetSecurityPolicyTargetPoolRequest request, CallSettings callSettings = null)

Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

Parameters
Name Description
request SetSecurityPolicyTargetPoolRequest

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.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
SetSecurityPolicyTargetPoolRequest request = new SetSecurityPolicyTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    SecurityPolicyReferenceResource = new SecurityPolicyReference(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.SetSecurityPolicyAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceSetSecurityPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetSecurityPolicyAsync(SetSecurityPolicyTargetPoolRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> SetSecurityPolicyAsync(SetSecurityPolicyTargetPoolRequest request, CancellationToken cancellationToken)

Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

Parameters
Name Description
request SetSecurityPolicyTargetPoolRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
SetSecurityPolicyTargetPoolRequest request = new SetSecurityPolicyTargetPoolRequest
{
    RequestId = "",
    TargetPool = "",
    Region = "",
    SecurityPolicyReferenceResource = new SecurityPolicyReference(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.SetSecurityPolicyAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceSetSecurityPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetSecurityPolicyAsync(string, string, string, SecurityPolicyReference, CallSettings)

public virtual Task<Operation<Operation, Operation>> SetSecurityPolicyAsync(string project, string region, string targetPool, SecurityPolicyReference securityPolicyReferenceResource, CallSettings callSettings = null)

Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.

securityPolicyReferenceResource SecurityPolicyReference

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
SecurityPolicyReference securityPolicyReferenceResource = new SecurityPolicyReference();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.SetSecurityPolicyAsync(project, region, targetPool, securityPolicyReferenceResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceSetSecurityPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetSecurityPolicyAsync(string, string, string, SecurityPolicyReference, CancellationToken)

public virtual Task<Operation<Operation, Operation>> SetSecurityPolicyAsync(string project, string region, string targetPool, SecurityPolicyReference securityPolicyReferenceResource, CancellationToken cancellationToken)

Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.

securityPolicyReferenceResource SecurityPolicyReference

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
TargetPoolsClient targetPoolsClient = await TargetPoolsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetPool = "";
SecurityPolicyReference securityPolicyReferenceResource = new SecurityPolicyReference();
// Make the request
lro::Operation<Operation, Operation> response = await targetPoolsClient.SetSecurityPolicyAsync(project, region, targetPool, securityPolicyReferenceResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await targetPoolsClient.PollOnceSetSecurityPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.