# Compute V1 Client - Class RegionCompositeHealthChecksClient (2.10.0)

2.10.0 (latest) 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.1 2.0.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.0 1.22.1 1.21.0 1.20.0 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 Reference documentation and code samples for the Compute V1 Client class RegionCompositeHealthChecksClient.

Service Description: The RegionCompositeHealthChecks 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|https://docs.cloud.google.com/php/docs/reference/gax/latest/Options.ClientOptions.html` 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` | `https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html|https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html` This option should only be used with a pre-constructed [Google\\Auth\\FetchAuthTokenInterface](https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html) or [Google\\ApiCore\\CredentialsWrapper](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html) object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important** : If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Compute\V1\RegionCompositeHealthChecksClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new RegionCompositeHealthChecksClient(['credentials' => $creds]);` <https://cloud.google.com/docs/authentication/external/externally-sourced-credentials> |
| `↳ 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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html#_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|https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html` 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](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html) 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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.RestTransport.html#_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|Psr\Log\LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
| `↳ universeDomain` | `string` The service domain for the client. Defaults to 'googleapis.com'. |

### aggregatedList

Retrieves the list of all CompositeHealthCheck resources (all
regional) available to the specified project.

To prevent failure, it is recommended that you set the
`returnPartialSuccess` parameter to `true`.

The async variant is
[RegionCompositeHealthChecksClient::aggregatedListAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.Client.RegionCompositeHealthChecksClient#_Google_Cloud_Compute_V1_Client_RegionCompositeHealthChecksClient__aggregatedListAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.AggregatedListRegionCompositeHealthChecksRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\Compute\V1\AggregatedListRegionCompositeHealthChecksRequest;
    use Google\Cloud\Compute\V1\Client\RegionCompositeHealthChecksClient;

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

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

        // Call the API and handle any network failures.
        try {
            /** @var PagedListResponse $response */
            $response = $regionCompositeHealthChecksClient->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 CompositeHealthCheck in the given region

The async variant is [RegionCompositeHealthChecksClient::deleteAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.Client.RegionCompositeHealthChecksClient#_Google_Cloud_Compute_V1_Client_RegionCompositeHealthChecksClient__deleteAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.DeleteRegionCompositeHealthCheckRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\Compute\V1\Client\RegionCompositeHealthChecksClient;
    use Google\Cloud\Compute\V1\DeleteRegionCompositeHealthCheckRequest;
    use Google\Rpc\Status;

    /**
     * @param string $compositeHealthCheck Name of the CompositeHealthCheck 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 $compositeHealthCheck, string $project, string $region): void
    {
        // Create a client.
        $regionCompositeHealthChecksClient = new RegionCompositeHealthChecksClient();

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

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

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

### get

Returns the specified CompositeHealthCheck resource in the given region.

The async variant is [RegionCompositeHealthChecksClient::getAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.Client.RegionCompositeHealthChecksClient#_Google_Cloud_Compute_V1_Client_RegionCompositeHealthChecksClient__getAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.GetRegionCompositeHealthCheckRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.CompositeHealthCheck` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\Compute\V1\Client\RegionCompositeHealthChecksClient;
    use Google\Cloud\Compute\V1\CompositeHealthCheck;
    use Google\Cloud\Compute\V1\GetRegionCompositeHealthCheckRequest;

    /**
     * @param string $compositeHealthCheck Name of the CompositeHealthCheck 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 $compositeHealthCheck, string $project, string $region): void
    {
        // Create a client.
        $regionCompositeHealthChecksClient = new RegionCompositeHealthChecksClient();

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

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

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

### getHealth

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

The async variant is [RegionCompositeHealthChecksClient::getHealthAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.Client.RegionCompositeHealthChecksClient#_Google_Cloud_Compute_V1_Client_RegionCompositeHealthChecksClient__getHealthAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.GetHealthRegionCompositeHealthCheckRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.CompositeHealthCheckHealth` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\Compute\V1\Client\RegionCompositeHealthChecksClient;
    use Google\Cloud\Compute\V1\CompositeHealthCheckHealth;
    use Google\Cloud\Compute\V1\GetHealthRegionCompositeHealthCheckRequest;

    /**
     * @param string $compositeHealthCheck Name of the CompositeHealthCheck resource to get health for.
     * @param string $project              Name of the project scoping this request.
     * @param string $region               Name of the region scoping this request.
     */
    function get_health_sample(string $compositeHealthCheck, string $project, string $region): void
    {
        // Create a client.
        $regionCompositeHealthChecksClient = new RegionCompositeHealthChecksClient();

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

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

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

### insert

Create a CompositeHealthCheck in the specified project in the given region
using the parameters that are included in the request.

The async variant is [RegionCompositeHealthChecksClient::insertAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.Client.RegionCompositeHealthChecksClient#_Google_Cloud_Compute_V1_Client_RegionCompositeHealthChecksClient__insertAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.InsertRegionCompositeHealthCheckRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\Compute\V1\Client\RegionCompositeHealthChecksClient;
    use Google\Cloud\Compute\V1\CompositeHealthCheck;
    use Google\Cloud\Compute\V1\InsertRegionCompositeHealthCheckRequest;
    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.
        $regionCompositeHealthChecksClient = new RegionCompositeHealthChecksClient();

        // Prepare the request message.
        $compositeHealthCheckResource = new CompositeHealthCheck();
        $request = (new InsertRegionCompositeHealthCheckRequest())
            ->setCompositeHealthCheckResource($compositeHealthCheckResource)
            ->setProject($project)
            ->setRegion($region);

        // Call the API and handle any network failures.
        try {
            /** @var OperationResponse $response */
            $response = $regionCompositeHealthChecksClient->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

Lists the CompositeHealthChecks for a project in the given region.

The async variant is [RegionCompositeHealthChecksClient::listAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.Client.RegionCompositeHealthChecksClient#_Google_Cloud_Compute_V1_Client_RegionCompositeHealthChecksClient__listAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.ListRegionCompositeHealthChecksRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\Compute\V1\Client\RegionCompositeHealthChecksClient;
    use Google\Cloud\Compute\V1\ListRegionCompositeHealthChecksRequest;

    /**
     * @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.
        $regionCompositeHealthChecksClient = new RegionCompositeHealthChecksClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var PagedListResponse $response */
            $response = $regionCompositeHealthChecksClient->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);
    }

### patch

Updates the specified regional CompositeHealthCheck resource
with the data included in the request. This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules.

The async variant is [RegionCompositeHealthChecksClient::patchAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.Client.RegionCompositeHealthChecksClient#_Google_Cloud_Compute_V1_Client_RegionCompositeHealthChecksClient__patchAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.PatchRegionCompositeHealthCheckRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\Compute\V1\Client\RegionCompositeHealthChecksClient;
    use Google\Cloud\Compute\V1\CompositeHealthCheck;
    use Google\Cloud\Compute\V1\PatchRegionCompositeHealthCheckRequest;
    use Google\Rpc\Status;

    /**
     * @param string $compositeHealthCheck Name of the CompositeHealthCheck to update. The name
     *                                     must be 1-63 characters long, and comply with RFC1035.
     * @param string $project              Project ID for this request.
     * @param string $region               Name of the region scoping this request.
     */
    function patch_sample(string $compositeHealthCheck, string $project, string $region): void
    {
        // Create a client.
        $regionCompositeHealthChecksClient = new RegionCompositeHealthChecksClient();

        // Prepare the request message.
        $compositeHealthCheckResource = new CompositeHealthCheck();
        $request = (new PatchRegionCompositeHealthCheckRequest())
            ->setCompositeHealthCheck($compositeHealthCheck)
            ->setCompositeHealthCheckResource($compositeHealthCheckResource)
            ->setProject($project)
            ->setRegion($region);

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

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

### testIamPermissions

Returns permissions that a caller has on the specified resource.

The async variant is
[RegionCompositeHealthChecksClient::testIamPermissionsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.Client.RegionCompositeHealthChecksClient#_Google_Cloud_Compute_V1_Client_RegionCompositeHealthChecksClient__testIamPermissionsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.TestIamPermissionsRegionCompositeHealthCheckRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.TestPermissionsResponse` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\Compute\V1\Client\RegionCompositeHealthChecksClient;
    use Google\Cloud\Compute\V1\TestIamPermissionsRegionCompositeHealthCheckRequest;
    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.
        $regionCompositeHealthChecksClient = new RegionCompositeHealthChecksClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var TestPermissionsResponse $response */
            $response = $regionCompositeHealthChecksClient->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);
    }

### aggregatedListAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.AggregatedListRegionCompositeHealthChecksRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### deleteAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.DeleteRegionCompositeHealthCheckRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### getAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.GetRegionCompositeHealthCheckRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.CompositeHealthCheck>` |   |

### getHealthAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.GetHealthRegionCompositeHealthCheckRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.CompositeHealthCheckHealth>` |   |

### insertAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.InsertRegionCompositeHealthCheckRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### listAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.ListRegionCompositeHealthChecksRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### patchAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.PatchRegionCompositeHealthCheckRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### testIamPermissionsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.TestIamPermissionsRegionCompositeHealthCheckRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.TestPermissionsResponse>` |   |

### getOperationsClient

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.Client.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** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html` |   |