Compute Engine v1 API - Class HealthChecks.HealthChecksClient (3.0.0)

Version latest

• 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 class HealthChecks.HealthChecksClient : ClientBase<HealthChecks.HealthChecksClient>

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

Client for HealthChecks

Inheritance

object > ClientBase > ClientBaseHealthChecksHealthChecksClient > HealthChecks.HealthChecksClient

Inherited Members

ClientBase<HealthChecks.HealthChecksClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

HealthChecksClient()

protected HealthChecksClient()

Protected parameterless constructor to allow creation of test doubles.

HealthChecksClient(CallInvoker)

public HealthChecksClient(CallInvoker callInvoker)

Creates a new client for HealthChecks that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

HealthChecksClient(ChannelBase)

public HealthChecksClient(ChannelBase channel)

Creates a new client for HealthChecks

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

HealthChecksClient(ClientBaseConfiguration)

protected HealthChecksClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListHealthChecksRequest, CallOptions)

public virtual HealthChecksAggregatedList AggregatedList(AggregatedListHealthChecksRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
HealthChecksAggregatedList	The response received from the server.

AggregatedList(AggregatedListHealthChecksRequest, Metadata, DateTime?, CancellationToken)

public virtual HealthChecksAggregatedList AggregatedList(AggregatedListHealthChecksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
HealthChecksAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListHealthChecksRequest, CallOptions)

public virtual AsyncUnaryCall<HealthChecksAggregatedList> AggregatedListAsync(AggregatedListHealthChecksRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallHealthChecksAggregatedList	The call object.

AggregatedListAsync(AggregatedListHealthChecksRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<HealthChecksAggregatedList> AggregatedListAsync(AggregatedListHealthChecksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallHealthChecksAggregatedList	The call object.

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to GlobalOperations.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteHealthCheckRequest, CallOptions)

public virtual Operation Delete(DeleteHealthCheckRequest request, CallOptions options)

Deletes the specified HealthCheck resource.

Parameters
Name	Description
request	DeleteHealthCheckRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified HealthCheck resource.

Parameters
Name	Description
request	DeleteHealthCheckRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteAsync(DeleteHealthCheckRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteHealthCheckRequest request, CallOptions options)

Deletes the specified HealthCheck resource.

Parameters
Name	Description
request	DeleteHealthCheckRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified HealthCheck resource.

Parameters
Name	Description
request	DeleteHealthCheckRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

Get(GetHealthCheckRequest, CallOptions)

public virtual HealthCheck Get(GetHealthCheckRequest request, CallOptions options)

Returns the specified HealthCheck resource.

Parameters
Name	Description
request	GetHealthCheckRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
HealthCheck	The response received from the server.

Get(GetHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual HealthCheck Get(GetHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified HealthCheck resource.

Parameters
Name	Description
request	GetHealthCheckRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
HealthCheck	The response received from the server.

GetAsync(GetHealthCheckRequest, CallOptions)

public virtual AsyncUnaryCall<HealthCheck> GetAsync(GetHealthCheckRequest request, CallOptions options)

Returns the specified HealthCheck resource.

Parameters
Name	Description
request	GetHealthCheckRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallHealthCheck	The call object.

GetAsync(GetHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<HealthCheck> GetAsync(GetHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified HealthCheck resource.

Parameters
Name	Description
request	GetHealthCheckRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallHealthCheck	The call object.

Insert(InsertHealthCheckRequest, CallOptions)

public virtual Operation Insert(InsertHealthCheckRequest request, CallOptions options)

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

Parameters
Name	Description
request	InsertHealthCheckRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	InsertHealthCheckRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

InsertAsync(InsertHealthCheckRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertHealthCheckRequest request, CallOptions options)

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

Parameters
Name	Description
request	InsertHealthCheckRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	InsertHealthCheckRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

List(ListHealthChecksRequest, CallOptions)

public virtual HealthCheckList List(ListHealthChecksRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListHealthChecksRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
HealthCheckList	The response received from the server.

List(ListHealthChecksRequest, Metadata, DateTime?, CancellationToken)

public virtual HealthCheckList List(ListHealthChecksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListHealthChecksRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
HealthCheckList	The response received from the server.

ListAsync(ListHealthChecksRequest, CallOptions)

public virtual AsyncUnaryCall<HealthCheckList> ListAsync(ListHealthChecksRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListHealthChecksRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallHealthCheckList	The call object.

ListAsync(ListHealthChecksRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<HealthCheckList> ListAsync(ListHealthChecksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListHealthChecksRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallHealthCheckList	The call object.

NewInstance(ClientBaseConfiguration)

protected override HealthChecks.HealthChecksClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
HealthChecksHealthChecksClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.HealthChecks.HealthChecksClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchHealthCheckRequest, CallOptions)

public virtual Operation Patch(PatchHealthCheckRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Patch(PatchHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Patch(PatchHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

PatchAsync(PatchHealthCheckRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchHealthCheckRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PatchAsync(PatchHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

Update(UpdateHealthCheckRequest, CallOptions)

public virtual Operation Update(UpdateHealthCheckRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateHealthCheckRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Update(UpdateHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Update(UpdateHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateHealthCheckRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateAsync(UpdateHealthCheckRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateHealthCheckRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateHealthCheckRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateAsync(UpdateHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateHealthCheckRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.