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

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. Sample code to get started:

$dataPolicyServiceClient = new DataPolicyServiceClient();
try {
    $formattedParent = $dataPolicyServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $dataPolicy = new DataPolicy();
    $response = $dataPolicyServiceClient->createDataPolicy($formattedParent, $dataPolicy);
} finally {
    $dataPolicyServiceClient->close();
}

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.

This service has a new (beta) implementation. See Google\Cloud\BigQuery\DataPolicies\V1\Client\DataPolicyServiceClient to use the new surface.

Namespace

Google \ Cloud \ BigQuery \ DataPolicies \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
options array

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 string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ 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() .

↳ 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|TransportInterface

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 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() and 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.

createDataPolicy

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

Parameters
NameDescription
parent string

Required. Resource name of the project that the data policy will belong to. The format is projects/{project_number}/locations/{location_id}.

dataPolicy Google\Cloud\BigQuery\DataPolicies\V1\DataPolicy

Required. The data policy to create. The name field does not need to be provided for the data policy creation.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\BigQuery\DataPolicies\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.

Parameters
NameDescription
name string

Required. Resource name of the data policy to delete. Format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings 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.

Parameters
NameDescription
name string

Required. Resource name of the requested data policy. Format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\BigQuery\DataPolicies\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.

Parameters
NameDescription
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

optionalArgs array

Optional.

↳ options GetPolicyOptions

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\Policy
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.

Parameters
NameDescription
parent string

Required. Resource name of the project for which to list data policies. Format is projects/{project_number}/locations/{location_id}.

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ filter string

Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3". You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse
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.

Parameters
NameDescription
name string

Required. Resource name of the data policy to rename. The format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}

newDataPolicyId string

Required. The new data policy id.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\BigQuery\DataPolicies\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.

Parameters
NameDescription
resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy Google\Cloud\Iam\V1\Policy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

optionalArgs array

Optional.

↳ updateMask FieldMask

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\Policy
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.

Parameters
NameDescription
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissions string[]

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.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\TestIamPermissionsResponse
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.

Parameters
NameDescription
dataPolicy Google\Cloud\BigQuery\DataPolicies\V1\DataPolicy

Required. Update the data policy's metadata.

The target data policy is determined by the name field. Other fields are updated to the specified values based on the field masks.

optionalArgs array

Optional.

↳ updateMask FieldMask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. Updates to the name and dataPolicyId fields are not allowed.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\BigQuery\DataPolicies\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());
    }
}

static::dataPolicyName

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

Parameters
NameDescription
project string
location string
dataPolicy string
Returns
TypeDescription
stringThe formatted data_policy resource.

static::locationName

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

Parameters
NameDescription
project string
location string
Returns
TypeDescription
stringThe 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
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.cloud.bigquery.datapolicies.v1.DataPolicyService'

The name of the service.

SERVICE_ADDRESS

Value: 'bigquerydatapolicy.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.