# Google Cloud BigQuery Data Policies V1 Client - Class DataPolicyServiceClient (1.1.3)

1.1.3 (latest) 1.1.2 1.0.5 0.5.5 0.4.1 0.3.3 0.2.4 0.1.1 Reference documentation and code samples for the Google Cloud BigQuery Data Policies V1 Client class DataPolicyServiceClient.

Service Description: Data Policy Service provides APIs for managing the label-policy bindings.

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

### createDataPolicy

Creates a new data policy under a project with the given `dataPolicyId`
(used as the display name), policy tag, and data policy type.

The async variant is [DataPolicyServiceClient::createDataPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.Client.DataPolicyServiceClient#_Google_Cloud_BigQuery_DataPolicies_V1_Client_DataPolicyServiceClient__createDataPolicyAsync__) .

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

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient;
    use Google\Cloud\BigQuery\DataPolicies\V1\CreateDataPolicyRequest;
    use Google\Cloud\BigQuery\DataPolicies\V1\DataPolicy;

    /**
     * @param string $formattedParent Resource name of the project that the data policy will belong to.
     *                                The format is `projects/{project_number}/locations/{location_id}`. Please see
     *                                {@see DataPolicyServiceClient::locationName()} for help formatting this field.
     */
    function create_data_policy_sample(string $formattedParent): void
    {
        // Create a client.
        $dataPolicyServiceClient = new DataPolicyServiceClient();

        // Prepare the request message.
        $dataPolicy = new DataPolicy();
        $request = (new CreateDataPolicyRequest())
            ->setParent($formattedParent)
            ->setDataPolicy($dataPolicy);

        // Call the API and handle any network failures.
        try {
            /** @var DataPolicy $response */
            $response = $dataPolicyServiceClient->createDataPolicy($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
    {
        $formattedParent = DataPolicyServiceClient::locationName('[PROJECT]', '[LOCATION]');

        create_data_policy_sample($formattedParent);
    }

### deleteDataPolicy

Deletes the data policy specified by its resource name.

The async variant is [DataPolicyServiceClient::deleteDataPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.Client.DataPolicyServiceClient#_Google_Cloud_BigQuery_DataPolicies_V1_Client_DataPolicyServiceClient__deleteDataPolicyAsync__) .

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

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient;
    use Google\Cloud\BigQuery\DataPolicies\V1\DeleteDataPolicyRequest;

    /**
     * @param string $formattedName Resource name of the data policy to delete. Format is
     *                              `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. Please see
     *                              {@see DataPolicyServiceClient::dataPolicyName()} for help formatting this field.
     */
    function delete_data_policy_sample(string $formattedName): void
    {
        // Create a client.
        $dataPolicyServiceClient = new DataPolicyServiceClient();

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

        // Call the API and handle any network failures.
        try {
            $dataPolicyServiceClient->deleteDataPolicy($request);
            printf('Call completed successfully.' . PHP_EOL);
        } 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 = DataPolicyServiceClient::dataPolicyName(
            '[PROJECT]',
            '[LOCATION]',
            '[DATA_POLICY]'
        );

        delete_data_policy_sample($formattedName);
    }

### getDataPolicy

Gets the data policy specified by its resource name.

The async variant is [DataPolicyServiceClient::getDataPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.Client.DataPolicyServiceClient#_Google_Cloud_BigQuery_DataPolicies_V1_Client_DataPolicyServiceClient__getDataPolicyAsync__) .

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

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient;
    use Google\Cloud\BigQuery\DataPolicies\V1\DataPolicy;
    use Google\Cloud\BigQuery\DataPolicies\V1\GetDataPolicyRequest;

    /**
     * @param string $formattedName Resource name of the requested data policy. Format is
     *                              `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. Please see
     *                              {@see DataPolicyServiceClient::dataPolicyName()} for help formatting this field.
     */
    function get_data_policy_sample(string $formattedName): void
    {
        // Create a client.
        $dataPolicyServiceClient = new DataPolicyServiceClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var DataPolicy $response */
            $response = $dataPolicyServiceClient->getDataPolicy($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 = DataPolicyServiceClient::dataPolicyName(
            '[PROJECT]',
            '[LOCATION]',
            '[DATA_POLICY]'
        );

        get_data_policy_sample($formattedName);
    }

### getIamPolicy

Gets the IAM policy for the specified data policy.

The async variant is [DataPolicyServiceClient::getIamPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.Client.DataPolicyServiceClient#_Google_Cloud_BigQuery_DataPolicies_V1_Client_DataPolicyServiceClient__getIamPolicyAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.GetIamPolicyRequest.html` 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/common-protos/latest/Cloud.Iam.V1.Policy.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient;
    use Google\Cloud\Iam\V1\GetIamPolicyRequest;
    use Google\Cloud\Iam\V1\Policy;

    /**
     * @param string $resource REQUIRED: The resource for which the policy is being requested.
     *                         See the operation documentation for the appropriate value for this field.
     */
    function get_iam_policy_sample(string $resource): void
    {
        // Create a client.
        $dataPolicyServiceClient = new DataPolicyServiceClient();

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

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

        get_iam_policy_sample($resource);
    }

### listDataPolicies

List all of the data policies in the specified parent project.

The async variant is [DataPolicyServiceClient::listDataPoliciesAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.Client.DataPolicyServiceClient#_Google_Cloud_BigQuery_DataPolicies_V1_Client_DataPolicyServiceClient__listDataPoliciesAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.ListDataPoliciesRequest` 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\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient;
    use Google\Cloud\BigQuery\DataPolicies\V1\DataPolicy;
    use Google\Cloud\BigQuery\DataPolicies\V1\ListDataPoliciesRequest;

    /**
     * @param string $formattedParent Resource name of the project for which to list data policies.
     *                                Format is `projects/{project_number}/locations/{location_id}`. Please see
     *                                {@see DataPolicyServiceClient::locationName()} for help formatting this field.
     */
    function list_data_policies_sample(string $formattedParent): void
    {
        // Create a client.
        $dataPolicyServiceClient = new DataPolicyServiceClient();

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

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

            /** @var DataPolicy $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 = DataPolicyServiceClient::locationName('[PROJECT]', '[LOCATION]');

        list_data_policies_sample($formattedParent);
    }

### renameDataPolicy

Renames the id (display name) of the specified data policy.

The async variant is [DataPolicyServiceClient::renameDataPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.Client.DataPolicyServiceClient#_Google_Cloud_BigQuery_DataPolicies_V1_Client_DataPolicyServiceClient__renameDataPolicyAsync__) .

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

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient;
    use Google\Cloud\BigQuery\DataPolicies\V1\DataPolicy;
    use Google\Cloud\BigQuery\DataPolicies\V1\RenameDataPolicyRequest;

    /**
     * @param string $name            Resource name of the data policy to rename. The format is
     *                                `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`
     * @param string $newDataPolicyId The new data policy id.
     */
    function rename_data_policy_sample(string $name, string $newDataPolicyId): void
    {
        // Create a client.
        $dataPolicyServiceClient = new DataPolicyServiceClient();

        // Prepare the request message.
        $request = (new RenameDataPolicyRequest())
            ->setName($name)
            ->setNewDataPolicyId($newDataPolicyId);

        // Call the API and handle any network failures.
        try {
            /** @var DataPolicy $response */
            $response = $dataPolicyServiceClient->renameDataPolicy($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
    {
        $name = '[NAME]';
        $newDataPolicyId = '[NEW_DATA_POLICY_ID]';

        rename_data_policy_sample($name, $newDataPolicyId);
    }

### setIamPolicy

Sets the IAM policy for the specified data policy.

The async variant is [DataPolicyServiceClient::setIamPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.Client.DataPolicyServiceClient#_Google_Cloud_BigQuery_DataPolicies_V1_Client_DataPolicyServiceClient__setIamPolicyAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.SetIamPolicyRequest.html` 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/common-protos/latest/Cloud.Iam.V1.Policy.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient;
    use Google\Cloud\Iam\V1\Policy;
    use Google\Cloud\Iam\V1\SetIamPolicyRequest;

    /**
     * @param string $resource REQUIRED: The resource for which the policy is being specified.
     *                         See the operation documentation for the appropriate value for this field.
     */
    function set_iam_policy_sample(string $resource): void
    {
        // Create a client.
        $dataPolicyServiceClient = new DataPolicyServiceClient();

        // Prepare the request message.
        $policy = new Policy();
        $request = (new SetIamPolicyRequest())
            ->setResource($resource)
            ->setPolicy($policy);

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

        set_iam_policy_sample($resource);
    }

### testIamPermissions

Returns the caller's permission on the specified data policy resource.

The async variant is [DataPolicyServiceClient::testIamPermissionsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.Client.DataPolicyServiceClient#_Google_Cloud_BigQuery_DataPolicies_V1_Client_DataPolicyServiceClient__testIamPermissionsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsRequest.html` 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/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient;
    use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
    use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

    /**
     * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
     *                                   See the operation documentation for the appropriate value for this field.
     * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
     *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
     *                                   information see
     *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
     */
    function test_iam_permissions_sample(string $resource, string $permissionsElement): void
    {
        // Create a client.
        $dataPolicyServiceClient = new DataPolicyServiceClient();

        // Prepare the request message.
        $permissions = [$permissionsElement,];
        $request = (new TestIamPermissionsRequest())
            ->setResource($resource)
            ->setPermissions($permissions);

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

        test_iam_permissions_sample($resource, $permissionsElement);
    }

### updateDataPolicy

Updates the metadata for an existing data policy. The target data policy
can be specified by the resource name.

The async variant is [DataPolicyServiceClient::updateDataPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-datapolicies/latest/V1.Client.DataPolicyServiceClient#_Google_Cloud_BigQuery_DataPolicies_V1_Client_DataPolicyServiceClient__updateDataPolicyAsync__) .

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

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient;
    use Google\Cloud\BigQuery\DataPolicies\V1\DataPolicy;
    use Google\Cloud\BigQuery\DataPolicies\V1\UpdateDataPolicyRequest;

    /**
     * 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 update_data_policy_sample(): void
    {
        // Create a client.
        $dataPolicyServiceClient = new DataPolicyServiceClient();

        // Prepare the request message.
        $dataPolicy = new DataPolicy();
        $request = (new UpdateDataPolicyRequest())
            ->setDataPolicy($dataPolicy);

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

### createDataPolicyAsync

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

### deleteDataPolicyAsync

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<void>` |   |

### getDataPolicyAsync

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

### getIamPolicyAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.GetIamPolicyRequest.html` |
| `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/common-protos/latest/Cloud.Iam.V1.Policy.html>` |   |

### listDataPoliciesAsync

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

### renameDataPolicyAsync

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

### setIamPolicyAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.SetIamPolicyRequest.html` |
| `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/common-protos/latest/Cloud.Iam.V1.Policy.html>` |   |

### testIamPermissionsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsRequest.html` |
| `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/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsResponse.html>` |   |

### updateDataPolicyAsync

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

### static::dataPolicyName

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

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

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

### static::locationName

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

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

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

- dataPolicy: projects/{project}/locations/{location}/dataPolicies/{data_policy}
- location: projects/{project}/locations/{location}

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