Compute Engine v1 API - Class RegionBackendServices.RegionBackendServicesClient (2.9.0)

public class RegionBackendServices.RegionBackendServicesClient : ClientBase<RegionBackendServices.RegionBackendServicesClient>

Reference documentation and code samples for the Compute Engine v1 API class RegionBackendServices.RegionBackendServicesClient.

Client for RegionBackendServices

Inheritance

object > ClientBase > ClientBaseRegionBackendServicesRegionBackendServicesClient > RegionBackendServices.RegionBackendServicesClient

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionBackendServicesClient()

protected RegionBackendServicesClient()

Protected parameterless constructor to allow creation of test doubles.

RegionBackendServicesClient(CallInvoker)

public RegionBackendServicesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

RegionBackendServicesClient(ChannelBase)

public RegionBackendServicesClient(ChannelBase channel)

Creates a new client for RegionBackendServices

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

RegionBackendServicesClient(ClientBaseConfiguration)

protected RegionBackendServicesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

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
OperationsOperationsClient

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

Delete(DeleteRegionBackendServiceRequest, CallOptions)

public virtual Operation Delete(DeleteRegionBackendServiceRequest request, CallOptions options)

Deletes the specified regional BackendService resource.

Parameters
NameDescription
requestDeleteRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified regional BackendService resource.

Parameters
NameDescription
requestDeleteRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

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

Deletes the specified regional BackendService resource.

Parameters
NameDescription
requestDeleteRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified regional BackendService resource.

Parameters
NameDescription
requestDeleteRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

Get(GetRegionBackendServiceRequest, CallOptions)

public virtual BackendService Get(GetRegionBackendServiceRequest request, CallOptions options)

Returns the specified regional BackendService resource.

Parameters
NameDescription
requestGetRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BackendService

The response received from the server.

Get(GetRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified regional BackendService resource.

Parameters
NameDescription
requestGetRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
BackendService

The response received from the server.

GetAsync(GetRegionBackendServiceRequest, CallOptions)

public virtual AsyncUnaryCall<BackendService> GetAsync(GetRegionBackendServiceRequest request, CallOptions options)

Returns the specified regional BackendService resource.

Parameters
NameDescription
requestGetRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallBackendService

The call object.

GetAsync(GetRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified regional BackendService resource.

Parameters
NameDescription
requestGetRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallBackendService

The call object.

GetHealth(GetHealthRegionBackendServiceRequest, CallOptions)

public virtual BackendServiceGroupHealth GetHealth(GetHealthRegionBackendServiceRequest request, CallOptions options)

Gets the most recent health check results for this regional BackendService.

Parameters
NameDescription
requestGetHealthRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BackendServiceGroupHealth

The response received from the server.

GetHealth(GetHealthRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual BackendServiceGroupHealth GetHealth(GetHealthRegionBackendServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the most recent health check results for this regional BackendService.

Parameters
NameDescription
requestGetHealthRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
BackendServiceGroupHealth

The response received from the server.

GetHealthAsync(GetHealthRegionBackendServiceRequest, CallOptions)

public virtual AsyncUnaryCall<BackendServiceGroupHealth> GetHealthAsync(GetHealthRegionBackendServiceRequest request, CallOptions options)

Gets the most recent health check results for this regional BackendService.

Parameters
NameDescription
requestGetHealthRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallBackendServiceGroupHealth

The call object.

GetHealthAsync(GetHealthRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BackendServiceGroupHealth> GetHealthAsync(GetHealthRegionBackendServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the most recent health check results for this regional BackendService.

Parameters
NameDescription
requestGetHealthRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallBackendServiceGroupHealth

The call object.

GetIamPolicy(GetIamPolicyRegionBackendServiceRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRegionBackendServiceRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRegionBackendServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
Policy

The response received from the server.

GetIamPolicyAsync(GetIamPolicyRegionBackendServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRegionBackendServiceRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPolicy

The call object.

GetIamPolicyAsync(GetIamPolicyRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRegionBackendServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallPolicy

The call object.

Insert(InsertRegionBackendServiceRequest, CallOptions)

public virtual Operation Insert(InsertRegionBackendServiceRequest request, CallOptions options)

Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

Parameters
NameDescription
requestInsertRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

Parameters
NameDescription
requestInsertRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

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

Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

Parameters
NameDescription
requestInsertRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

Parameters
NameDescription
requestInsertRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

List(ListRegionBackendServicesRequest, CallOptions)

public virtual BackendServiceList List(ListRegionBackendServicesRequest request, CallOptions options)

Retrieves the list of regional BackendService resources available to the specified project in the given region.

Parameters
NameDescription
requestListRegionBackendServicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BackendServiceList

The response received from the server.

List(ListRegionBackendServicesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of regional BackendService resources available to the specified project in the given region.

Parameters
NameDescription
requestListRegionBackendServicesRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
BackendServiceList

The response received from the server.

ListAsync(ListRegionBackendServicesRequest, CallOptions)

public virtual AsyncUnaryCall<BackendServiceList> ListAsync(ListRegionBackendServicesRequest request, CallOptions options)

Retrieves the list of regional BackendService resources available to the specified project in the given region.

Parameters
NameDescription
requestListRegionBackendServicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallBackendServiceList

The call object.

ListAsync(ListRegionBackendServicesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of regional BackendService resources available to the specified project in the given region.

Parameters
NameDescription
requestListRegionBackendServicesRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallBackendServiceList

The call object.

NewInstance(ClientBaseConfiguration)

protected override RegionBackendServices.RegionBackendServicesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
RegionBackendServicesRegionBackendServicesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.RegionBackendServices.RegionBackendServicesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchRegionBackendServiceRequest, CallOptions)

public virtual Operation Patch(PatchRegionBackendServiceRequest request, CallOptions options)

Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

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

Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

SetIamPolicy(SetIamPolicyRegionBackendServiceRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRegionBackendServiceRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRegionBackendServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
Policy

The response received from the server.

SetIamPolicyAsync(SetIamPolicyRegionBackendServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRegionBackendServiceRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPolicy

The call object.

SetIamPolicyAsync(SetIamPolicyRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRegionBackendServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallPolicy

The call object.

Update(UpdateRegionBackendServiceRequest, CallOptions)

public virtual Operation Update(UpdateRegionBackendServiceRequest request, CallOptions options)

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .

Parameters
NameDescription
requestUpdateRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Update(UpdateRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .

Parameters
NameDescription
requestUpdateRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

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

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .

Parameters
NameDescription
requestUpdateRegionBackendServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateAsync(UpdateRegionBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .

Parameters
NameDescription
requestUpdateRegionBackendServiceRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.