Compute Engine v1 API - Class HealthChecksClient (2.5.0)

Version 2.5.0

• 3.0.0 (latest)
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public abstract class HealthChecksClient

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

HealthChecks client wrapper, for convenient use.

Inheritance

Object > HealthChecksClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

HealthChecksClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The HealthChecks API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
IReadOnlyList<String>

Remarks

The default HealthChecks scopes are:

• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/cloud-platform

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual HealthChecks.HealthChecksClient GrpcClient { get; }

The underlying gRPC HealthChecks client

Property Value
Type	Description
HealthChecks.HealthChecksClient

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

UpdateOperationsClient

public virtual OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type	Description
OperationsClient

Methods

AggregatedList(AggregatedListHealthChecksRequest, CallSettings)

public virtual PagedEnumerable<HealthChecksAggregatedList, KeyValuePair<string, HealthChecksScopedList>> AggregatedList(AggregatedListHealthChecksRequest request, CallSettings callSettings = null)

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

Parameters
Name	Description
request	AggregatedListHealthChecksRequest 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
PagedEnumerable<HealthChecksAggregatedList, KeyValuePair<String, HealthChecksScopedList>>	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
AggregatedListHealthChecksRequest request = new AggregatedListHealthChecksRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<HealthChecksAggregatedList, KeyValuePair<string, HealthChecksScopedList>> response = healthChecksClient.AggregatedList(request);

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

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

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

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	Nullable<Int32> 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
PagedEnumerable<HealthChecksAggregatedList, KeyValuePair<String, HealthChecksScopedList>>	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<HealthChecksAggregatedList, KeyValuePair<string, HealthChecksScopedList>> response = healthChecksClient.AggregatedList(project);

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

public virtual PagedAsyncEnumerable<HealthChecksAggregatedList, KeyValuePair<string, HealthChecksScopedList>> AggregatedListAsync(AggregatedListHealthChecksRequest request, CallSettings callSettings = null)

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

Parameters
Name	Description
request	AggregatedListHealthChecksRequest 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
PagedAsyncEnumerable<HealthChecksAggregatedList, KeyValuePair<String, HealthChecksScopedList>>	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
AggregatedListHealthChecksRequest request = new AggregatedListHealthChecksRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<HealthChecksAggregatedList, KeyValuePair<string, HealthChecksScopedList>> response = healthChecksClient.AggregatedListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, HealthChecksScopedList> 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((HealthChecksAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, HealthChecksScopedList> 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, HealthChecksScopedList>> 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, HealthChecksScopedList> 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, Nullable<Int32>, CallSettings)

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

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

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	Nullable<Int32> 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
PagedAsyncEnumerable<HealthChecksAggregatedList, KeyValuePair<String, HealthChecksScopedList>>	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<HealthChecksAggregatedList, KeyValuePair<string, HealthChecksScopedList>> response = healthChecksClient.AggregatedListAsync(project);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, HealthChecksScopedList> 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((HealthChecksAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, HealthChecksScopedList> 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, HealthChecksScopedList>> 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, HealthChecksScopedList> 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 HealthChecksClient Create()

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

Returns
Type	Description
HealthChecksClient	The created HealthChecksClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
Task<HealthChecksClient>	The task representing the created HealthChecksClient.

Delete(DeleteHealthCheckRequest, CallSettings)

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

Deletes the specified HealthCheck resource.

Parameters
Name	Description
request	DeleteHealthCheckRequest 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
Operation<Operation, Operation>	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
DeleteHealthCheckRequest request = new DeleteHealthCheckRequest
{
    RequestId = "",
    Project = "",
    HealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = healthChecksClient.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 = healthChecksClient.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, CallSettings)

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

Deletes the specified HealthCheck resource.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Operation, Operation>	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
// Make the request
lro::Operation<Operation, Operation> response = healthChecksClient.Delete(project, healthCheck);

// 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 = healthChecksClient.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(DeleteHealthCheckRequest, CallSettings)

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

Deletes the specified HealthCheck resource.

Parameters
Name	Description
request	DeleteHealthCheckRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
DeleteHealthCheckRequest request = new DeleteHealthCheckRequest
{
    RequestId = "",
    Project = "",
    HealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.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 healthChecksClient.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(DeleteHealthCheckRequest, CancellationToken)

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

Deletes the specified HealthCheck resource.

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

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
DeleteHealthCheckRequest request = new DeleteHealthCheckRequest
{
    RequestId = "",
    Project = "",
    HealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.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 healthChecksClient.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, CallSettings)

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

Deletes the specified HealthCheck resource.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.DeleteAsync(project, healthCheck);

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

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

Deletes the specified HealthCheck resource.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to delete.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.DeleteAsync(project, healthCheck);

// 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 healthChecksClient.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(GetHealthCheckRequest, CallSettings)

public virtual HealthCheck Get(GetHealthCheckRequest request, CallSettings callSettings = null)

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Parameters
Name	Description
request	GetHealthCheckRequest 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
HealthCheck	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
GetHealthCheckRequest request = new GetHealthCheckRequest
{
    Project = "",
    HealthCheck = "",
};
// Make the request
HealthCheck response = healthChecksClient.Get(request);

Get(String, String, CallSettings)

public virtual HealthCheck Get(string project, string healthCheck, CallSettings callSettings = null)

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
HealthCheck	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
// Make the request
HealthCheck response = healthChecksClient.Get(project, healthCheck);

GetAsync(GetHealthCheckRequest, CallSettings)

public virtual Task<HealthCheck> GetAsync(GetHealthCheckRequest request, CallSettings callSettings = null)

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Parameters
Name	Description
request	GetHealthCheckRequest 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
Task<HealthCheck>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
GetHealthCheckRequest request = new GetHealthCheckRequest
{
    Project = "",
    HealthCheck = "",
};
// Make the request
HealthCheck response = await healthChecksClient.GetAsync(request);

GetAsync(GetHealthCheckRequest, CancellationToken)

public virtual Task<HealthCheck> GetAsync(GetHealthCheckRequest request, CancellationToken cancellationToken)

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

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

Returns
Type	Description
Task<HealthCheck>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
GetHealthCheckRequest request = new GetHealthCheckRequest
{
    Project = "",
    HealthCheck = "",
};
// Make the request
HealthCheck response = await healthChecksClient.GetAsync(request);

GetAsync(String, String, CallSettings)

public virtual Task<HealthCheck> GetAsync(string project, string healthCheck, CallSettings callSettings = null)

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<HealthCheck>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
// Make the request
HealthCheck response = await healthChecksClient.GetAsync(project, healthCheck);

GetAsync(String, String, CancellationToken)

public virtual Task<HealthCheck> GetAsync(string project, string healthCheck, CancellationToken cancellationToken)

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to return.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<HealthCheck>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
// Make the request
HealthCheck response = await healthChecksClient.GetAsync(project, healthCheck);

Insert(InsertHealthCheckRequest, CallSettings)

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

Creates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertHealthCheckRequest 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
Operation<Operation, Operation>	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
InsertHealthCheckRequest request = new InsertHealthCheckRequest
{
    RequestId = "",
    HealthCheckResource = new HealthCheck(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = healthChecksClient.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 = healthChecksClient.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, HealthCheck, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, HealthCheck healthCheckResource, CallSettings callSettings = null)

Creates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
project	String Project ID for this request.
healthCheckResource	HealthCheck The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Operation, Operation>	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
HealthCheck healthCheckResource = new HealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = healthChecksClient.Insert(project, healthCheckResource);

// 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 = healthChecksClient.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(InsertHealthCheckRequest, CallSettings)

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

Creates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertHealthCheckRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
InsertHealthCheckRequest request = new InsertHealthCheckRequest
{
    RequestId = "",
    HealthCheckResource = new HealthCheck(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.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 healthChecksClient.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(InsertHealthCheckRequest, CancellationToken)

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

Creates a HealthCheck resource in the specified project using the data included in the request.

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

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
InsertHealthCheckRequest request = new InsertHealthCheckRequest
{
    RequestId = "",
    HealthCheckResource = new HealthCheck(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.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 healthChecksClient.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, HealthCheck, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, HealthCheck healthCheckResource, CallSettings callSettings = null)

Creates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
project	String Project ID for this request.
healthCheckResource	HealthCheck The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
HealthCheck healthCheckResource = new HealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.InsertAsync(project, healthCheckResource);

// 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 healthChecksClient.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, HealthCheck, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, HealthCheck healthCheckResource, CancellationToken cancellationToken)

Creates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
project	String Project ID for this request.
healthCheckResource	HealthCheck The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
HealthCheck healthCheckResource = new HealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.InsertAsync(project, healthCheckResource);

// 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 healthChecksClient.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(ListHealthChecksRequest, CallSettings)

public virtual PagedEnumerable<HealthCheckList, HealthCheck> List(ListHealthChecksRequest request, CallSettings callSettings = null)

Retrieves the list of HealthCheck resources available to the specified project.

Parameters
Name	Description
request	ListHealthChecksRequest 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
PagedEnumerable<HealthCheckList, HealthCheck>	A pageable sequence of HealthCheck resources.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
ListHealthChecksRequest request = new ListHealthChecksRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<HealthCheckList, HealthCheck> response = healthChecksClient.List(request);

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

public virtual PagedEnumerable<HealthCheckList, HealthCheck> List(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of HealthCheck resources available to the specified project.

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	Nullable<Int32> 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
PagedEnumerable<HealthCheckList, HealthCheck>	A pageable sequence of HealthCheck resources.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<HealthCheckList, HealthCheck> response = healthChecksClient.List(project);

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

public virtual PagedAsyncEnumerable<HealthCheckList, HealthCheck> ListAsync(ListHealthChecksRequest request, CallSettings callSettings = null)

Retrieves the list of HealthCheck resources available to the specified project.

Parameters
Name	Description
request	ListHealthChecksRequest 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
PagedAsyncEnumerable<HealthCheckList, HealthCheck>	A pageable asynchronous sequence of HealthCheck resources.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
ListHealthChecksRequest request = new ListHealthChecksRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<HealthCheckList, HealthCheck> response = healthChecksClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((HealthCheck 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((HealthCheckList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (HealthCheck 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<HealthCheck> 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 (HealthCheck 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, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<HealthCheckList, HealthCheck> ListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of HealthCheck resources available to the specified project.

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	Nullable<Int32> 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
PagedAsyncEnumerable<HealthCheckList, HealthCheck>	A pageable asynchronous sequence of HealthCheck resources.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<HealthCheckList, HealthCheck> response = healthChecksClient.ListAsync(project);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((HealthCheck 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((HealthCheckList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (HealthCheck 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<HealthCheck> 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 (HealthCheck 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(PatchHealthCheckRequest, CallSettings)

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

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
request	PatchHealthCheckRequest 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
Operation<Operation, Operation>	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
PatchHealthCheckRequest request = new PatchHealthCheckRequest
{
    RequestId = "",
    HealthCheckResource = new HealthCheck(),
    Project = "",
    HealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = healthChecksClient.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 = healthChecksClient.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, HealthCheck, CallSettings)

public virtual Operation<Operation, Operation> Patch(string project, string healthCheck, HealthCheck healthCheckResource, CallSettings callSettings = null)

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to patch.
healthCheckResource	HealthCheck The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Operation, Operation>	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
HealthCheck healthCheckResource = new HealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = healthChecksClient.Patch(project, healthCheck, healthCheckResource);

// 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 = healthChecksClient.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(PatchHealthCheckRequest, CallSettings)

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

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
request	PatchHealthCheckRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
PatchHealthCheckRequest request = new PatchHealthCheckRequest
{
    RequestId = "",
    HealthCheckResource = new HealthCheck(),
    Project = "",
    HealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.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 healthChecksClient.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(PatchHealthCheckRequest, CancellationToken)

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

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
PatchHealthCheckRequest request = new PatchHealthCheckRequest
{
    RequestId = "",
    HealthCheckResource = new HealthCheck(),
    Project = "",
    HealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.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 healthChecksClient.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, HealthCheck, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string healthCheck, HealthCheck healthCheckResource, CallSettings callSettings = null)

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to patch.
healthCheckResource	HealthCheck The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
HealthCheck healthCheckResource = new HealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.PatchAsync(project, healthCheck, healthCheckResource);

// 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 healthChecksClient.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, HealthCheck, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string healthCheck, HealthCheck healthCheckResource, CancellationToken cancellationToken)

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to patch.
healthCheckResource	HealthCheck The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
HealthCheck healthCheckResource = new HealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.PatchAsync(project, healthCheck, healthCheckResource);

// 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 healthChecksClient.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
Operation<Operation, Operation>	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
Task<Operation<Operation, Operation>>	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
Operation<Operation, Operation>	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
Task<Operation<Operation, Operation>>	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
Operation<Operation, Operation>	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
Task<Operation<Operation, Operation>>	A task representing the result of polling the operation.

PollOnceUpdate(String, CallSettings)

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

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

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
Operation<Operation, Operation>	The result of polling the operation.

PollOnceUpdateAsync(String, CallSettings)

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

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

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
Task<Operation<Operation, Operation>>	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.

Update(UpdateHealthCheckRequest, CallSettings)

public virtual Operation<Operation, Operation> Update(UpdateHealthCheckRequest request, CallSettings callSettings = null)

Updates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
request	UpdateHealthCheckRequest 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
Operation<Operation, Operation>	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
UpdateHealthCheckRequest request = new UpdateHealthCheckRequest
{
    RequestId = "",
    HealthCheckResource = new HealthCheck(),
    Project = "",
    HealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = healthChecksClient.Update(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 = healthChecksClient.PollOnceUpdate(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;
}

Update(String, String, HealthCheck, CallSettings)

public virtual Operation<Operation, Operation> Update(string project, string healthCheck, HealthCheck healthCheckResource, CallSettings callSettings = null)

Updates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to update.
healthCheckResource	HealthCheck The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Operation, Operation>	The RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = HealthChecksClient.Create();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
HealthCheck healthCheckResource = new HealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = healthChecksClient.Update(project, healthCheck, healthCheckResource);

// 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 = healthChecksClient.PollOnceUpdate(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;
}

UpdateAsync(UpdateHealthCheckRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(UpdateHealthCheckRequest request, CallSettings callSettings = null)

Updates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
request	UpdateHealthCheckRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
UpdateHealthCheckRequest request = new UpdateHealthCheckRequest
{
    RequestId = "",
    HealthCheckResource = new HealthCheck(),
    Project = "",
    HealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.UpdateAsync(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 healthChecksClient.PollOnceUpdateAsync(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;
}

UpdateAsync(UpdateHealthCheckRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(UpdateHealthCheckRequest request, CancellationToken cancellationToken)

Updates a HealthCheck resource in the specified project using the data included in the request.

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

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
UpdateHealthCheckRequest request = new UpdateHealthCheckRequest
{
    RequestId = "",
    HealthCheckResource = new HealthCheck(),
    Project = "",
    HealthCheck = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.UpdateAsync(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 healthChecksClient.PollOnceUpdateAsync(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;
}

UpdateAsync(String, String, HealthCheck, CallSettings)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(string project, string healthCheck, HealthCheck healthCheckResource, CallSettings callSettings = null)

Updates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to update.
healthCheckResource	HealthCheck The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
HealthCheck healthCheckResource = new HealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.UpdateAsync(project, healthCheck, healthCheckResource);

// 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 healthChecksClient.PollOnceUpdateAsync(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;
}

UpdateAsync(String, String, HealthCheck, CancellationToken)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(string project, string healthCheck, HealthCheck healthCheckResource, CancellationToken cancellationToken)

Updates a HealthCheck resource in the specified project using the data included in the request.

Parameters
Name	Description
project	String Project ID for this request.
healthCheck	String Name of the HealthCheck resource to update.
healthCheckResource	HealthCheck The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
HealthChecksClient healthChecksClient = await HealthChecksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string healthCheck = "";
HealthCheck healthCheckResource = new HealthCheck();
// Make the request
lro::Operation<Operation, Operation> response = await healthChecksClient.UpdateAsync(project, healthCheck, healthCheckResource);

// 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 healthChecksClient.PollOnceUpdateAsync(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;
}