Compute V1 Client - Class BackendServicesClient (1.12.1)

Version 1.12.1

• 1.20.0 (latest)
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Compute V1 Client class BackendServicesClient.

Service Description: The BackendServices API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

This class is currently experimental and may be subject to changes. See Google\Cloud\Compute\V1\BackendServicesClient for the stable implementation

Namespace

Google \ Cloud \ Compute \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. At the moment, supports only rest. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

addSignedUrlKey

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::addSignedUrlKeyAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AddSignedUrlKeyBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

aggregatedList

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::aggregatedListAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AggregatedListBackendServicesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

delete

Deletes the specified BackendService resource.

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::deleteAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\DeleteBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteSignedUrlKey

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::deleteSignedUrlKeyAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\DeleteSignedUrlKeyBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

get

Returns the specified BackendService resource.

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::getAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Compute\V1\BackendService

getHealth

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::getHealthAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetHealthBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Compute\V1\BackendServiceGroupHealth

getIamPolicy

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::getIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetIamPolicyBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Compute\V1\Policy

insert

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::insertAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\InsertBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

list

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::listAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\ListBackendServicesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

patch

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.

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::patchAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\PatchBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

setEdgeSecurityPolicy

Sets the edge security policy for the specified backend service.

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::setEdgeSecurityPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetEdgeSecurityPolicyBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

setIamPolicy

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::setIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetIamPolicyBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Compute\V1\Policy

setSecurityPolicy

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::setSecurityPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetSecurityPolicyBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

update

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

The async variant is Google\Cloud\Compute\V1\Client\BackendServicesClient::updateAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\UpdateBackendServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

addSignedUrlKeyAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AddSignedUrlKeyBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

aggregatedListAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AggregatedListBackendServicesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\DeleteBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteSignedUrlKeyAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\DeleteSignedUrlKeyBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getHealthAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetHealthBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetIamPolicyBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

insertAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\InsertBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\ListBackendServicesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

patchAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\PatchBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setEdgeSecurityPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetEdgeSecurityPolicyBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetIamPolicyBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setSecurityPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetSecurityPolicyBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\UpdateBackendServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an GlobalOperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\Cloud\Compute\V1\GlobalOperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse