# Google Cloud Policy Simulator V1 Client - Class SimulatorClient (1.3.4)

1.3.4 (latest) 1.3.3 1.2.0 1.1.1 1.0.3 0.2.5 0.1.1 Reference documentation and code samples for the Google Cloud Policy Simulator V1 Client class SimulatorClient.

Service Description: Policy Simulator API service.

Policy Simulator is a collection of endpoints for creating, running, and
viewing a [Replay](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Replay). A
[Replay](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Replay) is a type of simulation that
lets you see how your principals' access to resources might change if you
changed your IAM policy.

During a [Replay](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Replay), Policy Simulator
re-evaluates, or replays, past access attempts under both the current policy
and your proposed policy, and compares those results to determine how your
principals' access might change under the proposed policy.

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

Many parameters require resource names to be formatted in a particular way. To
assist with these names, this class includes a format method for each type of
name, and additionally a parseName method to extract the individual identifiers
contained within formatted names that are returned by the API.

## Namespace

Google \\ Cloud \\ PolicySimulator \\ 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\PolicySimulator\V1\SimulatorClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new SimulatorClient(['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. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *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 = \[ 'grpc' =\> \[...\], 'rest' =\> \[...\], \]; See the [Google\\ApiCore\\Transport\\GrpcTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.GrpcTransport.html#_Google_ApiCore_Transport_GrpcTransport__build__) and [Google\\ApiCore\\Transport\\RestTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.RestTransport.html#_Google_ApiCore_Transport_RestTransport__build__) methods 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'. |

### createReplay

Creates and starts a [Replay](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Replay) using
the given [ReplayConfig](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.ReplayConfig).

The async variant is [SimulatorClient::createReplayAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Client.SimulatorClient#_Google_Cloud_PolicySimulator_V1_Client_SimulatorClient__createReplayAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.CreateReplayRequest` 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<https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Replay>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\PolicySimulator\V1\Client\SimulatorClient;
    use Google\Cloud\PolicySimulator\V1\CreateReplayRequest;
    use Google\Cloud\PolicySimulator\V1\Replay;
    use Google\Cloud\PolicySimulator\V1\ReplayConfig;
    use Google\Rpc\Status;

    /**
     * @param string $parent The parent resource where this
     *                       [Replay][google.cloud.policysimulator.v1.Replay] will be created. This
     *                       resource must be a project, folder, or organization with a location.
     *
     *                       Example: `projects/my-example-project/locations/global`
     */
    function create_replay_sample(string $parent): void
    {
        // Create a client.
        $simulatorClient = new SimulatorClient();

        // Prepare the request message.
        $replayConfig = new ReplayConfig();
        $replay = (new Replay())
            ->setConfig($replayConfig);
        $request = (new CreateReplayRequest())
            ->setParent($parent)
            ->setReplay($replay);

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

            if ($response->operationSucceeded()) {
                /** @var Replay $result */
                $result = $response->getResult();
                printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
            } 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
    {
        $parent = '[PARENT]';

        create_replay_sample($parent);
    }

### getReplay

Gets the specified [Replay](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Replay). Each
`Replay` is available for at least 7 days.

The async variant is [SimulatorClient::getReplayAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Client.SimulatorClient#_Google_Cloud_PolicySimulator_V1_Client_SimulatorClient__getReplayAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.GetReplayRequest` 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-policysimulator/latest/V1.Replay` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\PolicySimulator\V1\Client\SimulatorClient;
    use Google\Cloud\PolicySimulator\V1\GetReplayRequest;
    use Google\Cloud\PolicySimulator\V1\Replay;

    /**
     * @param string $formattedName The name of the [Replay][google.cloud.policysimulator.v1.Replay]
     *                              to retrieve, in the following format:
     *
     *                              `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`,
     *                              where `{resource-id}` is the ID of the project, folder, or organization
     *                              that owns the `Replay`.
     *
     *                              Example:
     *                              `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
     *                              Please see {@see SimulatorClient::replayName()} for help formatting this field.
     */
    function get_replay_sample(string $formattedName): void
    {
        // Create a client.
        $simulatorClient = new SimulatorClient();

        // Prepare the request message.
        $request = (new GetReplayRequest())
            ->setName($formattedName);

        // Call the API and handle any network failures.
        try {
            /** @var Replay $response */
            $response = $simulatorClient->getReplay($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
    {
        $formattedName = SimulatorClient::replayName('[PROJECT]', '[LOCATION]', '[REPLAY]');

        get_replay_sample($formattedName);
    }

### listReplayResults

Lists the results of running a
[Replay](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Replay).

The async variant is [SimulatorClient::listReplayResultsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.Client.SimulatorClient#_Google_Cloud_PolicySimulator_V1_Client_SimulatorClient__listReplayResultsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.ListReplayResultsRequest` 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\PolicySimulator\V1\Client\SimulatorClient;
    use Google\Cloud\PolicySimulator\V1\ListReplayResultsRequest;
    use Google\Cloud\PolicySimulator\V1\ReplayResult;

    /**
     * @param string $formattedParent The [Replay][google.cloud.policysimulator.v1.Replay] whose
     *                                results are listed, in the following format:
     *
     *                                `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`
     *
     *                                Example:
     *                                `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
     *                                Please see {@see SimulatorClient::replayName()} for help formatting this field.
     */
    function list_replay_results_sample(string $formattedParent): void
    {
        // Create a client.
        $simulatorClient = new SimulatorClient();

        // Prepare the request message.
        $request = (new ListReplayResultsRequest())
            ->setParent($formattedParent);

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

            /** @var ReplayResult $element */
            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
    {
        $formattedParent = SimulatorClient::replayName('[PROJECT]', '[LOCATION]', '[REPLAY]');

        list_replay_results_sample($formattedParent);
    }

### createReplayAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.CreateReplayRequest` |
| `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>` |   |

### getReplayAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.GetReplayRequest` |
| `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-policysimulator/latest/V1.Replay>` |   |

### listReplayResultsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.ListReplayResultsRequest` |
| `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>` |   |

### getOperationsClient

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\LongRunning\Client\OperationsClient` |   |

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

### static::folderLocationReplayName

Formats a string containing the fully-qualified path to represent a
folder_location_replay resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `folder` | `string` |
| `location` | `string` |
| `replay` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted folder_location_replay resource. |

### static::organizationLocationReplayName

Formats a string containing the fully-qualified path to represent a
organization_location_replay resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organization` | `string` |
| `location` | `string` |
| `replay` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted organization_location_replay resource. |

### static::projectLocationReplayName

Formats a string containing the fully-qualified path to represent a
project_location_replay resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `replay` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted project_location_replay resource. |

### static::replayName

Formats a string containing the fully-qualified path to represent a replay
resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `replay` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted replay resource. |

### static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported:
Template: Pattern

- folderLocationReplay: folders/{folder}/locations/{location}/replays/{replay}
- organizationLocationReplay: organizations/{organization}/locations/{location}/replays/{replay}
- projectLocationReplay: projects/{project}/locations/{location}/replays/{replay}
- replay: projects/{project}/locations/{location}/replays/{replay}

The optional $template argument can be supplied to specify a particular pattern,
and must match one of the templates listed above. If no $template argument is
provided, or if the $template argument does not match one of the templates
listed, then parseName will check each of the supported templates, and return
the first match.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `formattedName` | `string` The formatted name string |
| `template` | `?string` Optional name of template to match |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `array` | An associative array from name component IDs to component values. |