DataCatalogClient

Data Catalog API service allows you to discover, understand, and manage your data.

Constructor

new DataCatalogClient(optionsopt, gaxInstanceopt)

Construct an instance of DataCatalogClient.

Parameters:

Name Type Attributes Description

options

object

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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 DataCatalogClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

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

(async) checkImportEntriesProgress(name) → {Promise}

Check the status of the long running operation returned by importEntries().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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. Target entry group for ingested entries.
   */
  // const parent = 'abc123'
  /**
   *  Path to a Cloud Storage bucket that contains a dump ready for ingestion.
   */
  // const gcsBucketPath = 'abc123'
  /**
   *  Optional. (Optional) Dataplex task job id, if specified will be used as
   *  part of ImportEntries LRO ID
   */
  // const jobId = 'abc123'

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

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

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

    // Run request
    const [operation] = await datacatalogClient.importEntries(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callImportEntries();

(async) checkReconcileTagsProgress(name) → {Promise}

Check the status of the long running operation returned by reconcileTags().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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. Name of Entry google.cloud.datacatalog.v1.Entry  to be tagged.
   */
  // const parent = 'abc123'
  /**
   *  Required. The name of the tag template, which is used for reconciliation.
   */
  // const tagTemplate = 'abc123'
  /**
   *  If set to `true`, deletes entry tags related to a tag template
   *  not listed in the tags source from an entry. If set to `false`,
   *  unlisted tags are retained.
   */
  // const forceDeleteMissing = true
  /**
   *  A list of tags to apply to an entry. A tag can specify a
   *  tag template, which must be the template specified in the
   *  `ReconcileTagsRequest`.
   *  The sole entry and each of its columns must be mentioned at most once.
   */
  // const tags = [1,2,3,4]

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

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

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

    // Run request
    const [operation] = await datacatalogClient.reconcileTags(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callReconcileTags();

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.

listEntriesAsync(request, optionsopt) → {Object}

Equivalent to listEntries, 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. The name of the entry group that contains the entries to list. Can be provided in URL format.
`pageSize`	number	The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if `page_size` is more than 1000.
`pageToken`	string	Pagination token that specifies the next page to return. If empty, the first page is returned.
`readMask`	google.protobuf.FieldMask	The fields to return for each entry. If empty or omitted, all fields are returned. For example, to return a list of entries with only the `name` field, set `read_mask` to only one path with the `name` value.

options

object

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 Entry. 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. The name of the entry group that contains the entries to list.
   *  Can be provided in URL format.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Default is 10. Maximum limit is
   *  1000. Throws an invalid argument if `page_size` is more than 1000.
   */
  // const pageSize = 1234
  /**
   *  Pagination token that specifies the next page to return. If empty, the
   *  first page is returned.
   */
  // const pageToken = 'abc123'
  /**
   *  The fields to return for each entry. If empty or omitted, all
   *  fields are returned.
   *  For example, to return a list of entries with only the `name` field,
   *  set `read_mask` to only one path with the `name` value.
   */
  // const readMask = {}

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

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

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

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

  callListEntries();

listEntriesStream(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. The name of the entry group that contains the entries to list. Can be provided in URL format.
`pageSize`	number	The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if `page_size` is more than 1000.
`pageToken`	string	Pagination token that specifies the next page to return. If empty, the first page is returned.
`readMask`	google.protobuf.FieldMask	The fields to return for each entry. If empty or omitted, all fields are returned. For example, to return a list of entries with only the `name` field, set `read_mask` to only one path with the `name` value.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Entry 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 `listEntriesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEntryGroupsAsync(request, optionsopt) → {Object}

Equivalent to listEntryGroups, 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 Attributes Description

parent

string

Required. The name of the location that contains the entry groups to list.

Can be provided as a URL.

pageSize

number

Optional. The maximum number of items to return.

Default is 10. Maximum limit is 1000. Throws an invalid argument if page_size is greater than 1000.

pageToken

string

Optional. Pagination token that specifies the next page to return. If empty, returns the first page.

options

object

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 EntryGroup. 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. The name of the location that contains the entry groups to list.
   *  Can be provided as a URL.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of items to return.
   *  Default is 10. Maximum limit is 1000.
   *  Throws an invalid argument if `page_size` is greater than 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Pagination token that specifies the next page to return.
   *  If empty, returns the first page.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListEntryGroups();

listEntryGroupsStream(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 Attributes Description

parent

string

Required. The name of the location that contains the entry groups to list.

Can be provided as a URL.

pageSize

number

Optional. The maximum number of items to return.

Default is 10. Maximum limit is 1000. Throws an invalid argument if page_size is greater than 1000.

pageToken

string

Optional. Pagination token that specifies the next page to return. If empty, returns the first page.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing EntryGroup 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 `listEntryGroupsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTagsAsync(request, optionsopt) → {Object}

Equivalent to listTags, 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. The name of the Data Catalog resource to list the tags of.

The resource can be an Entry or an EntryGroup (without /entries/{entries} at the end).

pageSize

number

The maximum number of tags to return. Default is 10. Maximum limit is 1000.

pageToken

string

Pagination token that specifies the next page to return. If empty, the first page is returned.

options

object

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 Tag. 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. The name of the Data Catalog resource to list the tags of.
   *  The resource can be an Entry google.cloud.datacatalog.v1.Entry 
   *  or an EntryGroup google.cloud.datacatalog.v1.EntryGroup 
   *  (without `/entries/{entries}` at the end).
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of tags to return. Default is 10. Maximum limit is 1000.
   */
  // const pageSize = 1234
  /**
   *  Pagination token that specifies the next page to return. If empty, the
   *  first page is returned.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListTags();

listTagsStream(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. The name of the Data Catalog resource to list the tags of.

The resource can be an Entry or an EntryGroup (without /entries/{entries} at the end).

pageSize

number

The maximum number of tags to return. Default is 10. Maximum limit is 1000.

pageToken

string

Pagination token that specifies the next page to return. If empty, the first page is returned.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Tag 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 `listTagsAsync()` 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.

matchEnumValueDisplayNameFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName) → {string}

Parse the enum_value_display_name from TagTemplateFieldEnumValue resource.

Parameters:

Name	Type	Description
`tagTemplateFieldEnumValueName`	string	A fully-qualified path representing TagTemplateFieldEnumValue resource.

Returns:

Type	Description
string	A string representing the enum_value_display_name.

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.

matchLocationFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName) → {string}

Parse the location from TagTemplateFieldEnumValue resource.

Parameters:

Name	Type	Description
`tagTemplateFieldEnumValueName`	string	A fully-qualified path representing TagTemplateFieldEnumValue 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.

matchProjectFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName) → {string}

Parse the project from TagTemplateFieldEnumValue resource.

Parameters:

Name	Type	Description
`tagTemplateFieldEnumValueName`	string	A fully-qualified path representing TagTemplateFieldEnumValue 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.

matchTagTemplateFieldIdFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName) → {string}

Parse the tag_template_field_id from TagTemplateFieldEnumValue resource.

Parameters:

Name	Type	Description
`tagTemplateFieldEnumValueName`	string	A fully-qualified path representing TagTemplateFieldEnumValue resource.

Returns:

Type	Description
string	A string representing the tag_template_field_id.

matchTagTemplateFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName) → {string}

Parse the tag_template from TagTemplateFieldEnumValue resource.

Parameters:

Name	Type	Description
`tagTemplateFieldEnumValueName`	string	A fully-qualified path representing TagTemplateFieldEnumValue resource.

Returns:

Type	Description
string	A string representing the tag_template.

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.

searchCatalogAsync(request, optionsopt) → {Object}

Equivalent to searchCatalog, 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	Attributes	Description
`scope`	google.cloud.datacatalog.v1.SearchCatalogRequest.Scope		Required. The scope of this search request. The `scope` is invalid if `include_org_ids`, `include_project_ids` are empty AND `include_gcp_public_datasets` is set to `false`. In this case, the request returns an error.
`query`	string	<optional>	Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: `name:x` `column:y` `description:z`
`pageSize`	number		Upper bound on the number of results you can get in a single response. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.
`pageToken`	string	<optional>	Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.
`orderBy`	string		Specifies the order of results. Currently supported case-sensitive values are: `relevance` that can only be descending `last_modified_timestamp [asc\|desc]` with descending (`desc`) as default `default` that can only be descending Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to `default`. If this parameter is omitted, it defaults to the descending `relevance`.
`adminSearch`	boolean	<optional>	Optional. If set, use searchAll permission granted on organizations from `include_org_ids` and projects from `include_project_ids` instead of the fine grained per resource permissions when filtering the search results. The only allowed `order_by` criteria for admin_search mode is `default`. Using this flags guarantees a full recall of the search results.

options

object

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 SearchCatalogResult. 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. The scope of this search request.
   *  The `scope` is invalid if `include_org_ids`, `include_project_ids` are
   *  empty AND `include_gcp_public_datasets` is set to `false`. In this case,
   *  the request returns an error.
   */
  // const scope = {}
  /**
   *  Optional. The query string with a minimum of 3 characters and specific
   *  syntax. For more information, see Data Catalog search
   *  syntax (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
   *  An empty query string returns all data assets (in the specified scope)
   *  that you have access to.
   *  A query string can be a simple `xyz` or qualified by predicates:
   *  * `name:x`
   *  * `column:y`
   *  * `description:z`
   */
  // const query = 'abc123'
  /**
   *  Upper bound on the number of results you can get in a single response.
   *  Can't be negative or 0, defaults to 10 in this case.
   *  The maximum number is 1000. If exceeded, throws an "invalid argument"
   *  exception.
   */
  // const pageSize = 1234
  /**
   *  Optional. Pagination token that, if specified, returns the next page of
   *  search results. If empty, returns the first page.
   *  This token is returned in the
   *  SearchCatalogResponse.next_page_token google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token 
   *  field of the response to a previous
   *  SearchCatalogRequest google.cloud.datacatalog.v1.DataCatalog.SearchCatalog 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Specifies the order of results.
   *  Currently supported case-sensitive values are:
   *  * `relevance` that can only be descending
   *  * `last_modified_timestamp asc|desc` with descending (`desc`) as default
   *  * `default` that can only be descending
   *  Search queries don't guarantee full recall. Results that match your query
   *  might not be returned, even in subsequent result pages. Additionally,
   *  returned (and not returned) results can vary if you repeat search queries.
   *  If you are experiencing recall issues and you don't have to fetch the
   *  results in any specific order, consider setting this parameter to
   *  `default`.
   *  If this parameter is omitted, it defaults to the descending `relevance`.
   */
  // const orderBy = 'abc123'
  /**
   *  Optional. If set, use searchAll permission granted on organizations from
   *  `include_org_ids` and projects from `include_project_ids` instead of the
   *  fine grained per resource permissions when filtering the search results.
   *  The only allowed `order_by` criteria for admin_search mode is `default`.
   *  Using this flags guarantees a full recall of the search results.
   */
  // const adminSearch = true

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

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

  async function callSearchCatalog() {
    // Construct request
    const request = {
      scope,
    };

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

  callSearchCatalog();

searchCatalogStream(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	Attributes	Description
`scope`	google.cloud.datacatalog.v1.SearchCatalogRequest.Scope		Required. The scope of this search request. The `scope` is invalid if `include_org_ids`, `include_project_ids` are empty AND `include_gcp_public_datasets` is set to `false`. In this case, the request returns an error.
`query`	string	<optional>	Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: `name:x` `column:y` `description:z`
`pageSize`	number		Upper bound on the number of results you can get in a single response. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.
`pageToken`	string	<optional>	Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.
`orderBy`	string		Specifies the order of results. Currently supported case-sensitive values are: `relevance` that can only be descending `last_modified_timestamp [asc\|desc]` with descending (`desc`) as default `default` that can only be descending Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to `default`. If this parameter is omitted, it defaults to the descending `relevance`.
`adminSearch`	boolean	<optional>	Optional. If set, use searchAll permission granted on organizations from `include_org_ids` and projects from `include_project_ids` instead of the fine grained per resource permissions when filtering the search results. The only allowed `order_by` criteria for admin_search mode is `default`. Using this flags guarantees a full recall of the search results.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing SearchCatalogResult 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 searchCatalogAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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.

tagTemplateFieldEnumValuePath(project, location, tag_template, tag_template_field_id, enum_value_display_name) → {string}

Return a fully-qualified tagTemplateFieldEnumValue resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`tag_template`	string
`tag_template_field_id`	string
`enum_value_display_name`	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.