Compute V1 Client - Class RegionBackendServicesClient (1.22.0)

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

Service Description: The RegionBackendServices 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

delete

Deletes the specified regional BackendService resource.

The async variant is RegionBackendServicesClient::deleteAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\DeleteRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\DeleteRegionBackendServiceRequest;
use Google\Rpc\Status;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';

    delete_sample($backendService, $project, $region);
}

get

Returns the specified regional BackendService resource.

The async variant is RegionBackendServicesClient::getAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\GetRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\GetRegionBackendServiceRequest;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var BackendService $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';

    get_sample($backendService, $project, $region);
}

getHealth

Gets the most recent health check results for this regional BackendService.

The async variant is RegionBackendServicesClient::getHealthAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\GetHealthRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\GetHealthRegionBackendServiceRequest;
use Google\Cloud\Compute\V1\ResourceGroupReference;

/**
 * @param string $backendService Name of the BackendService resource for which to get health.
 * @param string $project
 * @param string $region         Name of the region scoping this request.
 */
function get_health_sample(string $backendService, string $project, string $region): void
{
    // Create a client.
    $regionBackendServicesClient = new RegionBackendServicesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BackendServiceGroupHealth $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';

    get_health_sample($backendService, $project, $region);
}

getIamPolicy

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

The async variant is RegionBackendServicesClient::getIamPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\GetIamPolicyRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\GetIamPolicyRegionBackendServiceRequest;
use Google\Cloud\Compute\V1\Policy;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';
    $resource = '[RESOURCE]';

    get_iam_policy_sample($project, $region, $resource);
}

insert

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

The async variant is RegionBackendServicesClient::insertAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\InsertRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\InsertRegionBackendServiceRequest;
use Google\Rpc\Status;

/**
 * @param string $project Project ID for this request.
 * @param string $region  Name of the region scoping this request.
 */
function insert_sample(string $project, string $region): void
{
    // Create a client.
    $regionBackendServicesClient = new RegionBackendServicesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';

    insert_sample($project, $region);
}

list

Retrieves the list of regional BackendService resources available to the specified project in the given region.

The async variant is RegionBackendServicesClient::listAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\ListRegionBackendServicesRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\ListRegionBackendServicesRequest;

/**
 * @param string $project Project ID for this request.
 * @param string $region  Name of the region scoping this request.
 */
function list_sample(string $project, string $region): void
{
    // Create a client.
    $regionBackendServicesClient = new RegionBackendServicesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';

    list_sample($project, $region);
}

listUsable

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

The async variant is RegionBackendServicesClient::listUsableAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\ListUsableRegionBackendServicesRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\ListUsableRegionBackendServicesRequest;

/**
 * @param string $project Project ID for this request.
 * @param string $region  Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.
 */
function list_usable_sample(string $project, string $region): void
{
    // Create a client.
    $regionBackendServicesClient = new RegionBackendServicesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';

    list_usable_sample($project, $region);
}

patch

Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

The async variant is RegionBackendServicesClient::patchAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\PatchRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\PatchRegionBackendServiceRequest;
use Google\Rpc\Status;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';

    patch_sample($backendService, $project, $region);
}

setIamPolicy

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

The async variant is RegionBackendServicesClient::setIamPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\SetIamPolicyRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\Policy;
use Google\Cloud\Compute\V1\RegionSetPolicyRequest;
use Google\Cloud\Compute\V1\SetIamPolicyRegionBackendServiceRequest;

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

    // Prepare the request message.
    $regionSetPolicyRequestResource = new RegionSetPolicyRequest();
    $request = (new SetIamPolicyRegionBackendServiceRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setRegionSetPolicyRequestResource($regionSetPolicyRequestResource)
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';
    $resource = '[RESOURCE]';

    set_iam_policy_sample($project, $region, $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 RegionBackendServicesClient::setSecurityPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\SetSecurityPolicyRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\SecurityPolicyReference;
use Google\Cloud\Compute\V1\SetSecurityPolicyRegionBackendServiceRequest;
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.
 * @param string $region         Name of the region scoping this request.
 */
function set_security_policy_sample(string $backendService, string $project, string $region): void
{
    // Create a client.
    $regionBackendServicesClient = new RegionBackendServicesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';

    set_security_policy_sample($backendService, $project, $region);
}

testIamPermissions

Returns permissions that a caller has on the specified resource.

The async variant is RegionBackendServicesClient::testIamPermissionsAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\TestIamPermissionsRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\TestIamPermissionsRegionBackendServiceRequest;
use Google\Cloud\Compute\V1\TestPermissionsRequest;
use Google\Cloud\Compute\V1\TestPermissionsResponse;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var TestPermissionsResponse $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';
    $resource = '[RESOURCE]';

    test_iam_permissions_sample($project, $region, $resource);
}

update

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

The async variant is RegionBackendServicesClient::updateAsync() .

Parameters
Name Description
request Google\Cloud\Compute\V1\UpdateRegionBackendServiceRequest

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\RegionBackendServicesClient;
use Google\Cloud\Compute\V1\UpdateRegionBackendServiceRequest;
use Google\Rpc\Status;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $regionBackendServicesClient->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]';
    $region = '[REGION]';

    update_sample($backendService, $project, $region);
}

deleteAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\DeleteRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\GetRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\BackendService>

getHealthAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\GetHealthRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\BackendServiceGroupHealth>

getIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\GetIamPolicyRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy>

insertAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\InsertRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

listAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\ListRegionBackendServicesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listUsableAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\ListUsableRegionBackendServicesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

patchAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\PatchRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

setIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\SetIamPolicyRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy>

setSecurityPolicyAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\SetSecurityPolicyRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

testIamPermissionsAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\TestIamPermissionsRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TestPermissionsResponse>

updateAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\UpdateRegionBackendServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getOperationsClient

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

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

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