Compute Engine v1 API - Class HealthChecksClientImpl (3.19.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

Namespace

Google.Cloud.Compute.V1

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

GrpcClient

public override HealthChecks.HealthChecksClient GrpcClient { get; }

The underlying gRPC HealthChecks client

Property Value
Type Description
HealthChecksHealthChecksClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient
Overrides

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type Description
OperationsClient
Overrides

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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

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

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

Get(GetHealthCheckRequest, CallSettings)

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

Returns the specified HealthCheck resource.

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

GetAsync(GetHealthCheckRequest, CallSettings)

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

Returns the specified HealthCheck resource.

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

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

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

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

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

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

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

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

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