Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Compute Engine v1 API - Class RegionCompositeHealthChecksClient (3.26.0)

public abstract class RegionCompositeHealthChecksClient

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

RegionCompositeHealthChecks client wrapper, for convenient use.

Inheritance

object > RegionCompositeHealthChecksClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

RegionCompositeHealthChecksClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionCompositeHealthChecks API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the RegionCompositeHealthChecks 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 RegionCompositeHealthChecks scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default RegionCompositeHealthChecks scopes are:

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
`OperationsClient`

GrpcClient

public virtual RegionCompositeHealthChecks.RegionCompositeHealthChecksClient GrpcClient { get; }

The underlying gRPC RegionCompositeHealthChecks client

Property Value
Type	Description
`RegionCompositeHealthChecksRegionCompositeHealthChecksClient`

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

PatchOperationsClient

public virtual OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
`OperationsClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

AggregatedList(AggregatedListRegionCompositeHealthChecksRequest, CallSettings)

public virtual PagedEnumerable<CompositeHealthCheckAggregatedList, KeyValuePair<string, CompositeHealthChecksScopedList>> AggregatedList(AggregatedListRegionCompositeHealthChecksRequest request, CallSettings callSettings = null)

Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`request`	`AggregatedListRegionCompositeHealthChecksRequest` 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
`PagedEnumerableCompositeHealthCheckAggregatedListKeyValuePairstringCompositeHealthChecksScopedList`	A pageable sequence of KeyValuePair<TKey, TValue> resources.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
AggregatedListRegionCompositeHealthChecksRequest request = new AggregatedListRegionCompositeHealthChecksRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<CompositeHealthCheckAggregatedList, KeyValuePair<string, CompositeHealthChecksScopedList>> response = regionCompositeHealthChecksClient.AggregatedList(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, CompositeHealthChecksScopedList> 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 (CompositeHealthCheckAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, CompositeHealthChecksScopedList> 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, CompositeHealthChecksScopedList>> 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, CompositeHealthChecksScopedList> 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<CompositeHealthCheckAggregatedList, KeyValuePair<string, CompositeHealthChecksScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`project`	`string` Name of the project 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
`PagedEnumerableCompositeHealthCheckAggregatedListKeyValuePairstringCompositeHealthChecksScopedList`	A pageable sequence of KeyValuePair<TKey, TValue> resources.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<CompositeHealthCheckAggregatedList, KeyValuePair<string, CompositeHealthChecksScopedList>> response = regionCompositeHealthChecksClient.AggregatedList(project);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, CompositeHealthChecksScopedList> 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 (CompositeHealthCheckAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, CompositeHealthChecksScopedList> 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, CompositeHealthChecksScopedList>> 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, CompositeHealthChecksScopedList> 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(AggregatedListRegionCompositeHealthChecksRequest, CallSettings)

public virtual PagedAsyncEnumerable<CompositeHealthCheckAggregatedList, KeyValuePair<string, CompositeHealthChecksScopedList>> AggregatedListAsync(AggregatedListRegionCompositeHealthChecksRequest request, CallSettings callSettings = null)

Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`request`	`AggregatedListRegionCompositeHealthChecksRequest` 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
`PagedAsyncEnumerableCompositeHealthCheckAggregatedListKeyValuePairstringCompositeHealthChecksScopedList`	A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
AggregatedListRegionCompositeHealthChecksRequest request = new AggregatedListRegionCompositeHealthChecksRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<CompositeHealthCheckAggregatedList, KeyValuePair<string, CompositeHealthChecksScopedList>> response = regionCompositeHealthChecksClient.AggregatedListAsync(request);

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

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (CompositeHealthCheckAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, CompositeHealthChecksScopedList> 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, CompositeHealthChecksScopedList>> 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, CompositeHealthChecksScopedList> 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<CompositeHealthCheckAggregatedList, KeyValuePair<string, CompositeHealthChecksScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`project`	`string` Name of the project 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
`PagedAsyncEnumerableCompositeHealthCheckAggregatedListKeyValuePairstringCompositeHealthChecksScopedList`	A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<CompositeHealthCheckAggregatedList, KeyValuePair<string, CompositeHealthChecksScopedList>> response = regionCompositeHealthChecksClient.AggregatedListAsync(project);

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

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (CompositeHealthCheckAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, CompositeHealthChecksScopedList> 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, CompositeHealthChecksScopedList>> 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, CompositeHealthChecksScopedList> 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 RegionCompositeHealthChecksClient Create()

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

Returns
Type	Description
`RegionCompositeHealthChecksClient`	The created RegionCompositeHealthChecksClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskRegionCompositeHealthChecksClient`	The task representing the created RegionCompositeHealthChecksClient.

Delete(DeleteRegionCompositeHealthCheckRequest, CallSettings)

public virtual Operation<Operation, Operation> Delete(DeleteRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Deletes the specified CompositeHealthCheck in the given region

Parameters
Name	Description
`request`	`DeleteRegionCompositeHealthCheckRequest` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
DeleteRegionCompositeHealthCheckRequest request = new DeleteRegionCompositeHealthCheckRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    CompositeHealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = regionCompositeHealthChecksClient.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 = regionCompositeHealthChecksClient.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 compositeHealthCheck, CallSettings callSettings = null)

Deletes the specified CompositeHealthCheck in the given region

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheck`	`string` Name of the CompositeHealthCheck resource to delete.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string compositeHealthCheck = "";
// Make the request
lro::Operation<Operation, Operation> response = regionCompositeHealthChecksClient.Delete(project, region, compositeHealthCheck);

// 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 = regionCompositeHealthChecksClient.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(DeleteRegionCompositeHealthCheckRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Deletes the specified CompositeHealthCheck in the given region

Parameters
Name	Description
`request`	`DeleteRegionCompositeHealthCheckRequest` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionCompositeHealthCheckRequest request = new DeleteRegionCompositeHealthCheckRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    CompositeHealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.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 regionCompositeHealthChecksClient.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(DeleteRegionCompositeHealthCheckRequest, CancellationToken)

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

Deletes the specified CompositeHealthCheck in the given region

Parameters
Name	Description
`request`	`DeleteRegionCompositeHealthCheckRequest` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionCompositeHealthCheckRequest request = new DeleteRegionCompositeHealthCheckRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    CompositeHealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.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 regionCompositeHealthChecksClient.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 compositeHealthCheck, CallSettings callSettings = null)

Deletes the specified CompositeHealthCheck in the given region

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheck`	`string` Name of the CompositeHealthCheck 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string compositeHealthCheck = "";
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.DeleteAsync(project, region, compositeHealthCheck);

// 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 regionCompositeHealthChecksClient.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 compositeHealthCheck, CancellationToken cancellationToken)

Deletes the specified CompositeHealthCheck in the given region

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheck`	`string` Name of the CompositeHealthCheck 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string compositeHealthCheck = "";
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.DeleteAsync(project, region, compositeHealthCheck);

// 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 regionCompositeHealthChecksClient.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(GetRegionCompositeHealthCheckRequest, CallSettings)

public virtual CompositeHealthCheck Get(GetRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Returns the specified CompositeHealthCheck resource in the given region.

Parameters
Name	Description
`request`	`GetRegionCompositeHealthCheckRequest` 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
`CompositeHealthCheck`	The RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
GetRegionCompositeHealthCheckRequest request = new GetRegionCompositeHealthCheckRequest
{
    Region = "",
    Project = "",
    CompositeHealthCheck = "",
};
// Make the request
CompositeHealthCheck response = regionCompositeHealthChecksClient.Get(request);

Get(string, string, string, CallSettings)

public virtual CompositeHealthCheck Get(string project, string region, string compositeHealthCheck, CallSettings callSettings = null)

Returns the specified CompositeHealthCheck resource in the given region.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheck`	`string` Name of the CompositeHealthCheck resource to return.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`CompositeHealthCheck`	The RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string compositeHealthCheck = "";
// Make the request
CompositeHealthCheck response = regionCompositeHealthChecksClient.Get(project, region, compositeHealthCheck);

GetAsync(GetRegionCompositeHealthCheckRequest, CallSettings)

public virtual Task<CompositeHealthCheck> GetAsync(GetRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Returns the specified CompositeHealthCheck resource in the given region.

Parameters
Name	Description
`request`	`GetRegionCompositeHealthCheckRequest` 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
`TaskCompositeHealthCheck`	A Task containing the RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
GetRegionCompositeHealthCheckRequest request = new GetRegionCompositeHealthCheckRequest
{
    Region = "",
    Project = "",
    CompositeHealthCheck = "",
};
// Make the request
CompositeHealthCheck response = await regionCompositeHealthChecksClient.GetAsync(request);

GetAsync(GetRegionCompositeHealthCheckRequest, CancellationToken)

public virtual Task<CompositeHealthCheck> GetAsync(GetRegionCompositeHealthCheckRequest request, CancellationToken cancellationToken)

Returns the specified CompositeHealthCheck resource in the given region.

Parameters
Name	Description
`request`	`GetRegionCompositeHealthCheckRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskCompositeHealthCheck`	A Task containing the RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
GetRegionCompositeHealthCheckRequest request = new GetRegionCompositeHealthCheckRequest
{
    Region = "",
    Project = "",
    CompositeHealthCheck = "",
};
// Make the request
CompositeHealthCheck response = await regionCompositeHealthChecksClient.GetAsync(request);

GetAsync(string, string, string, CallSettings)

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

Returns the specified CompositeHealthCheck resource in the given region.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheck`	`string` Name of the CompositeHealthCheck resource to return.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskCompositeHealthCheck`	A Task containing the RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string compositeHealthCheck = "";
// Make the request
CompositeHealthCheck response = await regionCompositeHealthChecksClient.GetAsync(project, region, compositeHealthCheck);

GetAsync(string, string, string, CancellationToken)

public virtual Task<CompositeHealthCheck> GetAsync(string project, string region, string compositeHealthCheck, CancellationToken cancellationToken)

Returns the specified CompositeHealthCheck resource in the given region.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheck`	`string` Name of the CompositeHealthCheck resource to return.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskCompositeHealthCheck`	A Task containing the RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string compositeHealthCheck = "";
// Make the request
CompositeHealthCheck response = await regionCompositeHealthChecksClient.GetAsync(project, region, compositeHealthCheck);

Insert(InsertRegionCompositeHealthCheckRequest, CallSettings)

public virtual Operation<Operation, Operation> Insert(InsertRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
`request`	`InsertRegionCompositeHealthCheckRequest` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
InsertRegionCompositeHealthCheckRequest request = new InsertRegionCompositeHealthCheckRequest
{
    RequestId = "",
    CompositeHealthCheckResource = new CompositeHealthCheck(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = regionCompositeHealthChecksClient.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 = regionCompositeHealthChecksClient.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, CompositeHealthCheck, CallSettings)

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

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheckResource`	`CompositeHealthCheck` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
CompositeHealthCheck compositeHealthCheckResource = new CompositeHealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = regionCompositeHealthChecksClient.Insert(project, region, compositeHealthCheckResource);

// 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 = regionCompositeHealthChecksClient.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(InsertRegionCompositeHealthCheckRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
`request`	`InsertRegionCompositeHealthCheckRequest` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
InsertRegionCompositeHealthCheckRequest request = new InsertRegionCompositeHealthCheckRequest
{
    RequestId = "",
    CompositeHealthCheckResource = new CompositeHealthCheck(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.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 regionCompositeHealthChecksClient.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(InsertRegionCompositeHealthCheckRequest, CancellationToken)

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

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
`request`	`InsertRegionCompositeHealthCheckRequest` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
InsertRegionCompositeHealthCheckRequest request = new InsertRegionCompositeHealthCheckRequest
{
    RequestId = "",
    CompositeHealthCheckResource = new CompositeHealthCheck(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.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 regionCompositeHealthChecksClient.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, CompositeHealthCheck, CallSettings)

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

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheckResource`	`CompositeHealthCheck` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
CompositeHealthCheck compositeHealthCheckResource = new CompositeHealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.InsertAsync(project, region, compositeHealthCheckResource);

// 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 regionCompositeHealthChecksClient.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, CompositeHealthCheck, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, CompositeHealthCheck compositeHealthCheckResource, CancellationToken cancellationToken)

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheckResource`	`CompositeHealthCheck` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
CompositeHealthCheck compositeHealthCheckResource = new CompositeHealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.InsertAsync(project, region, compositeHealthCheckResource);

// 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 regionCompositeHealthChecksClient.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(ListRegionCompositeHealthChecksRequest, CallSettings)

public virtual PagedEnumerable<CompositeHealthCheckList, CompositeHealthCheck> List(ListRegionCompositeHealthChecksRequest request, CallSettings callSettings = null)

Lists the CompositeHealthChecks for a project in the given region.

Parameters
Name	Description
`request`	`ListRegionCompositeHealthChecksRequest` 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
`PagedEnumerableCompositeHealthCheckListCompositeHealthCheck`	A pageable sequence of CompositeHealthCheck resources.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
ListRegionCompositeHealthChecksRequest request = new ListRegionCompositeHealthChecksRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<CompositeHealthCheckList, CompositeHealthCheck> response = regionCompositeHealthChecksClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (CompositeHealthCheck 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 (CompositeHealthCheckList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (CompositeHealthCheck 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<CompositeHealthCheck> 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 (CompositeHealthCheck 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<CompositeHealthCheckList, CompositeHealthCheck> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the CompositeHealthChecks for a project in the given 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
`PagedEnumerableCompositeHealthCheckListCompositeHealthCheck`	A pageable sequence of CompositeHealthCheck resources.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<CompositeHealthCheckList, CompositeHealthCheck> response = regionCompositeHealthChecksClient.List(project, region);

// Iterate over all response items, lazily performing RPCs as required
foreach (CompositeHealthCheck 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 (CompositeHealthCheckList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (CompositeHealthCheck 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<CompositeHealthCheck> 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 (CompositeHealthCheck 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(ListRegionCompositeHealthChecksRequest, CallSettings)

public virtual PagedAsyncEnumerable<CompositeHealthCheckList, CompositeHealthCheck> ListAsync(ListRegionCompositeHealthChecksRequest request, CallSettings callSettings = null)

Lists the CompositeHealthChecks for a project in the given region.

Parameters
Name	Description
`request`	`ListRegionCompositeHealthChecksRequest` 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
`PagedAsyncEnumerableCompositeHealthCheckListCompositeHealthCheck`	A pageable asynchronous sequence of CompositeHealthCheck resources.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
ListRegionCompositeHealthChecksRequest request = new ListRegionCompositeHealthChecksRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<CompositeHealthCheckList, CompositeHealthCheck> response = regionCompositeHealthChecksClient.ListAsync(request);

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

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (CompositeHealthCheckList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (CompositeHealthCheck 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<CompositeHealthCheck> 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 (CompositeHealthCheck 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<CompositeHealthCheckList, CompositeHealthCheck> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the CompositeHealthChecks for a project in the given 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
`PagedAsyncEnumerableCompositeHealthCheckListCompositeHealthCheck`	A pageable asynchronous sequence of CompositeHealthCheck resources.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<CompositeHealthCheckList, CompositeHealthCheck> response = regionCompositeHealthChecksClient.ListAsync(project, region);

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

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (CompositeHealthCheckList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (CompositeHealthCheck 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<CompositeHealthCheck> 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 (CompositeHealthCheck 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;

Patch(PatchRegionCompositeHealthCheckRequest, CallSettings)

public virtual Operation<Operation, Operation> Patch(PatchRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name	Description
`request`	`PatchRegionCompositeHealthCheckRequest` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
PatchRegionCompositeHealthCheckRequest request = new PatchRegionCompositeHealthCheckRequest
{
    RequestId = "",
    CompositeHealthCheckResource = new CompositeHealthCheck(),
    Region = "",
    Project = "",
    CompositeHealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = regionCompositeHealthChecksClient.Patch(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 = regionCompositeHealthChecksClient.PollOncePatch(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;
}

Patch(string, string, string, CompositeHealthCheck, CallSettings)

public virtual Operation<Operation, Operation> Patch(string project, string region, string compositeHealthCheck, CompositeHealthCheck compositeHealthCheckResource, CallSettings callSettings = null)

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheck`	`string` Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035.
`compositeHealthCheckResource`	`CompositeHealthCheck` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string compositeHealthCheck = "";
CompositeHealthCheck compositeHealthCheckResource = new CompositeHealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = regionCompositeHealthChecksClient.Patch(project, region, compositeHealthCheck, compositeHealthCheckResource);

// 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 = regionCompositeHealthChecksClient.PollOncePatch(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;
}

PatchAsync(PatchRegionCompositeHealthCheckRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(PatchRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name	Description
`request`	`PatchRegionCompositeHealthCheckRequest` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
PatchRegionCompositeHealthCheckRequest request = new PatchRegionCompositeHealthCheckRequest
{
    RequestId = "",
    CompositeHealthCheckResource = new CompositeHealthCheck(),
    Region = "",
    Project = "",
    CompositeHealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.PatchAsync(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 regionCompositeHealthChecksClient.PollOncePatchAsync(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;
}

PatchAsync(PatchRegionCompositeHealthCheckRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(PatchRegionCompositeHealthCheckRequest request, CancellationToken cancellationToken)

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name	Description
`request`	`PatchRegionCompositeHealthCheckRequest` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
PatchRegionCompositeHealthCheckRequest request = new PatchRegionCompositeHealthCheckRequest
{
    RequestId = "",
    CompositeHealthCheckResource = new CompositeHealthCheck(),
    Region = "",
    Project = "",
    CompositeHealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.PatchAsync(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 regionCompositeHealthChecksClient.PollOncePatchAsync(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;
}

PatchAsync(string, string, string, CompositeHealthCheck, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string region, string compositeHealthCheck, CompositeHealthCheck compositeHealthCheckResource, CallSettings callSettings = null)

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheck`	`string` Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035.
`compositeHealthCheckResource`	`CompositeHealthCheck` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string compositeHealthCheck = "";
CompositeHealthCheck compositeHealthCheckResource = new CompositeHealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.PatchAsync(project, region, compositeHealthCheck, compositeHealthCheckResource);

// 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 regionCompositeHealthChecksClient.PollOncePatchAsync(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;
}

PatchAsync(string, string, string, CompositeHealthCheck, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string region, string compositeHealthCheck, CompositeHealthCheck compositeHealthCheckResource, CancellationToken cancellationToken)

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.
`compositeHealthCheck`	`string` Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035.
`compositeHealthCheckResource`	`CompositeHealthCheck` 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
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string compositeHealthCheck = "";
CompositeHealthCheck compositeHealthCheckResource = new CompositeHealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await regionCompositeHealthChecksClient.PatchAsync(project, region, compositeHealthCheck, compositeHealthCheckResource);

// 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 regionCompositeHealthChecksClient.PollOncePatchAsync(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;
}

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.

PollOncePatch(string, CallSettings)

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

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

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.

PollOncePatchAsync(string, CallSettings)

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

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

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.

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.

TestIamPermissions(TestIamPermissionsRegionCompositeHealthCheckRequest, CallSettings)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`request`	`TestIamPermissionsRegionCompositeHealthCheckRequest` 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
`TestPermissionsResponse`	The RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
TestIamPermissionsRegionCompositeHealthCheckRequest request = new TestIamPermissionsRegionCompositeHealthCheckRequest
{
    Region = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = regionCompositeHealthChecksClient.TestIamPermissions(request);

TestIamPermissions(string, string, string, TestPermissionsRequest, CallSettings)

public virtual TestPermissionsResponse TestIamPermissions(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` The name of the region for this request.
`resource`	`string` Name or id of the resource for this request.
`testPermissionsRequestResource`	`TestPermissionsRequest` The body resource for this request
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TestPermissionsResponse`	The RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = RegionCompositeHealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = regionCompositeHealthChecksClient.TestIamPermissions(project, region, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(TestIamPermissionsRegionCompositeHealthCheckRequest, CallSettings)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRegionCompositeHealthCheckRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`request`	`TestIamPermissionsRegionCompositeHealthCheckRequest` 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
`TaskTestPermissionsResponse`	A Task containing the RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRegionCompositeHealthCheckRequest request = new TestIamPermissionsRegionCompositeHealthCheckRequest
{
    Region = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await regionCompositeHealthChecksClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(TestIamPermissionsRegionCompositeHealthCheckRequest, CancellationToken)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRegionCompositeHealthCheckRequest request, CancellationToken cancellationToken)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`request`	`TestIamPermissionsRegionCompositeHealthCheckRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskTestPermissionsResponse`	A Task containing the RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRegionCompositeHealthCheckRequest request = new TestIamPermissionsRegionCompositeHealthCheckRequest
{
    Region = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await regionCompositeHealthChecksClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CallSettings)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` The name of the region for this request.
`resource`	`string` Name or id of the resource for this request.
`testPermissionsRequestResource`	`TestPermissionsRequest` The body resource for this request
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskTestPermissionsResponse`	A Task containing the RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await regionCompositeHealthChecksClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CancellationToken)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CancellationToken cancellationToken)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` The name of the region for this request.
`resource`	`string` Name or id of the resource for this request.
`testPermissionsRequestResource`	`TestPermissionsRequest` The body resource for this request
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskTestPermissionsResponse`	A Task containing the RPC response.

Example

// Create client
RegionCompositeHealthChecksClient regionCompositeHealthChecksClient = await RegionCompositeHealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await regionCompositeHealthChecksClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);