Compute Engine v1 API - Class HealthChecksClientImpl (2.7.0)

Version 2.7.0

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

public sealed class HealthChecksClientImpl : HealthChecksClient

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

HealthChecks client wrapper implementation, for convenient use.

Inheritance

object > HealthChecksClient > HealthChecksClientImpl

Inherited Members

HealthChecksClient.DefaultEndpoint

HealthChecksClient.DefaultScopes

HealthChecksClient.ServiceMetadata

HealthChecksClient.CreateAsync(CancellationToken)

HealthChecksClient.Create()

HealthChecksClient.ShutdownDefaultChannelsAsync()

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

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

HealthChecksClient.DeleteAsync(DeleteHealthCheckRequest, CancellationToken)

HealthChecksClient.PollOnceDelete(string, CallSettings)

HealthChecksClient.PollOnceDeleteAsync(string, CallSettings)

HealthChecksClient.Delete(string, string, CallSettings)

HealthChecksClient.DeleteAsync(string, string, CallSettings)

HealthChecksClient.DeleteAsync(string, string, CancellationToken)

HealthChecksClient.GetAsync(GetHealthCheckRequest, CancellationToken)

HealthChecksClient.Get(string, string, CallSettings)

HealthChecksClient.GetAsync(string, string, CallSettings)

HealthChecksClient.GetAsync(string, string, CancellationToken)

HealthChecksClient.InsertAsync(InsertHealthCheckRequest, CancellationToken)

HealthChecksClient.PollOnceInsert(string, CallSettings)

HealthChecksClient.PollOnceInsertAsync(string, CallSettings)

HealthChecksClient.Insert(string, HealthCheck, CallSettings)

HealthChecksClient.InsertAsync(string, HealthCheck, CallSettings)

HealthChecksClient.InsertAsync(string, HealthCheck, CancellationToken)

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

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

HealthChecksClient.PatchAsync(PatchHealthCheckRequest, CancellationToken)

HealthChecksClient.PollOncePatch(string, CallSettings)

HealthChecksClient.PollOncePatchAsync(string, CallSettings)

HealthChecksClient.Patch(string, string, HealthCheck, CallSettings)

HealthChecksClient.PatchAsync(string, string, HealthCheck, CallSettings)

HealthChecksClient.PatchAsync(string, string, HealthCheck, CancellationToken)

HealthChecksClient.UpdateAsync(UpdateHealthCheckRequest, CancellationToken)

HealthChecksClient.PollOnceUpdate(string, CallSettings)

HealthChecksClient.PollOnceUpdateAsync(string, CallSettings)

HealthChecksClient.Update(string, string, HealthCheck, CallSettings)

HealthChecksClient.UpdateAsync(string, string, HealthCheck, CallSettings)

HealthChecksClient.UpdateAsync(string, string, HealthCheck, CancellationToken)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The HealthChecks API.

Constructors

HealthChecksClientImpl(HealthChecksClient, HealthChecksSettings, ILogger)

public HealthChecksClientImpl(HealthChecks.HealthChecksClient grpcClient, HealthChecksSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	HealthChecksHealthChecksClient The underlying gRPC client.
settings	HealthChecksSettings The base HealthChecksSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

Overrides

HealthChecksClient.DeleteOperationsClient

GrpcClient

public override HealthChecks.HealthChecksClient GrpcClient { get; }

The underlying gRPC HealthChecks client

Property Value
Type	Description
HealthChecksHealthChecksClient

Overrides

HealthChecksClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Overrides

HealthChecksClient.InsertOperationsClient

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
OperationsClient

Overrides

HealthChecksClient.PatchOperationsClient

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type	Description
OperationsClient

Overrides

HealthChecksClient.UpdateOperationsClient

Methods

AggregatedList(AggregatedListHealthChecksRequest, CallSettings)

public override 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
PagedEnumerableHealthChecksAggregatedListKeyValuePairstringHealthChecksScopedList	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Overrides

HealthChecksClient.AggregatedList(AggregatedListHealthChecksRequest, CallSettings)

AggregatedListAsync(AggregatedListHealthChecksRequest, CallSettings)

public override 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
PagedAsyncEnumerableHealthChecksAggregatedListKeyValuePairstringHealthChecksScopedList	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Overrides

HealthChecksClient.AggregatedListAsync(AggregatedListHealthChecksRequest, CallSettings)

Delete(DeleteHealthCheckRequest, CallSettings)

public override 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
OperationOperationOperation	The RPC response.

Overrides

HealthChecksClient.Delete(DeleteHealthCheckRequest, CallSettings)

DeleteAsync(DeleteHealthCheckRequest, CallSettings)

public override 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
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

HealthChecksClient.DeleteAsync(DeleteHealthCheckRequest, CallSettings)

Get(GetHealthCheckRequest, CallSettings)

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

Overrides

HealthChecksClient.Get(GetHealthCheckRequest, CallSettings)

GetAsync(GetHealthCheckRequest, CallSettings)

public override 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
TaskHealthCheck	A Task containing the RPC response.

Overrides

HealthChecksClient.GetAsync(GetHealthCheckRequest, CallSettings)

Insert(InsertHealthCheckRequest, CallSettings)

public override 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
OperationOperationOperation	The RPC response.

Overrides

HealthChecksClient.Insert(InsertHealthCheckRequest, CallSettings)

InsertAsync(InsertHealthCheckRequest, CallSettings)

public override 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
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

HealthChecksClient.InsertAsync(InsertHealthCheckRequest, CallSettings)

List(ListHealthChecksRequest, CallSettings)

public override 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
PagedEnumerableHealthCheckListHealthCheck	A pageable sequence of HealthCheck resources.

Overrides

HealthChecksClient.List(ListHealthChecksRequest, CallSettings)

ListAsync(ListHealthChecksRequest, CallSettings)

public override 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
PagedAsyncEnumerableHealthCheckListHealthCheck	A pageable asynchronous sequence of HealthCheck resources.

Overrides

HealthChecksClient.ListAsync(ListHealthChecksRequest, CallSettings)

Patch(PatchHealthCheckRequest, CallSettings)

public override 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
OperationOperationOperation	The RPC response.

Overrides

HealthChecksClient.Patch(PatchHealthCheckRequest, CallSettings)

PatchAsync(PatchHealthCheckRequest, CallSettings)

public override 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
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

HealthChecksClient.PatchAsync(PatchHealthCheckRequest, CallSettings)

Update(UpdateHealthCheckRequest, CallSettings)

public override 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
OperationOperationOperation	The RPC response.

Overrides

HealthChecksClient.Update(UpdateHealthCheckRequest, CallSettings)

UpdateAsync(UpdateHealthCheckRequest, CallSettings)

public override 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
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

HealthChecksClient.UpdateAsync(UpdateHealthCheckRequest, CallSettings)