class BackendServices extends Resource (View source)

The "backendServices" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $backendServices = $computeService->backendServices;

Methods

addSignedUrlKey(string $project, string $backendService, SignedUrlKey $postBody, array $optParams = [])

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

aggregatedList(string $project, array $optParams = [])

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.

delete(string $project, string $backendService, array $optParams = [])

Deletes the specified BackendService resource. (backendServices.delete)

deleteSignedUrlKey(string $project, string $backendService, string $keyName, array $optParams = [])

Deletes a key for validating requests with signed URLs for this backend service. (backendServices.deleteSignedUrlKey)

get(string $project, string $backendService, array $optParams = [])

Returns the specified BackendService resource. (backendServices.get)

getHealth(string $project, string $backendService, ResourceGroupReference $postBody, array $optParams = [])

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

getIamPolicy(string $project, string $resource, array $optParams = [])

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

insert(string $project, BackendService $postBody, array $optParams = [])

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

listBackendServices(string $project, array $optParams = [])

Retrieves the list of BackendService resources available to the specified project. (backendServices.listBackendServices)

listUsable(string $project, array $optParams = [])

Retrieves an aggregated list of all usable backend services in the specified project. (backendServices.listUsable)

patch(string $project, string $backendService, BackendService $postBody, array $optParams = [])

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. (backendServices.patch)

setEdgeSecurityPolicy(string $project, string $backendService, SecurityPolicyReference $postBody, array $optParams = [])

Sets the edge security policy for the specified backend service.

setIamPolicy(string $project, string $resource, GlobalSetPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. (backendServices.setIamPolicy)

setSecurityPolicy(string $project, string $backendService, SecurityPolicyReference $postBody, array $optParams = [])

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

testIamPermissions(string $project, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

update(string $project, string $backendService, BackendService $postBody, array $optParams = [])

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

Details

Operation addSignedUrlKey(string $project, string $backendService, SignedUrlKey $postBody, array $optParams = [])

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

(backendServices.addSignedUrlKey)

Parameters

string $project

Project ID for this request.

string $backendService

Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.

SignedUrlKey $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

BackendServiceAggregatedList aggregatedList(string $project, array $optParams = [])

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.

(backendServices.aggregatedList)

Parameters

string $project

Name of the project scoping this request.

array $optParams

Optional parameters.

Return Value

BackendServiceAggregatedList

Exceptions

Exception

Operation delete(string $project, string $backendService, array $optParams = [])

Deletes the specified BackendService resource. (backendServices.delete)

Parameters

string $project

Project ID for this request.

string $backendService

Name of the BackendService resource to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation deleteSignedUrlKey(string $project, string $backendService, string $keyName, array $optParams = [])

Deletes a key for validating requests with signed URLs for this backend service. (backendServices.deleteSignedUrlKey)

Parameters

string $project

Project ID for this request.

string $backendService

Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.

string $keyName

The name of the Signed URL Key to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

BackendService get(string $project, string $backendService, array $optParams = [])

Returns the specified BackendService resource. (backendServices.get)

Parameters

string $project

Project ID for this request.

string $backendService

Name of the BackendService resource to return.

array $optParams

Optional parameters.

Return Value

BackendService

Exceptions

Exception

BackendServiceGroupHealth getHealth(string $project, string $backendService, ResourceGroupReference $postBody, array $optParams = [])

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

Parameters

string $project
string $backendService

Name of the BackendService resource to which the queried instance belongs.

ResourceGroupReference $postBody
array $optParams

Optional parameters.

Return Value

BackendServiceGroupHealth

Exceptions

Exception

Policy getIamPolicy(string $project, string $resource, array $optParams = [])

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

Parameters

string $project

Project ID for this request.

string $resource

Name or id of the resource for this request.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

Operation insert(string $project, BackendService $postBody, array $optParams = [])

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

Parameters

string $project

Project ID for this request.

BackendService $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

BackendServiceList listBackendServices(string $project, array $optParams = [])

Retrieves the list of BackendService resources available to the specified project. (backendServices.listBackendServices)

Parameters

string $project

Project ID for this request.

array $optParams

Optional parameters.

Return Value

BackendServiceList

Exceptions

Exception

BackendServiceListUsable listUsable(string $project, array $optParams = [])

Retrieves an aggregated list of all usable backend services in the specified project. (backendServices.listUsable)

Parameters

string $project

Project ID for this request.

array $optParams

Optional parameters.

Return Value

BackendServiceListUsable

Exceptions

Exception

Operation patch(string $project, string $backendService, BackendService $postBody, array $optParams = [])

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. (backendServices.patch)

Parameters

string $project

Project ID for this request.

string $backendService

Name of the BackendService resource to patch.

BackendService $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation setEdgeSecurityPolicy(string $project, string $backendService, SecurityPolicyReference $postBody, array $optParams = [])

Sets the edge security policy for the specified backend service.

(backendServices.setEdgeSecurityPolicy)

Parameters

string $project

Project ID for this request.

string $backendService

Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.

SecurityPolicyReference $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $project, string $resource, GlobalSetPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. (backendServices.setIamPolicy)

Parameters

string $project

Project ID for this request.

string $resource

Name or id of the resource for this request.

GlobalSetPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

Operation setSecurityPolicy(string $project, string $backendService, SecurityPolicyReference $postBody, array $optParams = [])

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

Parameters

string $project

Project ID for this request.

string $backendService

Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.

SecurityPolicyReference $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

TestPermissionsResponse testIamPermissions(string $project, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

(backendServices.testIamPermissions)

Parameters

string $project

Project ID for this request.

string $resource

Name or id of the resource for this request.

TestPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestPermissionsResponse

Exceptions

Exception

Operation update(string $project, string $backendService, BackendService $postBody, array $optParams = [])

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

(backendServices.update)

Parameters

string $project

Project ID for this request.

string $backendService

Name of the BackendService resource to update.

BackendService $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception