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

Namespace

Methods

__construct

createDataPolicy

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

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

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

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

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

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

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

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

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

deleteDataPolicyAsync

getDataPolicyAsync

getIamPolicyAsync

listDataPoliciesAsync

renameDataPolicyAsync

setIamPolicyAsync

testIamPermissionsAsync

updateDataPolicyAsync

static::dataPolicyName

static::locationName

static::parseName