Compute Engine v1 API - Class RegionHealthSources.RegionHealthSourcesClient (3.26.0)

public class RegionHealthSources.RegionHealthSourcesClient : ClientBase<RegionHealthSources.RegionHealthSourcesClient>

Reference documentation and code samples for the Compute Engine v1 API class RegionHealthSources.RegionHealthSourcesClient.

Client for RegionHealthSources

Inheritance

object > ClientBase > ClientBaseRegionHealthSourcesRegionHealthSourcesClient > RegionHealthSources.RegionHealthSourcesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionHealthSourcesClient()

protected RegionHealthSourcesClient()

Protected parameterless constructor to allow creation of test doubles.

RegionHealthSourcesClient(CallInvoker)

public RegionHealthSourcesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

RegionHealthSourcesClient(ChannelBase)

public RegionHealthSourcesClient(ChannelBase channel)

Creates a new client for RegionHealthSources

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

RegionHealthSourcesClient(ClientBaseConfiguration)

protected RegionHealthSourcesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListRegionHealthSourcesRequest, CallOptions)

public virtual HealthSourceAggregatedList AggregatedList(AggregatedListRegionHealthSourcesRequest request, CallOptions options)

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

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListRegionHealthSourcesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
HealthSourceAggregatedList

The response received from the server.

AggregatedList(AggregatedListRegionHealthSourcesRequest, Metadata, DateTime?, CancellationToken)

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

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

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListRegionHealthSourcesRequest

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
HealthSourceAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListRegionHealthSourcesRequest, CallOptions)

public virtual AsyncUnaryCall<HealthSourceAggregatedList> AggregatedListAsync(AggregatedListRegionHealthSourcesRequest request, CallOptions options)

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

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListRegionHealthSourcesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallHealthSourceAggregatedList

The call object.

AggregatedListAsync(AggregatedListRegionHealthSourcesRequest, Metadata, DateTime?, CancellationToken)

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

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

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListRegionHealthSourcesRequest

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
AsyncUnaryCallHealthSourceAggregatedList

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

public virtual Operation Delete(DeleteRegionHealthSourceRequest request, CallOptions options)

Deletes the specified HealthSource in the given region

Parameters
Name Description
request DeleteRegionHealthSourceRequest

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

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

Deletes the specified HealthSource in the given region

Parameters
Name Description
request DeleteRegionHealthSourceRequest

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

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

Deletes the specified HealthSource in the given region

Parameters
Name Description
request DeleteRegionHealthSourceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteRegionHealthSourceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified HealthSource in the given region

Parameters
Name Description
request DeleteRegionHealthSourceRequest

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

public virtual HealthSource Get(GetRegionHealthSourceRequest request, CallOptions options)

Returns the specified HealthSource resource in the given region.

Parameters
Name Description
request GetRegionHealthSourceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
HealthSource

The response received from the server.

Get(GetRegionHealthSourceRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified HealthSource resource in the given region.

Parameters
Name Description
request GetRegionHealthSourceRequest

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
HealthSource

The response received from the server.

GetAsync(GetRegionHealthSourceRequest, CallOptions)

public virtual AsyncUnaryCall<HealthSource> GetAsync(GetRegionHealthSourceRequest request, CallOptions options)

Returns the specified HealthSource resource in the given region.

Parameters
Name Description
request GetRegionHealthSourceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallHealthSource

The call object.

GetAsync(GetRegionHealthSourceRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified HealthSource resource in the given region.

Parameters
Name Description
request GetRegionHealthSourceRequest

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
AsyncUnaryCallHealthSource

The call object.

Insert(InsertRegionHealthSourceRequest, CallOptions)

public virtual Operation Insert(InsertRegionHealthSourceRequest request, CallOptions options)

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

Parameters
Name Description
request InsertRegionHealthSourceRequest

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

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

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

Parameters
Name Description
request InsertRegionHealthSourceRequest

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

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

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

Parameters
Name Description
request InsertRegionHealthSourceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertRegionHealthSourceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request InsertRegionHealthSourceRequest

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

public virtual HealthSourceList List(ListRegionHealthSourcesRequest request, CallOptions options)

Lists the HealthSources for a project in the given region.

Parameters
Name Description
request ListRegionHealthSourcesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
HealthSourceList

The response received from the server.

List(ListRegionHealthSourcesRequest, Metadata, DateTime?, CancellationToken)

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

Lists the HealthSources for a project in the given region.

Parameters
Name Description
request ListRegionHealthSourcesRequest

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
HealthSourceList

The response received from the server.

ListAsync(ListRegionHealthSourcesRequest, CallOptions)

public virtual AsyncUnaryCall<HealthSourceList> ListAsync(ListRegionHealthSourcesRequest request, CallOptions options)

Lists the HealthSources for a project in the given region.

Parameters
Name Description
request ListRegionHealthSourcesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallHealthSourceList

The call object.

ListAsync(ListRegionHealthSourcesRequest, Metadata, DateTime?, CancellationToken)

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

Lists the HealthSources for a project in the given region.

Parameters
Name Description
request ListRegionHealthSourcesRequest

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
AsyncUnaryCallHealthSourceList

The call object.

NewInstance(ClientBaseConfiguration)

protected override RegionHealthSources.RegionHealthSourcesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
RegionHealthSourcesRegionHealthSourcesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.RegionHealthSources.RegionHealthSourcesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchRegionHealthSourceRequest, CallOptions)

public virtual Operation Patch(PatchRegionHealthSourceRequest request, CallOptions options)

Updates the specified regional HealthSource 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 PatchRegionHealthSourceRequest

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

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

Updates the specified regional HealthSource 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 PatchRegionHealthSourceRequest

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

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

Updates the specified regional HealthSource 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 PatchRegionHealthSourceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchRegionHealthSourceRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified regional HealthSource 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 PatchRegionHealthSourceRequest

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

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsRegionHealthSourceRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionHealthSourceRequest

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

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionHealthSourceRequest

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

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionHealthSourceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallTestPermissionsResponse

The call object.

TestIamPermissionsAsync(TestIamPermissionsRegionHealthSourceRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsRegionHealthSourceRequest

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.