Compute Engine v1 API - Class RegionCompositeHealthChecks.RegionCompositeHealthChecksClient (3.26.0)

3.26.0 (latest) 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 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 class RegionCompositeHealthChecks.RegionCompositeHealthChecksClient : ClientBase<RegionCompositeHealthChecks.RegionCompositeHealthChecksClient>

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

Client for RegionCompositeHealthChecks

Inheritance

object > ClientBase > ClientBaseRegionCompositeHealthChecksRegionCompositeHealthChecksClient > RegionCompositeHealthChecks.RegionCompositeHealthChecksClient

Inherited Members

ClientBase<RegionCompositeHealthChecks.RegionCompositeHealthChecksClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionCompositeHealthChecksClient()

protected RegionCompositeHealthChecksClient()

Protected parameterless constructor to allow creation of test doubles.

RegionCompositeHealthChecksClient(CallInvoker)

public RegionCompositeHealthChecksClient(CallInvoker callInvoker)

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

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

RegionCompositeHealthChecksClient(ChannelBase)

public RegionCompositeHealthChecksClient(ChannelBase channel)

Creates a new client for RegionCompositeHealthChecks

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

RegionCompositeHealthChecksClient(ClientBaseConfiguration)

protected RegionCompositeHealthChecksClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListRegionCompositeHealthChecksRequest, CallOptions)

public virtual CompositeHealthCheckAggregatedList AggregatedList(AggregatedListRegionCompositeHealthChecksRequest request, CallOptions options)

Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

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

Returns
Type	Description
CompositeHealthCheckAggregatedList	The response received from the server.

AggregatedList(AggregatedListRegionCompositeHealthChecksRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListRegionCompositeHealthChecksRequest 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
CompositeHealthCheckAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListRegionCompositeHealthChecksRequest, CallOptions)

public virtual AsyncUnaryCall<CompositeHealthCheckAggregatedList> AggregatedListAsync(AggregatedListRegionCompositeHealthChecksRequest request, CallOptions options)

Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

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

Returns
Type	Description
AsyncUnaryCallCompositeHealthCheckAggregatedList	The call object.

AggregatedListAsync(AggregatedListRegionCompositeHealthChecksRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project.

To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListRegionCompositeHealthChecksRequest 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
AsyncUnaryCallCompositeHealthCheckAggregatedList	The call object.

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
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteRegionCompositeHealthCheckRequest, CallOptions)

public virtual Operation Delete(DeleteRegionCompositeHealthCheckRequest request, CallOptions options)

Deletes the specified CompositeHealthCheck in the given region

Parameters
Name	Description
request	DeleteRegionCompositeHealthCheckRequest 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(DeleteRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified CompositeHealthCheck in the given region

Parameters
Name	Description
request	DeleteRegionCompositeHealthCheckRequest 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(DeleteRegionCompositeHealthCheckRequest, CallOptions)

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

Deletes the specified CompositeHealthCheck in the given region

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified CompositeHealthCheck in the given region

Parameters
Name	Description
request	DeleteRegionCompositeHealthCheckRequest 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(GetRegionCompositeHealthCheckRequest, CallOptions)

public virtual CompositeHealthCheck Get(GetRegionCompositeHealthCheckRequest request, CallOptions options)

Returns the specified CompositeHealthCheck resource in the given region.

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

Returns
Type	Description
CompositeHealthCheck	The response received from the server.

Get(GetRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified CompositeHealthCheck resource in the given region.

Parameters
Name	Description
request	GetRegionCompositeHealthCheckRequest 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
CompositeHealthCheck	The response received from the server.

GetAsync(GetRegionCompositeHealthCheckRequest, CallOptions)

public virtual AsyncUnaryCall<CompositeHealthCheck> GetAsync(GetRegionCompositeHealthCheckRequest request, CallOptions options)

Returns the specified CompositeHealthCheck resource in the given region.

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

Returns
Type	Description
AsyncUnaryCallCompositeHealthCheck	The call object.

GetAsync(GetRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified CompositeHealthCheck resource in the given region.

Parameters
Name	Description
request	GetRegionCompositeHealthCheckRequest 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
AsyncUnaryCallCompositeHealthCheck	The call object.

Insert(InsertRegionCompositeHealthCheckRequest, CallOptions)

public virtual Operation Insert(InsertRegionCompositeHealthCheckRequest request, CallOptions options)

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
request	InsertRegionCompositeHealthCheckRequest 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(InsertRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

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

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
request	InsertRegionCompositeHealthCheckRequest 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(InsertRegionCompositeHealthCheckRequest, CallOptions)

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

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

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

Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.

Parameters
Name	Description
request	InsertRegionCompositeHealthCheckRequest 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(ListRegionCompositeHealthChecksRequest, CallOptions)

public virtual CompositeHealthCheckList List(ListRegionCompositeHealthChecksRequest request, CallOptions options)

Lists the CompositeHealthChecks for a project in the given region.

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

Returns
Type	Description
CompositeHealthCheckList	The response received from the server.

List(ListRegionCompositeHealthChecksRequest, Metadata, DateTime?, CancellationToken)

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

Lists the CompositeHealthChecks for a project in the given region.

Parameters
Name	Description
request	ListRegionCompositeHealthChecksRequest 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
CompositeHealthCheckList	The response received from the server.

ListAsync(ListRegionCompositeHealthChecksRequest, CallOptions)

public virtual AsyncUnaryCall<CompositeHealthCheckList> ListAsync(ListRegionCompositeHealthChecksRequest request, CallOptions options)

Lists the CompositeHealthChecks for a project in the given region.

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

Returns
Type	Description
AsyncUnaryCallCompositeHealthCheckList	The call object.

ListAsync(ListRegionCompositeHealthChecksRequest, Metadata, DateTime?, CancellationToken)

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

Lists the CompositeHealthChecks for a project in the given region.

Parameters
Name	Description
request	ListRegionCompositeHealthChecksRequest 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
AsyncUnaryCallCompositeHealthCheckList	The call object.

NewInstance(ClientBaseConfiguration)

protected override RegionCompositeHealthChecks.RegionCompositeHealthChecksClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
RegionCompositeHealthChecksRegionCompositeHealthChecksClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.RegionCompositeHealthChecks.RegionCompositeHealthChecksClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchRegionCompositeHealthCheckRequest, CallOptions)

public virtual Operation Patch(PatchRegionCompositeHealthCheckRequest request, CallOptions options)

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name	Description
request	PatchRegionCompositeHealthCheckRequest 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(PatchRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name	Description
request	PatchRegionCompositeHealthCheckRequest 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(PatchRegionCompositeHealthCheckRequest, CallOptions)

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

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PatchAsync(PatchRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name	Description
request	PatchRegionCompositeHealthCheckRequest 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.

TestIamPermissions(TestIamPermissionsRegionCompositeHealthCheckRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsRegionCompositeHealthCheckRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

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

Returns
Type	Description
TestPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsRegionCompositeHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsRegionCompositeHealthCheckRequest 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
TestPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRegionCompositeHealthCheckRequest, CallOptions)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRegionCompositeHealthCheckRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

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

Returns
Type	Description
AsyncUnaryCallTestPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsRegionCompositeHealthCheckRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRegionCompositeHealthCheckRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsRegionCompositeHealthCheckRequest 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
AsyncUnaryCallTestPermissionsResponse	The call object.