Compute Engine v1 API - Class BackendServices.BackendServicesClient (2.15.0)

public class BackendServices.BackendServicesClient : ClientBase<BackendServices.BackendServicesClient>

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

Client for BackendServices

Inheritance

object > ClientBase > ClientBaseBackendServicesBackendServicesClient > BackendServices.BackendServicesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

BackendServicesClient()

protected BackendServicesClient()

Protected parameterless constructor to allow creation of test doubles.

BackendServicesClient(CallInvoker)

public BackendServicesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

BackendServicesClient(ChannelBase)

public BackendServicesClient(ChannelBase channel)

Creates a new client for BackendServices

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

BackendServicesClient(ClientBaseConfiguration)

protected BackendServicesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AddSignedUrlKey(AddSignedUrlKeyBackendServiceRequest, CallOptions)

public virtual Operation AddSignedUrlKey(AddSignedUrlKeyBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request AddSignedUrlKeyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

AddSignedUrlKey(AddSignedUrlKeyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request AddSignedUrlKeyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

AddSignedUrlKeyAsync(AddSignedUrlKeyBackendServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AddSignedUrlKeyAsync(AddSignedUrlKeyBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request AddSignedUrlKeyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

AddSignedUrlKeyAsync(AddSignedUrlKeyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request AddSignedUrlKeyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

AggregatedList(AggregatedListBackendServicesRequest, CallOptions)

public virtual BackendServiceAggregatedList AggregatedList(AggregatedListBackendServicesRequest request, CallOptions options)

Retrieves the list of all BackendService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListBackendServicesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
BackendServiceAggregatedList

The response received from the server.

AggregatedList(AggregatedListBackendServicesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of all BackendService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListBackendServicesRequest

The request to send to the server.

headers Metadata

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

deadline 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
BackendServiceAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListBackendServicesRequest, CallOptions)

public virtual AsyncUnaryCall<BackendServiceAggregatedList> AggregatedListAsync(AggregatedListBackendServicesRequest request, CallOptions options)

Retrieves the list of all BackendService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListBackendServicesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallBackendServiceAggregatedList

The call object.

AggregatedListAsync(AggregatedListBackendServicesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of all BackendService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListBackendServicesRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallBackendServiceAggregatedList

The call object.

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to GlobalOperations.

Returns
Type Description
OperationsOperationsClient

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

Delete(DeleteBackendServiceRequest, CallOptions)

public virtual Operation Delete(DeleteBackendServiceRequest request, CallOptions options)

Deletes the specified BackendService resource.

Parameters
Name Description
request DeleteBackendServiceRequest

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

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

Deletes the specified BackendService resource.

Parameters
Name Description
request DeleteBackendServiceRequest

The request to send to the server.

headers Metadata

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

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

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

Deletes the specified BackendService resource.

Parameters
Name Description
request DeleteBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified BackendService resource.

Parameters
Name Description
request DeleteBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

DeleteSignedUrlKey(DeleteSignedUrlKeyBackendServiceRequest, CallOptions)

public virtual Operation DeleteSignedUrlKey(DeleteSignedUrlKeyBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request DeleteSignedUrlKeyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteSignedUrlKey(DeleteSignedUrlKeyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request DeleteSignedUrlKeyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

DeleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request DeleteSignedUrlKeyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request DeleteSignedUrlKeyBackendServiceRequest

The request to send to the server.

headers Metadata

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

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

public virtual BackendService Get(GetBackendServiceRequest request, CallOptions options)

Returns the specified BackendService resource.

Parameters
Name Description
request GetBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
BackendService

The response received from the server.

Get(GetBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified BackendService resource.

Parameters
Name Description
request GetBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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
BackendService

The response received from the server.

GetAsync(GetBackendServiceRequest, CallOptions)

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

Returns the specified BackendService resource.

Parameters
Name Description
request GetBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallBackendService

The call object.

GetAsync(GetBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified BackendService resource.

Parameters
Name Description
request GetBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallBackendService

The call object.

GetHealth(GetHealthBackendServiceRequest, CallOptions)

public virtual BackendServiceGroupHealth GetHealth(GetHealthBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request GetHealthBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
BackendServiceGroupHealth

The response received from the server.

GetHealth(GetHealthBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request GetHealthBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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
BackendServiceGroupHealth

The response received from the server.

GetHealthAsync(GetHealthBackendServiceRequest, CallOptions)

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

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

Parameters
Name Description
request GetHealthBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallBackendServiceGroupHealth

The call object.

GetHealthAsync(GetHealthBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request GetHealthBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallBackendServiceGroupHealth

The call object.

GetIamPolicy(GetIamPolicyBackendServiceRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request GetIamPolicyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyBackendServiceRequest 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
Name Description
request GetIamPolicyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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
Policy

The response received from the server.

GetIamPolicyAsync(GetIamPolicyBackendServiceRequest, CallOptions)

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

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

Parameters
Name Description
request GetIamPolicyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPolicy

The call object.

GetIamPolicyAsync(GetIamPolicyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyBackendServiceRequest 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
Name Description
request GetIamPolicyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallPolicy

The call object.

Insert(InsertBackendServiceRequest, CallOptions)

public virtual Operation Insert(InsertBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request InsertBackendServiceRequest

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

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

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

Parameters
Name Description
request InsertBackendServiceRequest

The request to send to the server.

headers Metadata

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

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

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

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

Parameters
Name Description
request InsertBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request InsertBackendServiceRequest

The request to send to the server.

headers Metadata

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

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

public virtual BackendServiceList List(ListBackendServicesRequest request, CallOptions options)

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

Parameters
Name Description
request ListBackendServicesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
BackendServiceList

The response received from the server.

List(ListBackendServicesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request ListBackendServicesRequest

The request to send to the server.

headers Metadata

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

deadline 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
BackendServiceList

The response received from the server.

ListAsync(ListBackendServicesRequest, CallOptions)

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

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

Parameters
Name Description
request ListBackendServicesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallBackendServiceList

The call object.

ListAsync(ListBackendServicesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request ListBackendServicesRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallBackendServiceList

The call object.

ListUsable(ListUsableBackendServicesRequest, CallOptions)

public virtual BackendServiceListUsable ListUsable(ListUsableBackendServicesRequest request, CallOptions options)

Retrieves an aggregated list of all usable backend services in the specified project.

Parameters
Name Description
request ListUsableBackendServicesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
BackendServiceListUsable

The response received from the server.

ListUsable(ListUsableBackendServicesRequest, Metadata, DateTime?, CancellationToken)

public virtual BackendServiceListUsable ListUsable(ListUsableBackendServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an aggregated list of all usable backend services in the specified project.

Parameters
Name Description
request ListUsableBackendServicesRequest

The request to send to the server.

headers Metadata

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

deadline 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
BackendServiceListUsable

The response received from the server.

ListUsableAsync(ListUsableBackendServicesRequest, CallOptions)

public virtual AsyncUnaryCall<BackendServiceListUsable> ListUsableAsync(ListUsableBackendServicesRequest request, CallOptions options)

Retrieves an aggregated list of all usable backend services in the specified project.

Parameters
Name Description
request ListUsableBackendServicesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallBackendServiceListUsable

The call object.

ListUsableAsync(ListUsableBackendServicesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BackendServiceListUsable> ListUsableAsync(ListUsableBackendServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an aggregated list of all usable backend services in the specified project.

Parameters
Name Description
request ListUsableBackendServicesRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallBackendServiceListUsable

The call object.

NewInstance(ClientBaseConfiguration)

protected override BackendServices.BackendServicesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
BackendServicesBackendServicesClient
Overrides

Patch(PatchBackendServiceRequest, CallOptions)

public virtual Operation Patch(PatchBackendServiceRequest request, CallOptions options)

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
Name Description
request PatchBackendServiceRequest

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

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

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
Name Description
request PatchBackendServiceRequest

The request to send to the server.

headers Metadata

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

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

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

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
Name Description
request PatchBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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
Name Description
request PatchBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendServiceRequest, CallOptions)

public virtual Operation SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendServiceRequest request, CallOptions options)

Sets the edge security policy for the specified backend service.

Parameters
Name Description
request SetEdgeSecurityPolicyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Sets the edge security policy for the specified backend service.

Parameters
Name Description
request SetEdgeSecurityPolicyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

SetEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendServiceRequest request, CallOptions options)

Sets the edge security policy for the specified backend service.

Parameters
Name Description
request SetEdgeSecurityPolicyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Sets the edge security policy for the specified backend service.

Parameters
Name Description
request SetEdgeSecurityPolicyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

SetIamPolicy(SetIamPolicyBackendServiceRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request SetIamPolicyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request SetIamPolicyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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
Policy

The response received from the server.

SetIamPolicyAsync(SetIamPolicyBackendServiceRequest, CallOptions)

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

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

Parameters
Name Description
request SetIamPolicyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPolicy

The call object.

SetIamPolicyAsync(SetIamPolicyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request SetIamPolicyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallPolicy

The call object.

SetSecurityPolicy(SetSecurityPolicyBackendServiceRequest, CallOptions)

public virtual Operation SetSecurityPolicy(SetSecurityPolicyBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request SetSecurityPolicyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

SetSecurityPolicy(SetSecurityPolicyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request SetSecurityPolicyBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

SetSecurityPolicyAsync(SetSecurityPolicyBackendServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetSecurityPolicyAsync(SetSecurityPolicyBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request SetSecurityPolicyBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetSecurityPolicyAsync(SetSecurityPolicyBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request SetSecurityPolicyBackendServiceRequest

The request to send to the server.

headers Metadata

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

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

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsBackendServiceRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsBackendServiceRequest

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

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsBackendServiceRequest

The request to send to the server.

headers Metadata

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

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

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallTestPermissionsResponse

The call object.

TestIamPermissionsAsync(TestIamPermissionsBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

Update(UpdateBackendServiceRequest, CallOptions)

public virtual Operation Update(UpdateBackendServiceRequest request, CallOptions options)

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

Parameters
Name Description
request UpdateBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Update(UpdateBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request UpdateBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.

UpdateAsync(UpdateBackendServiceRequest, CallOptions)

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

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

Parameters
Name Description
request UpdateBackendServiceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateAsync(UpdateBackendServiceRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request UpdateBackendServiceRequest

The request to send to the server.

headers Metadata

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

deadline 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.