Compute Engine v1 API - Class RegionHealthChecks.RegionHealthChecksClient (2.4.0)

public class RegionHealthChecksClient : ClientBase<RegionHealthChecks.RegionHealthChecksClient>

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

Client for RegionHealthChecks

Inheritance

Object > ClientBase > ClientBase<RegionHealthChecks.RegionHealthChecksClient> > RegionHealthChecks.RegionHealthChecksClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionHealthChecksClient()

protected RegionHealthChecksClient()

Protected parameterless constructor to allow creation of test doubles.

RegionHealthChecksClient(CallInvoker)

public RegionHealthChecksClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

RegionHealthChecksClient(ChannelBase)

public RegionHealthChecksClient(ChannelBase channel)

Creates a new client for RegionHealthChecks

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

RegionHealthChecksClient(ClientBase.ClientBaseConfiguration)

protected RegionHealthChecksClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

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

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

Delete(DeleteRegionHealthCheckRequest, CallOptions)

public virtual Operation Delete(DeleteRegionHealthCheckRequest request, CallOptions options)

Deletes the specified HealthCheck resource.

Parameters
NameDescription
requestDeleteRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified HealthCheck resource.

Parameters
NameDescription
requestDeleteRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAsync(DeleteRegionHealthCheckRequest, CallOptions)

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

Deletes the specified HealthCheck resource.

Parameters
NameDescription
requestDeleteRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified HealthCheck resource.

Parameters
NameDescription
requestDeleteRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Get(GetRegionHealthCheckRequest, CallOptions)

public virtual HealthCheck Get(GetRegionHealthCheckRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
HealthCheck

The response received from the server.

Get(GetRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
HealthCheck

The response received from the server.

GetAsync(GetRegionHealthCheckRequest, CallOptions)

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

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

Parameters
NameDescription
requestGetRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<HealthCheck>

The call object.

GetAsync(GetRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<HealthCheck>

The call object.

Insert(InsertRegionHealthCheckRequest, CallOptions)

public virtual Operation Insert(InsertRegionHealthCheckRequest request, CallOptions options)

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

Parameters
NameDescription
requestInsertRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestInsertRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

InsertAsync(InsertRegionHealthCheckRequest, CallOptions)

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

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

Parameters
NameDescription
requestInsertRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

InsertAsync(InsertRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestInsertRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

List(ListRegionHealthChecksRequest, CallOptions)

public virtual HealthCheckList List(ListRegionHealthChecksRequest request, CallOptions options)

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

Parameters
NameDescription
requestListRegionHealthChecksRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
HealthCheckList

The response received from the server.

List(ListRegionHealthChecksRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListRegionHealthChecksRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
HealthCheckList

The response received from the server.

ListAsync(ListRegionHealthChecksRequest, CallOptions)

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

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

Parameters
NameDescription
requestListRegionHealthChecksRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<HealthCheckList>

The call object.

ListAsync(ListRegionHealthChecksRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListRegionHealthChecksRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<HealthCheckList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override RegionHealthChecks.RegionHealthChecksClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
RegionHealthChecks.RegionHealthChecksClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.RegionHealthChecks.RegionHealthChecksClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchRegionHealthCheckRequest, CallOptions)

public virtual Operation Patch(PatchRegionHealthCheckRequest 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
NameDescription
requestPatchRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Patch(PatchRegionHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(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
NameDescription
requestPatchRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

PatchAsync(PatchRegionHealthCheckRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchRegionHealthCheckRequest 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
NameDescription
requestPatchRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

PatchAsync(PatchRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchRegionHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(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
NameDescription
requestPatchRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Update(UpdateRegionHealthCheckRequest, CallOptions)

public virtual Operation Update(UpdateRegionHealthCheckRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Update(UpdateRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAsync(UpdateRegionHealthCheckRequest, CallOptions)

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

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

Parameters
NameDescription
requestUpdateRegionHealthCheckRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateAsync(UpdateRegionHealthCheckRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateRegionHealthCheckRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.