Compute V1 Client - Class BackendServicesClient (1.22.0)

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.

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.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

addSignedUrlKey

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

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\AddSignedUrlKeyBackendServiceRequest;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\SignedUrlKey;
use Google\Rpc\Status;

/**
 * @param string $backendService Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
 * @param string $project        Project ID for this request.
 */
function add_signed_url_key_sample(string $backendService, string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $signedUrlKeyResource = new SignedUrlKey();
    $request = (new AddSignedUrlKeyBackendServiceRequest())
        ->setBackendService($backendService)
        ->setProject($project)
        ->setSignedUrlKeyResource($signedUrlKeyResource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $backendServicesClient->addSignedUrlKey($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $backendService = '[BACKEND_SERVICE]';
    $project = '[PROJECT]';

    add_signed_url_key_sample($backendService, $project);
}

aggregatedList

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.

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListBackendServicesRequest;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;

/**
 * @param string $project Name of the project scoping this request.
 */
function aggregated_list_sample(string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $request = (new AggregatedListBackendServicesRequest())
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $backendServicesClient->aggregatedList($request);

        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';

    aggregated_list_sample($project);
}

delete

Deletes the specified BackendService resource.

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\DeleteBackendServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $backendService Name of the BackendService resource to delete.
 * @param string $project        Project ID for this request.
 */
function delete_sample(string $backendService, string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $request = (new DeleteBackendServiceRequest())
        ->setBackendService($backendService)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $backendServicesClient->delete($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $backendService = '[BACKEND_SERVICE]';
    $project = '[PROJECT]';

    delete_sample($backendService, $project);
}

deleteSignedUrlKey

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

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\DeleteSignedUrlKeyBackendServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $backendService Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
 * @param string $keyName        The name of the Signed URL Key to delete.
 * @param string $project        Project ID for this request.
 */
function delete_signed_url_key_sample(
    string $backendService,
    string $keyName,
    string $project
): void {
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $request = (new DeleteSignedUrlKeyBackendServiceRequest())
        ->setBackendService($backendService)
        ->setKeyName($keyName)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $backendServicesClient->deleteSignedUrlKey($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $backendService = '[BACKEND_SERVICE]';
    $keyName = '[KEY_NAME]';
    $project = '[PROJECT]';

    delete_signed_url_key_sample($backendService, $keyName, $project);
}

get

Returns the specified BackendService resource.

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\BackendService;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\GetBackendServiceRequest;

/**
 * @param string $backendService Name of the BackendService resource to return.
 * @param string $project        Project ID for this request.
 */
function get_sample(string $backendService, string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $request = (new GetBackendServiceRequest())
        ->setBackendService($backendService)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var BackendService $response */
        $response = $backendServicesClient->get($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $backendService = '[BACKEND_SERVICE]';
    $project = '[PROJECT]';

    get_sample($backendService, $project);
}

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 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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\BackendServiceGroupHealth;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\GetHealthBackendServiceRequest;
use Google\Cloud\Compute\V1\ResourceGroupReference;

/**
 * @param string $backendService Name of the BackendService resource to which the queried instance belongs.
 * @param string $project
 */
function get_health_sample(string $backendService, string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $resourceGroupReferenceResource = new ResourceGroupReference();
    $request = (new GetHealthBackendServiceRequest())
        ->setBackendService($backendService)
        ->setProject($project)
        ->setResourceGroupReferenceResource($resourceGroupReferenceResource);

    // Call the API and handle any network failures.
    try {
        /** @var BackendServiceGroupHealth $response */
        $response = $backendServicesClient->getHealth($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $backendService = '[BACKEND_SERVICE]';
    $project = '[PROJECT]';

    get_health_sample($backendService, $project);
}

getIamPolicy

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

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\GetIamPolicyBackendServiceRequest;
use Google\Cloud\Compute\V1\Policy;

/**
 * @param string $project  Project ID for this request.
 * @param string $resource Name or id of the resource for this request.
 */
function get_iam_policy_sample(string $project, string $resource): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $request = (new GetIamPolicyBackendServiceRequest())
        ->setProject($project)
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $backendServicesClient->getIamPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';
    $resource = '[RESOURCE]';

    get_iam_policy_sample($project, $resource);
}

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 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\BackendService;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\InsertBackendServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $project Project ID for this request.
 */
function insert_sample(string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $backendServiceResource = new BackendService();
    $request = (new InsertBackendServiceRequest())
        ->setBackendServiceResource($backendServiceResource)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $backendServicesClient->insert($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';

    insert_sample($project);
}

list

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

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\ListBackendServicesRequest;

/**
 * @param string $project Project ID for this request.
 */
function list_sample(string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $request = (new ListBackendServicesRequest())
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $backendServicesClient->list($request);

        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';

    list_sample($project);
}

listUsable

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

The async variant is BackendServicesClient::listUsableAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListUsableBackendServicesRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\ListUsableBackendServicesRequest;

/**
 * @param string $project Project ID for this request.
 */
function list_usable_sample(string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $request = (new ListUsableBackendServicesRequest())
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $backendServicesClient->listUsable($request);

        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';

    list_usable_sample($project);
}

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 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\BackendService;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\PatchBackendServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $backendService Name of the BackendService resource to patch.
 * @param string $project        Project ID for this request.
 */
function patch_sample(string $backendService, string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $backendServiceResource = new BackendService();
    $request = (new PatchBackendServiceRequest())
        ->setBackendService($backendService)
        ->setBackendServiceResource($backendServiceResource)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $backendServicesClient->patch($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $backendService = '[BACKEND_SERVICE]';
    $project = '[PROJECT]';

    patch_sample($backendService, $project);
}

setEdgeSecurityPolicy

Sets the edge security policy for the specified backend service.

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\SecurityPolicyReference;
use Google\Cloud\Compute\V1\SetEdgeSecurityPolicyBackendServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $backendService Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.
 * @param string $project        Project ID for this request.
 */
function set_edge_security_policy_sample(string $backendService, string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $securityPolicyReferenceResource = new SecurityPolicyReference();
    $request = (new SetEdgeSecurityPolicyBackendServiceRequest())
        ->setBackendService($backendService)
        ->setProject($project)
        ->setSecurityPolicyReferenceResource($securityPolicyReferenceResource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $backendServicesClient->setEdgeSecurityPolicy($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $backendService = '[BACKEND_SERVICE]';
    $project = '[PROJECT]';

    set_edge_security_policy_sample($backendService, $project);
}

setIamPolicy

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

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\GlobalSetPolicyRequest;
use Google\Cloud\Compute\V1\Policy;
use Google\Cloud\Compute\V1\SetIamPolicyBackendServiceRequest;

/**
 * @param string $project  Project ID for this request.
 * @param string $resource Name or id of the resource for this request.
 */
function set_iam_policy_sample(string $project, string $resource): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $globalSetPolicyRequestResource = new GlobalSetPolicyRequest();
    $request = (new SetIamPolicyBackendServiceRequest())
        ->setGlobalSetPolicyRequestResource($globalSetPolicyRequestResource)
        ->setProject($project)
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $backendServicesClient->setIamPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';
    $resource = '[RESOURCE]';

    set_iam_policy_sample($project, $resource);
}

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 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\SecurityPolicyReference;
use Google\Cloud\Compute\V1\SetSecurityPolicyBackendServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $backendService Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
 * @param string $project        Project ID for this request.
 */
function set_security_policy_sample(string $backendService, string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $securityPolicyReferenceResource = new SecurityPolicyReference();
    $request = (new SetSecurityPolicyBackendServiceRequest())
        ->setBackendService($backendService)
        ->setProject($project)
        ->setSecurityPolicyReferenceResource($securityPolicyReferenceResource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $backendServicesClient->setSecurityPolicy($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $backendService = '[BACKEND_SERVICE]';
    $project = '[PROJECT]';

    set_security_policy_sample($backendService, $project);
}

testIamPermissions

Returns permissions that a caller has on the specified resource.

The async variant is BackendServicesClient::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\TestIamPermissionsBackendServiceRequest` 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\TestPermissionsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\TestIamPermissionsBackendServiceRequest;
use Google\Cloud\Compute\V1\TestPermissionsRequest;
use Google\Cloud\Compute\V1\TestPermissionsResponse;

/**
 * @param string $project  Project ID for this request.
 * @param string $resource Name or id of the resource for this request.
 */
function test_iam_permissions_sample(string $project, string $resource): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $testPermissionsRequestResource = new TestPermissionsRequest();
    $request = (new TestIamPermissionsBackendServiceRequest())
        ->setProject($project)
        ->setResource($resource)
        ->setTestPermissionsRequestResource($testPermissionsRequestResource);

    // Call the API and handle any network failures.
    try {
        /** @var TestPermissionsResponse $response */
        $response = $backendServicesClient->testIamPermissions($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';
    $resource = '[RESOURCE]';

    test_iam_permissions_sample($project, $resource);
}

update

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

The async variant is 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\BackendService;
use Google\Cloud\Compute\V1\Client\BackendServicesClient;
use Google\Cloud\Compute\V1\UpdateBackendServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $backendService Name of the BackendService resource to update.
 * @param string $project        Project ID for this request.
 */
function update_sample(string $backendService, string $project): void
{
    // Create a client.
    $backendServicesClient = new BackendServicesClient();

    // Prepare the request message.
    $backendServiceResource = new BackendService();
    $request = (new UpdateBackendServiceRequest())
        ->setBackendService($backendService)
        ->setBackendServiceResource($backendServiceResource)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $backendServicesClient->update($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $backendService = '[BACKEND_SERVICE]';
    $project = '[PROJECT]';

    update_sample($backendService, $project);
}

addSignedUrlKeyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\AddSignedUrlKeyBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

aggregatedListAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\AggregatedListBackendServicesRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

deleteAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

deleteSignedUrlKeyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteSignedUrlKeyBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\BackendService>`

getHealthAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetHealthBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\BackendServiceGroupHealth>`

getIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetIamPolicyBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy>`

insertAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\InsertBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

listAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListBackendServicesRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

listUsableAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListUsableBackendServicesRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

patchAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\PatchBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

setEdgeSecurityPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\SetEdgeSecurityPolicyBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

setIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\SetIamPolicyBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy>`

setSecurityPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\SetSecurityPolicyBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

testIamPermissionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\TestIamPermissionsBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TestPermissionsResponse>`

updateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\UpdateBackendServiceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

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`