Google Cloud Data Catalog V1 Client - Class PolicyTagManagerSerializationClient (1.3.9)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class PolicyTagManagerSerializationClient.

Service Description: Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags.

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:

$policyTagManagerSerializationClient = new PolicyTagManagerSerializationClient();
try {
    $formattedParent = $policyTagManagerSerializationClient->locationName('[PROJECT]', '[LOCATION]');
    $formattedTaxonomies = [
        $policyTagManagerSerializationClient->taxonomyName('[PROJECT]', '[LOCATION]', '[TAXONOMY]'),
    ];
    $response = $policyTagManagerSerializationClient->exportTaxonomies($formattedParent, $formattedTaxonomies);
} finally {
    $policyTagManagerSerializationClient->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.

Methods

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.

taxonomyName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`taxonomy`	`string`

Returns
Type	Description
`string`	The formatted taxonomy resource.

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

location: projects/{project}/locations/{location}
taxonomy: projects/{project}/locations/{location}/taxonomies/{taxonomy}

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.

__construct

Constructor.

Parameters
Name	Description
`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.

exportTaxonomies

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.

This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

Parameters
Name	Description
`parent`	`string` Required. Resource name of the project that the exported taxonomies belong to.
`taxonomies`	`string[]` Required. Resource names of the taxonomies to export.
`optionalArgs`	`array` Optional.
`↳ serializedTaxonomies`	`bool` Serialized export taxonomies that contain all the policy tags as nested protocol buffers.
`↳ 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
Type	Description
`Google\Cloud\DataCatalog\V1\ExportTaxonomiesResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DataCatalog\V1\ExportTaxonomiesResponse;
use Google\Cloud\DataCatalog\V1\PolicyTagManagerSerializationClient;

/**
 * @param string $formattedParent            Resource name of the project that the exported taxonomies belong to. Please see
 *                                           {@see PolicyTagManagerSerializationClient::locationName()} for help formatting this field.
 * @param string $formattedTaxonomiesElement Resource names of the taxonomies to export. Please see
 *                                           {@see PolicyTagManagerSerializationClient::taxonomyName()} for help formatting this field.
 */
function export_taxonomies_sample(
    string $formattedParent,
    string $formattedTaxonomiesElement
): void {
    // Create a client.
    $policyTagManagerSerializationClient = new PolicyTagManagerSerializationClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $formattedTaxonomies = [$formattedTaxonomiesElement,];

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

/**
 * 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 = PolicyTagManagerSerializationClient::locationName('[PROJECT]', '[LOCATION]');
    $formattedTaxonomiesElement = PolicyTagManagerSerializationClient::taxonomyName(
        '[PROJECT]',
        '[LOCATION]',
        '[TAXONOMY]'
    );

    export_taxonomies_sample($formattedParent, $formattedTaxonomiesElement);
}

importTaxonomies

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

Parameters
Name	Description
`parent`	`string` Required. Resource name of project that the imported taxonomies will belong to.
`optionalArgs`	`array` Optional.
`↳ inlineSource`	`InlineSource` Inline source taxonomy to import.
`↳ crossRegionalSource`	`CrossRegionalSource` Cross-regional source taxonomy to import.
`↳ 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
Type	Description
`Google\Cloud\DataCatalog\V1\ImportTaxonomiesResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DataCatalog\V1\ImportTaxonomiesResponse;
use Google\Cloud\DataCatalog\V1\PolicyTagManagerSerializationClient;

/**
 * @param string $formattedParent Resource name of project that the imported taxonomies will belong to. Please see
 *                                {@see PolicyTagManagerSerializationClient::locationName()} for help formatting this field.
 */
function import_taxonomies_sample(string $formattedParent): void
{
    // Create a client.
    $policyTagManagerSerializationClient = new PolicyTagManagerSerializationClient();

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

/**
 * 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 = PolicyTagManagerSerializationClient::locationName('[PROJECT]', '[LOCATION]');

    import_taxonomies_sample($formattedParent);
}

replaceTaxonomy

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages.

This operation automatically does the following:

Deletes the existing policy tags that are missing from the SerializedPolicyTag.
Creates policy tags that don't have resource names. They are considered new.
Updates policy tags with valid resources names accordingly.

Parameters
Name	Description
`name`	`string` Required. Resource name of the taxonomy to update.
`serializedTaxonomy`	`Google\Cloud\DataCatalog\V1\SerializedTaxonomy` Required. Taxonomy to update along with its child policy tags.
`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
Type	Description
`Google\Cloud\DataCatalog\V1\Taxonomy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DataCatalog\V1\PolicyTagManagerSerializationClient;
use Google\Cloud\DataCatalog\V1\SerializedTaxonomy;
use Google\Cloud\DataCatalog\V1\Taxonomy;

/**
 * @param string $formattedName                 Resource name of the taxonomy to update. Please see
 *                                              {@see PolicyTagManagerSerializationClient::taxonomyName()} for help formatting this field.
 * @param string $serializedTaxonomyDisplayName Display name of the taxonomy. At most 200 bytes when encoded in UTF-8.
 */
function replace_taxonomy_sample(
    string $formattedName,
    string $serializedTaxonomyDisplayName
): void {
    // Create a client.
    $policyTagManagerSerializationClient = new PolicyTagManagerSerializationClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $serializedTaxonomy = (new SerializedTaxonomy())
        ->setDisplayName($serializedTaxonomyDisplayName);

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

/**
 * 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 = PolicyTagManagerSerializationClient::taxonomyName(
        '[PROJECT]',
        '[LOCATION]',
        '[TAXONOMY]'
    );
    $serializedTaxonomyDisplayName = '[DISPLAY_NAME]';

    replace_taxonomy_sample($formattedName, $serializedTaxonomyDisplayName);
}

Constants

SERVICE_NAME

Value: 'google.cloud.datacatalog.v1.PolicyTagManagerSerialization'

The name of the service.

SERVICE_ADDRESS

Value: 'datacatalog.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.