Google Cloud Data Catalog V1 Client - Class PolicyTagManagerClient (1.6.0)

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

Service Description: Policy Tag Manager API service allows you to manage your policy tags and taxonomies.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ DataCatalog \ V1 \ Client

Methods

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

createPolicyTag

Creates a policy tag in a taxonomy.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::createPolicyTagAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\CreatePolicyTagRequest` A request to house fields associated with the call.
`callOptions`	`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\PolicyTag`

createTaxonomy

Creates a taxonomy in a specified project.

The taxonomy is initially empty, that is, it doesn't contain policy tags.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::createTaxonomyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\CreateTaxonomyRequest` A request to house fields associated with the call.
`callOptions`	`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`

deletePolicyTag

Deletes a policy tag together with the following:

All of its descendant policy tags, if any
Policies associated with the policy tag and its descendants
References from BigQuery table schema of the policy tag and its descendants

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::deletePolicyTagAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\DeletePolicyTagRequest` A request to house fields associated with the call.
`callOptions`	`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.

deleteTaxonomy

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::deleteTaxonomyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\DeleteTaxonomyRequest` A request to house fields associated with the call.
`callOptions`	`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.

getIamPolicy

Gets the IAM policy for a policy tag or a taxonomy.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::getIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`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\Iam\V1\Policy`

getPolicyTag

Gets a policy tag.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::getPolicyTagAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\GetPolicyTagRequest` A request to house fields associated with the call.
`callOptions`	`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\PolicyTag`

getTaxonomy

Gets a taxonomy.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::getTaxonomyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\GetTaxonomyRequest` A request to house fields associated with the call.
`callOptions`	`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`

listPolicyTags

Lists all policy tags in a taxonomy.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::listPolicyTagsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\ListPolicyTagsRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\PagedListResponse`

listTaxonomies

Lists all taxonomies in a project in a particular location that you have a permission to view.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::listTaxonomiesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\ListTaxonomiesRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\PagedListResponse`

setIamPolicy

Sets the IAM policy for a policy tag or a taxonomy.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::setIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`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\Iam\V1\Policy`

testIamPermissions

Returns your permissions on a specified policy tag or taxonomy.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest` A request to house fields associated with the call.
`callOptions`	`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\Iam\V1\TestIamPermissionsResponse`

updatePolicyTag

Updates a policy tag, including its display name, description, and parent policy tag.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::updatePolicyTagAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\UpdatePolicyTagRequest` A request to house fields associated with the call.
`callOptions`	`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\PolicyTag`

updateTaxonomy

Updates a taxonomy, including its display name, description, and activated policy types.

The async variant is Google\Cloud\DataCatalog\V1\Client\BaseClient\self::updateTaxonomyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\UpdateTaxonomyRequest` A request to house fields associated with the call.
`callOptions`	`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`

createPolicyTagAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\CreatePolicyTagRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createTaxonomyAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\CreateTaxonomyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deletePolicyTagAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\DeletePolicyTagRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteTaxonomyAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\DeleteTaxonomyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getPolicyTagAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\GetPolicyTagRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getTaxonomyAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\GetTaxonomyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listPolicyTagsAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\ListPolicyTagsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listTaxonomiesAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\ListTaxonomiesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

setIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

testIamPermissionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updatePolicyTagAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\UpdatePolicyTagRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateTaxonomyAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\V1\UpdateTaxonomyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

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::policyTagName

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

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

Returns
Type	Description
`string`	The formatted policy_tag resource.

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

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

location: projects/{project}/locations/{location}
policyTag: projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}
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.