PolicyTagManagerClient

PolicyTagManagerClient

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

Policy tags are used to tag BigQuery columns and apply additional access control policies. A taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.

Constructor

new PolicyTagManagerClient(optionsopt, gaxInstanceopt)

Construct an instance of PolicyTagManagerClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new PolicyTagManagerClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

entryGroupPath(project, location, entry_group) → {string}

Return a fully-qualified entryGroup resource name string.

Parameters:
Name Type Description
project string
location string
entry_group string
Returns:
Type Description
string

Resource name string.

entryPath(project, location, entry_group, entry) → {string}

Return a fully-qualified entry resource name string.

Parameters:
Name Type Description
project string
location string
entry_group string
entry string
Returns:
Type Description
string

Resource name string.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listPolicyTagsAsync(request, optionsopt) → {Object}

Equivalent to listPolicyTags, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Resource name of the taxonomy to list the policy tags of.
pageSize number

The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.
pageToken string

The pagination token of the next results page. If not set, returns the first page.

The token is returned in the response to a previous list request.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing PolicyTag. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the taxonomy to list the policy tags of.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Must be a value between 1 and 1000
   *  inclusively.
   *  If not set, defaults to 50.
   */
  // const pageSize = 1234
  /**
   *  The pagination token of the next results page. If not set, returns the
   *  first page.
   *  The token is returned in the response to a previous list request.
   */
  // const pageToken = 'abc123'

  // Imports the Datacatalog library
  const {PolicyTagManagerClient} = require('@google-cloud/datacatalog').v1;

  // Instantiates a client
  const datacatalogClient = new PolicyTagManagerClient();

  async function callListPolicyTags() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await datacatalogClient.listPolicyTagsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListPolicyTags();

listPolicyTagsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Resource name of the taxonomy to list the policy tags of.
pageSize number

The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.
pageToken string

The pagination token of the next results page. If not set, returns the first page.

The token is returned in the response to a previous list request.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing PolicyTag on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listPolicyTagsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTaxonomiesAsync(request, optionsopt) → {Object}

Equivalent to listTaxonomies, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Resource name of the project to list the taxonomies of.
pageSize number

The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.
pageToken string

The pagination token of the next results page. If not set, the first page is returned.

The token is returned in the response to a previous list request.
filter string

Supported field for filter is 'service' and value is 'dataplex'. Eg: service=dataplex.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Taxonomy. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the project to list the taxonomies of.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Must be a value between 1 and 1000
   *  inclusively. If not set, defaults to 50.
   */
  // const pageSize = 1234
  /**
   *  The pagination token of the next results page. If not set,
   *  the first page is returned.
   *  The token is returned in the response to a previous list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Supported field for filter is 'service' and value is 'dataplex'.
   *  Eg: service=dataplex.
   */
  // const filter = 'abc123'

  // Imports the Datacatalog library
  const {PolicyTagManagerClient} = require('@google-cloud/datacatalog').v1;

  // Instantiates a client
  const datacatalogClient = new PolicyTagManagerClient();

  async function callListTaxonomies() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await datacatalogClient.listTaxonomiesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTaxonomies();

listTaxonomiesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Resource name of the project to list the taxonomies of.
pageSize number

The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.
pageToken string

The pagination token of the next results page. If not set, the first page is returned.

The token is returned in the response to a previous list request.
filter string

Supported field for filter is 'service' and value is 'dataplex'. Eg: service=dataplex.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Taxonomy on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTaxonomiesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:
Name Type Description
project string
location string
Returns:
Type Description
string

Resource name string.

matchEntryFromEntryName(entryName) → {string}

Parse the entry from Entry resource.

Parameters:
Name Type Description
entryName string

A fully-qualified path representing Entry resource.
Returns:
Type Description
string

A string representing the entry.

matchEntryFromTagName(tagName) → {string}

Parse the entry from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the entry.

matchEntryGroupFromEntryGroupName(entryGroupName) → {string}

Parse the entry_group from EntryGroup resource.

Parameters:
Name Type Description
entryGroupName string

A fully-qualified path representing EntryGroup resource.
Returns:
Type Description
string

A string representing the entry_group.

matchEntryGroupFromEntryName(entryName) → {string}

Parse the entry_group from Entry resource.

Parameters:
Name Type Description
entryName string

A fully-qualified path representing Entry resource.
Returns:
Type Description
string

A string representing the entry_group.

matchEntryGroupFromTagName(tagName) → {string}

Parse the entry_group from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the entry_group.

matchFieldFromTagTemplateFieldName(tagTemplateFieldName) → {string}

Parse the field from TagTemplateField resource.

Parameters:
Name Type Description
tagTemplateFieldName string

A fully-qualified path representing TagTemplateField resource.
Returns:
Type Description
string

A string representing the field.

matchLocationFromEntryGroupName(entryGroupName) → {string}

Parse the location from EntryGroup resource.

Parameters:
Name Type Description
entryGroupName string

A fully-qualified path representing EntryGroup resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromEntryName(entryName) → {string}

Parse the location from Entry resource.

Parameters:
Name Type Description
entryName string

A fully-qualified path representing Entry resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromPolicyTagName(policyTagName) → {string}

Parse the location from PolicyTag resource.

Parameters:
Name Type Description
policyTagName string

A fully-qualified path representing PolicyTag resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTagName(tagName) → {string}

Parse the location from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTagTemplateFieldName(tagTemplateFieldName) → {string}

Parse the location from TagTemplateField resource.

Parameters:
Name Type Description
tagTemplateFieldName string

A fully-qualified path representing TagTemplateField resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTagTemplateName(tagTemplateName) → {string}

Parse the location from TagTemplate resource.

Parameters:
Name Type Description
tagTemplateName string

A fully-qualified path representing TagTemplate resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTaxonomyName(taxonomyName) → {string}

Parse the location from Taxonomy resource.

Parameters:
Name Type Description
taxonomyName string

A fully-qualified path representing Taxonomy resource.
Returns:
Type Description
string

A string representing the location.

matchPolicyTagFromPolicyTagName(policyTagName) → {string}

Parse the policy_tag from PolicyTag resource.

Parameters:
Name Type Description
policyTagName string

A fully-qualified path representing PolicyTag resource.
Returns:
Type Description
string

A string representing the policy_tag.

matchProjectFromEntryGroupName(entryGroupName) → {string}

Parse the project from EntryGroup resource.

Parameters:
Name Type Description
entryGroupName string

A fully-qualified path representing EntryGroup resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromEntryName(entryName) → {string}

Parse the project from Entry resource.

Parameters:
Name Type Description
entryName string

A fully-qualified path representing Entry resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPolicyTagName(policyTagName) → {string}

Parse the project from PolicyTag resource.

Parameters:
Name Type Description
policyTagName string

A fully-qualified path representing PolicyTag resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

A fully-qualified path representing Project resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTagName(tagName) → {string}

Parse the project from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTagTemplateFieldName(tagTemplateFieldName) → {string}

Parse the project from TagTemplateField resource.

Parameters:
Name Type Description
tagTemplateFieldName string

A fully-qualified path representing TagTemplateField resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTagTemplateName(tagTemplateName) → {string}

Parse the project from TagTemplate resource.

Parameters:
Name Type Description
tagTemplateName string

A fully-qualified path representing TagTemplate resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTaxonomyName(taxonomyName) → {string}

Parse the project from Taxonomy resource.

Parameters:
Name Type Description
taxonomyName string

A fully-qualified path representing Taxonomy resource.
Returns:
Type Description
string

A string representing the project.

matchTagFromTagName(tagName) → {string}

Parse the tag from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the tag.

matchTagTemplateFromTagTemplateFieldName(tagTemplateFieldName) → {string}

Parse the tag_template from TagTemplateField resource.

Parameters:
Name Type Description
tagTemplateFieldName string

A fully-qualified path representing TagTemplateField resource.
Returns:
Type Description
string

A string representing the tag_template.

matchTagTemplateFromTagTemplateName(tagTemplateName) → {string}

Parse the tag_template from TagTemplate resource.

Parameters:
Name Type Description
tagTemplateName string

A fully-qualified path representing TagTemplate resource.
Returns:
Type Description
string

A string representing the tag_template.

matchTaxonomyFromPolicyTagName(policyTagName) → {string}

Parse the taxonomy from PolicyTag resource.

Parameters:
Name Type Description
policyTagName string

A fully-qualified path representing PolicyTag resource.
Returns:
Type Description
string

A string representing the taxonomy.

matchTaxonomyFromTaxonomyName(taxonomyName) → {string}

Parse the taxonomy from Taxonomy resource.

Parameters:
Name Type Description
taxonomyName string

A fully-qualified path representing Taxonomy resource.
Returns:
Type Description
string

A string representing the taxonomy.

policyTagPath(project, location, taxonomy, policy_tag) → {string}

Return a fully-qualified policyTag resource name string.

Parameters:
Name Type Description
project string
location string
taxonomy string
policy_tag string
Returns:
Type Description
string

Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

tagPath(project, location, entry_group, entry, tag) → {string}

Return a fully-qualified tag resource name string.

Parameters:
Name Type Description
project string
location string
entry_group string
entry string
tag string
Returns:
Type Description
string

Resource name string.

tagTemplateFieldPath(project, location, tag_template, field) → {string}

Return a fully-qualified tagTemplateField resource name string.

Parameters:
Name Type Description
project string
location string
tag_template string
field string
Returns:
Type Description
string

Resource name string.

tagTemplatePath(project, location, tag_template) → {string}

Return a fully-qualified tagTemplate resource name string.

Parameters:
Name Type Description
project string
location string
tag_template string
Returns:
Type Description
string

Resource name string.

taxonomyPath(project, location, taxonomy) → {string}

Return a fully-qualified taxonomy resource name string.

Parameters:
Name Type Description
project string
location string
taxonomy string
Returns:
Type Description
string

Resource name string.