Compute Engine v1 API - Class BackendServicesClientImpl (2.3.0)

public sealed class BackendServicesClientImpl : BackendServicesClient

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

BackendServices client wrapper implementation, for convenient use.

Inheritance

Object > BackendServicesClient > BackendServicesClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The BackendServices API.

Constructors

BackendServicesClientImpl(BackendServices.BackendServicesClient, BackendServicesSettings, ILogger)

public BackendServicesClientImpl(BackendServices.BackendServicesClient grpcClient, BackendServicesSettings settings, ILogger logger)

Constructs a client wrapper for the BackendServices service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientBackendServices.BackendServicesClient

The underlying gRPC client.

settingsBackendServicesSettings

The base BackendServicesSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

AddSignedUrlKeyOperationsClient

public override OperationsClient AddSignedUrlKeyOperationsClient { get; }

The long-running operations client for AddSignedUrlKey.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteSignedUrlKeyOperationsClient

public override OperationsClient DeleteSignedUrlKeyOperationsClient { get; }

The long-running operations client for DeleteSignedUrlKey.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override BackendServices.BackendServicesClient GrpcClient { get; }

The underlying gRPC BackendServices client

Property Value
TypeDescription
BackendServices.BackendServicesClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
TypeDescription
OperationsClient
Overrides

SetEdgeSecurityPolicyOperationsClient

public override OperationsClient SetEdgeSecurityPolicyOperationsClient { get; }

The long-running operations client for SetEdgeSecurityPolicy.

Property Value
TypeDescription
OperationsClient
Overrides

SetSecurityPolicyOperationsClient

public override OperationsClient SetSecurityPolicyOperationsClient { get; }

The long-running operations client for SetSecurityPolicy.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

AddSignedUrlKey(AddSignedUrlKeyBackendServiceRequest, CallSettings)

public override Operation<Operation, Operation> AddSignedUrlKey(AddSignedUrlKeyBackendServiceRequest request, CallSettings callSettings = null)

Adds a key for validating requests with signed URLs for this backend service.

Parameters
NameDescription
requestAddSignedUrlKeyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

AddSignedUrlKeyAsync(AddSignedUrlKeyBackendServiceRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> AddSignedUrlKeyAsync(AddSignedUrlKeyBackendServiceRequest request, CallSettings callSettings = null)

Adds a key for validating requests with signed URLs for this backend service.

Parameters
NameDescription
requestAddSignedUrlKeyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

AggregatedList(AggregatedListBackendServicesRequest, CallSettings)

public override PagedEnumerable<BackendServiceAggregatedList, KeyValuePair<string, BackendServicesScopedList>> AggregatedList(AggregatedListBackendServicesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestAggregatedListBackendServicesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<BackendServiceAggregatedList, KeyValuePair<String, BackendServicesScopedList>>

A pageable sequence of KeyValuePair<TKey,TValue> resources.

Overrides

AggregatedListAsync(AggregatedListBackendServicesRequest, CallSettings)

public override PagedAsyncEnumerable<BackendServiceAggregatedList, KeyValuePair<string, BackendServicesScopedList>> AggregatedListAsync(AggregatedListBackendServicesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestAggregatedListBackendServicesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<BackendServiceAggregatedList, KeyValuePair<String, BackendServicesScopedList>>

A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Overrides

Delete(DeleteBackendServiceRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteBackendServiceRequest request, CallSettings callSettings = null)

Deletes the specified BackendService resource.

Parameters
NameDescription
requestDeleteBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

DeleteAsync(DeleteBackendServiceRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> DeleteAsync(DeleteBackendServiceRequest request, CallSettings callSettings = null)

Deletes the specified BackendService resource.

Parameters
NameDescription
requestDeleteBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

DeleteSignedUrlKey(DeleteSignedUrlKeyBackendServiceRequest, CallSettings)

public override Operation<Operation, Operation> DeleteSignedUrlKey(DeleteSignedUrlKeyBackendServiceRequest request, CallSettings callSettings = null)

Deletes a key for validating requests with signed URLs for this backend service.

Parameters
NameDescription
requestDeleteSignedUrlKeyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

DeleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendServiceRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> DeleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendServiceRequest request, CallSettings callSettings = null)

Deletes a key for validating requests with signed URLs for this backend service.

Parameters
NameDescription
requestDeleteSignedUrlKeyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

Get(GetBackendServiceRequest, CallSettings)

public override BackendService Get(GetBackendServiceRequest request, CallSettings callSettings = null)

Returns the specified BackendService resource. Gets a list of available backend services.

Parameters
NameDescription
requestGetBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BackendService

The RPC response.

Overrides

GetAsync(GetBackendServiceRequest, CallSettings)

public override Task<BackendService> GetAsync(GetBackendServiceRequest request, CallSettings callSettings = null)

Returns the specified BackendService resource. Gets a list of available backend services.

Parameters
NameDescription
requestGetBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BackendService>

A Task containing the RPC response.

Overrides

GetHealth(GetHealthBackendServiceRequest, CallSettings)

public override BackendServiceGroupHealth GetHealth(GetHealthBackendServiceRequest request, CallSettings callSettings = null)

Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

Parameters
NameDescription
requestGetHealthBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BackendServiceGroupHealth

The RPC response.

Overrides

GetHealthAsync(GetHealthBackendServiceRequest, CallSettings)

public override Task<BackendServiceGroupHealth> GetHealthAsync(GetHealthBackendServiceRequest request, CallSettings callSettings = null)

Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

Parameters
NameDescription
requestGetHealthBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BackendServiceGroupHealth>

A Task containing the RPC response.

Overrides

GetIamPolicy(GetIamPolicyBackendServiceRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetIamPolicyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Overrides

GetIamPolicyAsync(GetIamPolicyBackendServiceRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetIamPolicyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Policy>

A Task containing the RPC response.

Overrides

Insert(InsertBackendServiceRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestInsertBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

InsertAsync(InsertBackendServiceRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> InsertAsync(InsertBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestInsertBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

List(ListBackendServicesRequest, CallSettings)

public override PagedEnumerable<BackendServiceList, BackendService> List(ListBackendServicesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListBackendServicesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<BackendServiceList, BackendService>

A pageable sequence of BackendService resources.

Overrides

ListAsync(ListBackendServicesRequest, CallSettings)

public override PagedAsyncEnumerable<BackendServiceList, BackendService> ListAsync(ListBackendServicesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListBackendServicesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<BackendServiceList, BackendService>

A pageable asynchronous sequence of BackendService resources.

Overrides

Patch(PatchBackendServiceRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestPatchBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

PatchAsync(PatchBackendServiceRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> PatchAsync(PatchBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestPatchBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendServiceRequest, CallSettings)

public override Operation<Operation, Operation> SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendServiceRequest request, CallSettings callSettings = null)

Sets the edge security policy for the specified backend service.

Parameters
NameDescription
requestSetEdgeSecurityPolicyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

SetEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendServiceRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> SetEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendServiceRequest request, CallSettings callSettings = null)

Sets the edge security policy for the specified backend service.

Parameters
NameDescription
requestSetEdgeSecurityPolicyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

SetIamPolicy(SetIamPolicyBackendServiceRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSetIamPolicyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Overrides

SetIamPolicyAsync(SetIamPolicyBackendServiceRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSetIamPolicyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Policy>

A Task containing the RPC response.

Overrides

SetSecurityPolicy(SetSecurityPolicyBackendServiceRequest, CallSettings)

public override Operation<Operation, Operation> SetSecurityPolicy(SetSecurityPolicyBackendServiceRequest request, CallSettings callSettings = null)

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

Parameters
NameDescription
requestSetSecurityPolicyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

SetSecurityPolicyAsync(SetSecurityPolicyBackendServiceRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> SetSecurityPolicyAsync(SetSecurityPolicyBackendServiceRequest request, CallSettings callSettings = null)

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

Parameters
NameDescription
requestSetSecurityPolicyBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

Update(UpdateBackendServiceRequest, CallSettings)

public override Operation<Operation, Operation> Update(UpdateBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

UpdateAsync(UpdateBackendServiceRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> UpdateAsync(UpdateBackendServiceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateBackendServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides