Compute Engine v1 API - Class BackendServices.BackendServicesBase (2.16.0)

Version 2.16.0

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(BackendServices), "BindService")]
public abstract class BackendServices.BackendServicesBase

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

Base class for server-side implementations of BackendServices

Inheritance

object > BackendServices.BackendServicesBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Methods

AddSignedUrlKey(AddSignedUrlKeyBackendServiceRequest, ServerCallContext)

public virtual Task<Operation> AddSignedUrlKey(AddSignedUrlKeyBackendServiceRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	AddSignedUrlKeyBackendServiceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

AggregatedList(AggregatedListBackendServicesRequest, ServerCallContext)

public virtual Task<BackendServiceAggregatedList> AggregatedList(AggregatedListBackendServicesRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackendServiceAggregatedList	The response to send back to the client (wrapped by a task).

Delete(DeleteBackendServiceRequest, ServerCallContext)

public virtual Task<Operation> Delete(DeleteBackendServiceRequest request, ServerCallContext context)

Deletes the specified BackendService resource.

Parameters
Name	Description
request	DeleteBackendServiceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteSignedUrlKey(DeleteSignedUrlKeyBackendServiceRequest, ServerCallContext)

public virtual Task<Operation> DeleteSignedUrlKey(DeleteSignedUrlKeyBackendServiceRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DeleteSignedUrlKeyBackendServiceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

Get(GetBackendServiceRequest, ServerCallContext)

public virtual Task<BackendService> Get(GetBackendServiceRequest request, ServerCallContext context)

Returns the specified BackendService resource.

Parameters
Name	Description
request	GetBackendServiceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackendService	The response to send back to the client (wrapped by a task).

GetHealth(GetHealthBackendServiceRequest, ServerCallContext)

public virtual Task<BackendServiceGroupHealth> GetHealth(GetHealthBackendServiceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackendServiceGroupHealth	The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyBackendServiceRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyBackendServiceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPolicy	The response to send back to the client (wrapped by a task).

Insert(InsertBackendServiceRequest, ServerCallContext)

public virtual Task<Operation> Insert(InsertBackendServiceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

List(ListBackendServicesRequest, ServerCallContext)

public virtual Task<BackendServiceList> List(ListBackendServicesRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListBackendServicesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackendServiceList	The response to send back to the client (wrapped by a task).

ListUsable(ListUsableBackendServicesRequest, ServerCallContext)

public virtual Task<BackendServiceListUsable> ListUsable(ListUsableBackendServicesRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListUsableBackendServicesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackendServiceListUsable	The response to send back to the client (wrapped by a task).

Patch(PatchBackendServiceRequest, ServerCallContext)

public virtual Task<Operation> Patch(PatchBackendServiceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendServiceRequest, ServerCallContext)

public virtual Task<Operation> SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendServiceRequest request, ServerCallContext context)

Sets the edge security policy for the specified backend service.

Parameters
Name	Description
request	SetEdgeSecurityPolicyBackendServiceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyBackendServiceRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyBackendServiceRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	SetIamPolicyBackendServiceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPolicy	The response to send back to the client (wrapped by a task).

SetSecurityPolicy(SetSecurityPolicyBackendServiceRequest, ServerCallContext)

public virtual Task<Operation> SetSecurityPolicy(SetSecurityPolicyBackendServiceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsBackendServiceRequest, ServerCallContext)

public virtual Task<TestPermissionsResponse> TestIamPermissions(TestIamPermissionsBackendServiceRequest request, ServerCallContext context)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsBackendServiceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTestPermissionsResponse	The response to send back to the client (wrapped by a task).

Update(UpdateBackendServiceRequest, ServerCallContext)

public virtual Task<Operation> Update(UpdateBackendServiceRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).