Compute Engine v1 API - Class RegionHealthAggregationPolicies.RegionHealthAggregationPoliciesClient (3.26.0) 

public class RegionHealthAggregationPolicies.RegionHealthAggregationPoliciesClient : ClientBase<RegionHealthAggregationPolicies.RegionHealthAggregationPoliciesClient>

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

Client for RegionHealthAggregationPolicies

Inheritance

object > ClientBase > ClientBaseRegionHealthAggregationPoliciesRegionHealthAggregationPoliciesClient > RegionHealthAggregationPolicies.RegionHealthAggregationPoliciesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionHealthAggregationPoliciesClient()

protected RegionHealthAggregationPoliciesClient()

Protected parameterless constructor to allow creation of test doubles.

RegionHealthAggregationPoliciesClient(CallInvoker)

public RegionHealthAggregationPoliciesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

RegionHealthAggregationPoliciesClient(ChannelBase)

public RegionHealthAggregationPoliciesClient(ChannelBase channel)

Creates a new client for RegionHealthAggregationPolicies

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

RegionHealthAggregationPoliciesClient(ClientBaseConfiguration)

protected RegionHealthAggregationPoliciesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListRegionHealthAggregationPoliciesRequest, CallOptions)

public virtual HealthAggregationPolicyAggregatedList AggregatedList(AggregatedListRegionHealthAggregationPoliciesRequest request, CallOptions options)

Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project.

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

Parameters
Name Description
request AggregatedListRegionHealthAggregationPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
HealthAggregationPolicyAggregatedList

The response received from the server.

AggregatedList(AggregatedListRegionHealthAggregationPoliciesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project.

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

Parameters
Name Description
request AggregatedListRegionHealthAggregationPoliciesRequest

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
HealthAggregationPolicyAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListRegionHealthAggregationPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<HealthAggregationPolicyAggregatedList> AggregatedListAsync(AggregatedListRegionHealthAggregationPoliciesRequest request, CallOptions options)

Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project.

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

Parameters
Name Description
request AggregatedListRegionHealthAggregationPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallHealthAggregationPolicyAggregatedList

The call object.

AggregatedListAsync(AggregatedListRegionHealthAggregationPoliciesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project.

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

Parameters
Name Description
request AggregatedListRegionHealthAggregationPoliciesRequest

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
AsyncUnaryCallHealthAggregationPolicyAggregatedList

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(DeleteRegionHealthAggregationPolicyRequest, CallOptions)

public virtual Operation Delete(DeleteRegionHealthAggregationPolicyRequest request, CallOptions options)

Deletes the specified HealthAggregationPolicy in the given region.

Parameters
Name Description
request DeleteRegionHealthAggregationPolicyRequest

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(DeleteRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified HealthAggregationPolicy in the given region.

Parameters
Name Description
request DeleteRegionHealthAggregationPolicyRequest

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(DeleteRegionHealthAggregationPolicyRequest, CallOptions)

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

Deletes the specified HealthAggregationPolicy in the given region.

Parameters
Name Description
request DeleteRegionHealthAggregationPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified HealthAggregationPolicy in the given region.

Parameters
Name Description
request DeleteRegionHealthAggregationPolicyRequest

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(GetRegionHealthAggregationPolicyRequest, CallOptions)

public virtual HealthAggregationPolicy Get(GetRegionHealthAggregationPolicyRequest request, CallOptions options)

Returns the specified HealthAggregationPolicy resource in the given region.

Parameters
Name Description
request GetRegionHealthAggregationPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
HealthAggregationPolicy

The response received from the server.

Get(GetRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified HealthAggregationPolicy resource in the given region.

Parameters
Name Description
request GetRegionHealthAggregationPolicyRequest

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
HealthAggregationPolicy

The response received from the server.

GetAsync(GetRegionHealthAggregationPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<HealthAggregationPolicy> GetAsync(GetRegionHealthAggregationPolicyRequest request, CallOptions options)

Returns the specified HealthAggregationPolicy resource in the given region.

Parameters
Name Description
request GetRegionHealthAggregationPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallHealthAggregationPolicy

The call object.

GetAsync(GetRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified HealthAggregationPolicy resource in the given region.

Parameters
Name Description
request GetRegionHealthAggregationPolicyRequest

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
AsyncUnaryCallHealthAggregationPolicy

The call object.

Insert(InsertRegionHealthAggregationPolicyRequest, CallOptions)

public virtual Operation Insert(InsertRegionHealthAggregationPolicyRequest request, CallOptions options)

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

Parameters
Name Description
request InsertRegionHealthAggregationPolicyRequest

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(InsertRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request InsertRegionHealthAggregationPolicyRequest

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(InsertRegionHealthAggregationPolicyRequest, CallOptions)

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

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

Parameters
Name Description
request InsertRegionHealthAggregationPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request InsertRegionHealthAggregationPolicyRequest

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(ListRegionHealthAggregationPoliciesRequest, CallOptions)

public virtual HealthAggregationPolicyList List(ListRegionHealthAggregationPoliciesRequest request, CallOptions options)

Lists the HealthAggregationPolicies for a project in the given region.

Parameters
Name Description
request ListRegionHealthAggregationPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
HealthAggregationPolicyList

The response received from the server.

List(ListRegionHealthAggregationPoliciesRequest, Metadata, DateTime?, CancellationToken)

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

Lists the HealthAggregationPolicies for a project in the given region.

Parameters
Name Description
request ListRegionHealthAggregationPoliciesRequest

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
HealthAggregationPolicyList

The response received from the server.

ListAsync(ListRegionHealthAggregationPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<HealthAggregationPolicyList> ListAsync(ListRegionHealthAggregationPoliciesRequest request, CallOptions options)

Lists the HealthAggregationPolicies for a project in the given region.

Parameters
Name Description
request ListRegionHealthAggregationPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallHealthAggregationPolicyList

The call object.

ListAsync(ListRegionHealthAggregationPoliciesRequest, Metadata, DateTime?, CancellationToken)

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

Lists the HealthAggregationPolicies for a project in the given region.

Parameters
Name Description
request ListRegionHealthAggregationPoliciesRequest

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
AsyncUnaryCallHealthAggregationPolicyList

The call object.

NewInstance(ClientBaseConfiguration)

protected override RegionHealthAggregationPolicies.RegionHealthAggregationPoliciesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
RegionHealthAggregationPoliciesRegionHealthAggregationPoliciesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.RegionHealthAggregationPolicies.RegionHealthAggregationPoliciesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchRegionHealthAggregationPolicyRequest, CallOptions)

public virtual Operation Patch(PatchRegionHealthAggregationPolicyRequest request, CallOptions options)

Updates the specified regional HealthAggregationPolicy 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 PatchRegionHealthAggregationPolicyRequest

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(PatchRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified regional HealthAggregationPolicy 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 PatchRegionHealthAggregationPolicyRequest

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(PatchRegionHealthAggregationPolicyRequest, CallOptions)

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

Updates the specified regional HealthAggregationPolicy 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 PatchRegionHealthAggregationPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified regional HealthAggregationPolicy 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 PatchRegionHealthAggregationPolicyRequest

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(TestIamPermissionsRegionHealthAggregationPolicyRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsRegionHealthAggregationPolicyRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionHealthAggregationPolicyRequest

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(TestIamPermissionsRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionHealthAggregationPolicyRequest

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(TestIamPermissionsRegionHealthAggregationPolicyRequest, CallOptions)

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionHealthAggregationPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallTestPermissionsResponse

The call object.

TestIamPermissionsAsync(TestIamPermissionsRegionHealthAggregationPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionHealthAggregationPolicyRequest

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.