# Google Cloud Policy Simulator V1 Client - Class OrgPolicyViolationsPreviewServiceClient (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 OrgPolicyViolationsPreviewServiceClient.

Service Description: Violations Preview API service for OrgPolicy.

An
[OrgPolicyViolationsPreview](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.OrgPolicyViolationsPreview)
is a preview of the violations that will exist as soon as a proposed
OrgPolicy change is submitted. To create an
[OrgPolicyViolationsPreview](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.OrgPolicyViolationsPreview),
the API user specifies the changes they wish to make and requests the
generation of a preview via GenerateViolationsPreview. the OrgPolicy
Simulator service then scans the API user's currently existing resources to
determine these resources violate the newly set OrgPolicy.

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\OrgPolicyViolationsPreviewServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new OrgPolicyViolationsPreviewServiceClient(['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'. |

### createOrgPolicyViolationsPreview

CreateOrgPolicyViolationsPreview creates an
[OrgPolicyViolationsPreview](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.OrgPolicyViolationsPreview)
for the proposed changes in the provided
OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy
are specified by this `OrgPolicyOverlay`. The resources to scan are
inferred from these specified changes.

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

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

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\PolicySimulator\V1\Client\OrgPolicyViolationsPreviewServiceClient;
    use Google\Cloud\PolicySimulator\V1\CreateOrgPolicyViolationsPreviewRequest;
    use Google\Cloud\PolicySimulator\V1\OrgPolicyOverlay;
    use Google\Cloud\PolicySimulator\V1\OrgPolicyViolationsPreview;
    use Google\Rpc\Status;

    /**
     * @param string $formattedParent The organization under which this
     *                                [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview]
     *                                will be created.
     *
     *                                Example: `organizations/my-example-org/locations/global`
     *                                Please see {@see OrgPolicyViolationsPreviewServiceClient::organizationLocationName()} for help formatting this field.
     */
    function create_org_policy_violations_preview_sample(string $formattedParent): void
    {
        // Create a client.
        $orgPolicyViolationsPreviewServiceClient = new OrgPolicyViolationsPreviewServiceClient();

        // Prepare the request message.
        $orgPolicyViolationsPreviewOverlay = new OrgPolicyOverlay();
        $orgPolicyViolationsPreview = (new OrgPolicyViolationsPreview())
            ->setOverlay($orgPolicyViolationsPreviewOverlay);
        $request = (new CreateOrgPolicyViolationsPreviewRequest())
            ->setParent($formattedParent)
            ->setOrgPolicyViolationsPreview($orgPolicyViolationsPreview);

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

            if ($response->operationSucceeded()) {
                /** @var OrgPolicyViolationsPreview $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
    {
        $formattedParent = OrgPolicyViolationsPreviewServiceClient::organizationLocationName(
            '[ORGANIZATION]',
            '[LOCATION]'
        );

        create_org_policy_violations_preview_sample($formattedParent);
    }

### getOrgPolicyViolationsPreview

GetOrgPolicyViolationsPreview gets the specified
[OrgPolicyViolationsPreview](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.OrgPolicyViolationsPreview).

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

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

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

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\PolicySimulator\V1\Client\OrgPolicyViolationsPreviewServiceClient;
    use Google\Cloud\PolicySimulator\V1\GetOrgPolicyViolationsPreviewRequest;
    use Google\Cloud\PolicySimulator\V1\OrgPolicyViolationsPreview;

    /**
     * @param string $formattedName The name of the OrgPolicyViolationsPreview to get. Please see
     *                              {@see OrgPolicyViolationsPreviewServiceClient::orgPolicyViolationsPreviewName()} for help formatting this field.
     */
    function get_org_policy_violations_preview_sample(string $formattedName): void
    {
        // Create a client.
        $orgPolicyViolationsPreviewServiceClient = new OrgPolicyViolationsPreviewServiceClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var OrgPolicyViolationsPreview $response */
            $response = $orgPolicyViolationsPreviewServiceClient->getOrgPolicyViolationsPreview($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 = OrgPolicyViolationsPreviewServiceClient::orgPolicyViolationsPreviewName(
            '[ORGANIZATION]',
            '[LOCATION]',
            '[ORG_POLICY_VIOLATIONS_PREVIEW]'
        );

        get_org_policy_violations_preview_sample($formattedName);
    }

### listOrgPolicyViolations

ListOrgPolicyViolations lists the OrgPolicyViolations that are present
in an
[OrgPolicyViolationsPreview](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.OrgPolicyViolationsPreview).

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

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

    /**
     * @param string $formattedParent The OrgPolicyViolationsPreview to get OrgPolicyViolations from.
     *                                Format:
     *                                organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}
     *                                Please see {@see OrgPolicyViolationsPreviewServiceClient::orgPolicyViolationsPreviewName()} for help formatting this field.
     */
    function list_org_policy_violations_sample(string $formattedParent): void
    {
        // Create a client.
        $orgPolicyViolationsPreviewServiceClient = new OrgPolicyViolationsPreviewServiceClient();

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

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

            /** @var OrgPolicyViolation $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 = OrgPolicyViolationsPreviewServiceClient::orgPolicyViolationsPreviewName(
            '[ORGANIZATION]',
            '[LOCATION]',
            '[ORG_POLICY_VIOLATIONS_PREVIEW]'
        );

        list_org_policy_violations_sample($formattedParent);
    }

### listOrgPolicyViolationsPreviews

ListOrgPolicyViolationsPreviews lists each
[OrgPolicyViolationsPreview](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.OrgPolicyViolationsPreview)
in an organization. Each
[OrgPolicyViolationsPreview](https://docs.cloud.google.com/php/docs/reference/cloud-policysimulator/latest/V1.OrgPolicyViolationsPreview)
is available for at least 7 days.

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

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

    /**
     * @param string $formattedParent The parent the violations are scoped to.
     *                                Format:
     *                                `organizations/{organization}/locations/{location}`
     *
     *                                Example: `organizations/my-example-org/locations/global`
     *                                Please see {@see OrgPolicyViolationsPreviewServiceClient::organizationLocationName()} for help formatting this field.
     */
    function list_org_policy_violations_previews_sample(string $formattedParent): void
    {
        // Create a client.
        $orgPolicyViolationsPreviewServiceClient = new OrgPolicyViolationsPreviewServiceClient();

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

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

            /** @var OrgPolicyViolationsPreview $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 = OrgPolicyViolationsPreviewServiceClient::organizationLocationName(
            '[ORGANIZATION]',
            '[LOCATION]'
        );

        list_org_policy_violations_previews_sample($formattedParent);
    }

### createOrgPolicyViolationsPreviewAsync

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

### getOrgPolicyViolationsPreviewAsync

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

### listOrgPolicyViolationsAsync

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

### listOrgPolicyViolationsPreviewsAsync

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

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organization` | `string` |
| `customConstraint` | `string` |

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

### static::folderName

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `folder` | `string` |

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

### static::folderPolicyName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `folder` | `string` |
| `policy` | `string` |

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

### static::orgPolicyViolationsPreviewName

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

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

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

### static::organizationName

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `organization` | `string` |

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

### static::organizationLocationName

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

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

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

### static::organizationPolicyName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organization` | `string` |
| `policy` | `string` |

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

### static::policyName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `policy` | `string` |

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

### static::projectName

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |

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

### static::projectPolicyName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `policy` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted project_policy 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

- customConstraint: organizations/{organization}/customConstraints/{custom_constraint}
- folder: folders/{folder}
- folderPolicy: folders/{folder}/policies/{policy}
- orgPolicyViolationsPreview: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}
- organization: organizations/{organization}
- organizationLocation: organizations/{organization}/locations/{location}
- organizationPolicy: organizations/{organization}/policies/{policy}
- policy: projects/{project}/policies/{policy}
- project: projects/{project}
- projectPolicy: projects/{project}/policies/{policy}

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