Class v1beta1.DataCatalogClient (2.5.0)

Version 2.5.0

• 4.1.1 (latest)
• 4.1.0
• 3.3.1
• 3.2.1
• 2.5.0
• 2.4.2
• 2.3.4

Data Catalog API service allows clients to discover, understand, and manage their data. v1beta1

Package

@google-cloud/datacatalog

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of DataCatalogClient.

Parameter

Name	Description
opts	ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

dataCatalogStub

dataCatalogStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

close()

close(): Promise<void>;

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<void>	{Promise} A promise that resolves when the client is closed.

createEntry(request, options)

createEntry(request?: protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest | undefined, {} | undefined]>;

Creates an entry. Only entries of 'FILESET' type or user-specified type can be created.

Users should enable the Data Catalog API in the project identified by the parent parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

A maximum of 100,000 entries may be created per entry group.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Entry]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the entry group this entry is in. Example:
   *  * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
   *  Note that this Entry and its child resources may not actually be stored in
   *  the location in this name.
   */
  // const parent = 'abc123'
  /**
   *  Required. The id of the entry to create.
   */
  // const entryId = 'abc123'
  /**
   *  Required. The entry to create.
   */
  // const entry = {}

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

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

  async function callCreateEntry() {
    // Construct request
    const request = {
      parent,
      entryId,
      entry,
    };

    // Run request
    const response = await datacatalogClient.createEntry(request);
    console.log(response);
  }

  callCreateEntry();

createEntry(request, options, callback)

createEntry(request: protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createEntry(request, callback)

createEntry(request: protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ICreateEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createEntryGroup(request, options)

createEntryGroup(request?: protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IEntryGroup, (protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest | undefined), {} | undefined]>;

A maximum of 10,000 entry groups may be created per organization across all locations.

Users should enable the Data Catalog API in the project identified by the parent parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IEntryGroup, (protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [EntryGroup]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the project this entry group is in. Example:
   *  * projects/{project_id}/locations/{location}
   *  Note that this EntryGroup and its child resources may not actually be
   *  stored in the location in this name.
   */
  // const parent = 'abc123'
  /**
   *  Required. The id of the entry group to create.
   *  The id must begin with a letter or underscore, contain only English
   *  letters, numbers and underscores, and be at most 64 characters.
   */
  // const entryGroupId = 'abc123'
  /**
   *  The entry group to create. Defaults to an empty entry group.
   */
  // const entryGroup = {}

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

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

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

    // Run request
    const response = await datacatalogClient.createEntryGroup(request);
    console.log(response);
  }

  callCreateEntryGroup();

createEntryGroup(request, options, callback)

createEntryGroup(request: protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createEntryGroup(request, callback)

createEntryGroup(request: protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.ICreateEntryGroupRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createTag(request, options)

createTag(request?: protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest | undefined, {} | undefined]>;

Creates a tag on an . Note: The project identified by the parent parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Tag]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the resource to attach this tag to. Tags can be attached to
   *  Entries. Example:
   *  * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
   *  Note that this Tag and its child resources may not actually be stored in
   *  the location in this name.
   */
  // const parent = 'abc123'
  /**
   *  Required. The tag to create.
   */
  // const tag = {}

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

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

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

    // Run request
    const response = await datacatalogClient.createTag(request);
    console.log(response);
  }

  callCreateTag();

createTag(request, options, callback)

createTag(request: protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createTag(request, callback)

createTag(request: protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.ICreateTagRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createTagTemplate(request, options)

createTagTemplate(request?: protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplate, (protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest | undefined), {} | undefined]>;

Creates a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplate, (protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplate]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the project and the template location
   *  region (https://cloud.google.com/data-catalog/docs/concepts/regions.
   *  Example:
   *  * projects/{project_id}/locations/us-central1
   */
  // const parent = 'abc123'
  /**
   *  Required. The id of the tag template to create.
   */
  // const tagTemplateId = 'abc123'
  /**
   *  Required. The tag template to create.
   */
  // const tagTemplate = {}

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

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

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

    // Run request
    const response = await datacatalogClient.createTagTemplate(request);
    console.log(response);
  }

  callCreateTagTemplate();

createTagTemplate(request, options, callback)

createTagTemplate(request: protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createTagTemplate(request, callback)

createTagTemplate(request: protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createTagTemplateField(request, options)

createTagTemplateField(request?: protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, (protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest | undefined), {} | undefined]>;

Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, (protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplateField]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the project and the template location
   *  region (https://cloud.google.com/data-catalog/docs/concepts/regions).
   *  Example:
   *  * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id}
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the tag template field to create.
   *  Field ids can contain letters (both uppercase and lowercase), numbers
   *  (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
   *  character long and at most 128 characters long. Field IDs must also be
   *  unique within their template.
   */
  // const tagTemplateFieldId = 'abc123'
  /**
   *  Required. The tag template field to create.
   */
  // const tagTemplateField = {}

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

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

  async function callCreateTagTemplateField() {
    // Construct request
    const request = {
      parent,
      tagTemplateFieldId,
      tagTemplateField,
    };

    // Run request
    const response = await datacatalogClient.createTagTemplateField(request);
    console.log(response);
  }

  callCreateTagTemplateField();

createTagTemplateField(request, options, callback)

createTagTemplateField(request: protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createTagTemplateField(request, callback)

createTagTemplateField(request: protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.ICreateTagTemplateFieldRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteEntry(request, options)

deleteEntry(request?: protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest | undefined, {} | undefined]>;

Deletes an existing entry. Only entries created through method can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the entry. Example:
   *  * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
   */
  // const name = 'abc123'

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

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

  async function callDeleteEntry() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await datacatalogClient.deleteEntry(request);
    console.log(response);
  }

  callDeleteEntry();

deleteEntry(request, options, callback)

deleteEntry(request: protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteEntry(request, callback)

deleteEntry(request: protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteEntryGroup(request, options)

deleteEntryGroup(request?: protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest | undefined), {} | undefined]>;

Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the entry group. For example,
   *  `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
   */
  // const name = 'abc123'
  /**
   *  Optional. If true, deletes all entries in the entry group.
   */
  // const force = true

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

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

  async function callDeleteEntryGroup() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await datacatalogClient.deleteEntryGroup(request);
    console.log(response);
  }

  callDeleteEntryGroup();

deleteEntryGroup(request, options, callback)

deleteEntryGroup(request: protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteEntryGroup(request, callback)

deleteEntryGroup(request: protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteEntryGroupRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteTag(request, options)

deleteTag(request?: protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest | undefined, {} | undefined]>;

Deletes a tag.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the tag to delete. Example:
   *  * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
   */
  // const name = 'abc123'

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

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

  async function callDeleteTag() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await datacatalogClient.deleteTag(request);
    console.log(response);
  }

  callDeleteTag();

deleteTag(request, options, callback)

deleteTag(request: protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteTag(request, callback)

deleteTag(request: protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteTagTemplate(request, options)

deleteTagTemplate(request?: protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest | undefined), {} | undefined]>;

Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the tag template to delete. Example:
   *  * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
   */
  // const name = 'abc123'
  /**
   *  Required. Currently, this field must always be set to `true`.
   *  This confirms the deletion of any possible tags using this template.
   *  `force = false` will be supported in the future.
   */
  // const force = true

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

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

  async function callDeleteTagTemplate() {
    // Construct request
    const request = {
      name,
      force,
    };

    // Run request
    const response = await datacatalogClient.deleteTagTemplate(request);
    console.log(response);
  }

  callDeleteTagTemplate();

deleteTagTemplate(request, options, callback)

deleteTagTemplate(request: protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteTagTemplate(request, callback)

deleteTagTemplate(request: protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteTagTemplateField(request, options)

deleteTagTemplateField(request?: protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest | undefined), {} | undefined]>;

Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the tag template field to delete. Example:
   *  * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
   */
  // const name = 'abc123'
  /**
   *  Required. Currently, this field must always be set to `true`.
   *  This confirms the deletion of this field from any tags using this field.
   *  `force = false` will be supported in the future.
   */
  // const force = true

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

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

  async function callDeleteTagTemplateField() {
    // Construct request
    const request = {
      name,
      force,
    };

    // Run request
    const response = await datacatalogClient.deleteTagTemplateField(request);
    console.log(response);
  }

  callDeleteTagTemplateField();

deleteTagTemplateField(request, options, callback)

deleteTagTemplateField(request: protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteTagTemplateField(request, callback)

deleteTagTemplateField(request: protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.v1beta1.IDeleteTagTemplateFieldRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

entryGroupPath(project, location, entryGroup)

entryGroupPath(project: string, location: string, entryGroup: string): string;

Return a fully-qualified entryGroup resource name string.

Parameters

Name	Description
project	string
location	string
entryGroup	string

Returns

Type	Description
string	{string} Resource name string.

entryPath(project, location, entryGroup, entry)

entryPath(project: string, location: string, entryGroup: string, entry: string): string;

Return a fully-qualified entry resource name string.

Parameters

Name	Description
project	string
location	string
entryGroup	string
entry	string

Returns

Type	Description
string	{string} Resource name string.

getEntry(request, options)

getEntry(request?: protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest | undefined, {} | undefined]>;

Gets an entry.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Entry]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the entry. Example:
   *  * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
   */
  // const name = 'abc123'

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

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

  async function callGetEntry() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await datacatalogClient.getEntry(request);
    console.log(response);
  }

  callGetEntry();

getEntry(request, options, callback)

getEntry(request: protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getEntry(request, callback)

getEntry(request: protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IGetEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getEntryGroup(request, options)

getEntryGroup(request?: protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest | undefined, {} | undefined]>;

Gets an EntryGroup.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [EntryGroup]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the entry group. For example,
   *  `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
   */
  // const name = 'abc123'
  /**
   *  The fields to return. If not set or empty, all fields are returned.
   */
  // const readMask = {}

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

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

  async function callGetEntryGroup() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await datacatalogClient.getEntryGroup(request);
    console.log(response);
  }

  callGetEntryGroup();

getEntryGroup(request, options, callback)

getEntryGroup(request: protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getEntryGroup(request, callback)

getEntryGroup(request: protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IGetEntryGroupRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>;

Gets the access control policy for a resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

Callers must have following Google IAM permission - datacatalog.tagTemplates.getIamPolicy to get policies on tag templates. - datacatalog.entries.getIamPolicy to get policies on entries. - datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters

Name	Description
request	protos.google.iam.v1.IGetIamPolicyRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  OPTIONAL: A `GetPolicyOptions` object for specifying options to
   *  `GetIamPolicy`. This field is only used by Cloud IAM.
   */
  // const options = {}

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

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

  async function callGetIamPolicy() {
    // Construct request
    const request = {
      resource,
    };

    // Run request
    const response = await datacatalogClient.getIamPolicy(request);
    console.log(response);
  }

  callGetIamPolicy();

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.IGetIamPolicyRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.IGetIamPolicyRequest
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	Callback<string, undefined, undefined>

Returns

Type	Description
void

getTagTemplate(request, options)

getTagTemplate(request?: protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplate, (protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest | undefined), {} | undefined]>;

Gets a tag template.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplate, (protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplate]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the tag template. Example:
   *  * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
   */
  // const name = 'abc123'

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

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

  async function callGetTagTemplate() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await datacatalogClient.getTagTemplate(request);
    console.log(response);
  }

  callGetTagTemplate();

getTagTemplate(request, options, callback)

getTagTemplate(request: protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getTagTemplate(request, callback)

getTagTemplate(request: protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.IGetTagTemplateRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listEntries(request, options)

listEntries(request?: protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry[], protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest | null, protos.google.cloud.datacatalog.v1beta1.IListEntriesResponse]>;

Lists entries.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry[], protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest | null, protos.google.cloud.datacatalog.v1beta1.IListEntriesResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Entry]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEntries(request, options, callback)

listEntries(request: protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest, protos.google.cloud.datacatalog.v1beta1.IListEntriesResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IEntry>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest, protos.google.cloud.datacatalog.v1beta1.IListEntriesResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IEntry>

Returns

Type	Description
void

listEntries(request, callback)

listEntries(request: protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest, protos.google.cloud.datacatalog.v1beta1.IListEntriesResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IEntry>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest
callback	PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest, protos.google.cloud.datacatalog.v1beta1.IListEntriesResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IEntry>

Returns

Type	Description
void

listEntriesAsync(request, options)

listEntriesAsync(request?: protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datacatalog.v1beta1.IEntry>;

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	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.datacatalog.v1beta1.IEntry>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the entry group that contains the entries, which can
   *  be provided in URL format. Example:
   *  * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Default is 10. Max limit is 1000.
   *  Throws an invalid argument for `page_size > 1000`.
   */
  // const pageSize = 1234
  /**
   *  Token that specifies which page is requested. If empty, the first page is
   *  returned.
   */
  // const pageToken = 'abc123'
  /**
   *  The fields to return for each Entry. If not set or empty, all
   *  fields are returned.
   *  For example, setting read_mask to contain only one path "name" will cause
   *  ListEntries to return a list of Entries with only "name" field.
   */
  // const readMask = {}

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

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

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

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

  callListEntries();

listEntriesStream(request, options)

listEntriesStream(request?: protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEntryGroups(request, options)

listEntryGroups(request?: protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IEntryGroup[], protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest | null, protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsResponse]>;

Lists entry groups.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Promise<[protos.google.cloud.datacatalog.v1beta1.IEntryGroup[], protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest | null, protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [EntryGroup]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEntryGroups(request, options, callback)

listEntryGroups(request: protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest, protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IEntryGroup>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest, protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IEntryGroup>

Returns

Type	Description
void

listEntryGroups(request, callback)

listEntryGroups(request: protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest, protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IEntryGroup>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest
callback	PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest, protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IEntryGroup>

Returns

Type	Description
void

listEntryGroupsAsync(request, options)

listEntryGroupsAsync(request?: protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datacatalog.v1beta1.IEntryGroup>;

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	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.datacatalog.v1beta1.IEntryGroup>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the location that contains the entry groups, which can be
   *  provided in URL format. Example:
   *  * projects/{project_id}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of items to return. Default is 10. Max limit is 1000.
   *  Throws an invalid argument for `page_size > 1000`.
   */
  // const pageSize = 1234
  /**
   *  Optional. Token that specifies which page is requested. If empty, the first page is
   *  returned.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListEntryGroups();

listEntryGroupsStream(request, options)

listEntryGroupsStream(request?: protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTags(request, options)

listTags(request?: protos.google.cloud.datacatalog.v1beta1.IListTagsRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITag[], protos.google.cloud.datacatalog.v1beta1.IListTagsRequest | null, protos.google.cloud.datacatalog.v1beta1.IListTagsResponse]>;

Lists the tags on an .

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListTagsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Promise<[protos.google.cloud.datacatalog.v1beta1.ITag[], protos.google.cloud.datacatalog.v1beta1.IListTagsRequest | null, protos.google.cloud.datacatalog.v1beta1.IListTagsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Tag]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTags(request, options, callback)

listTags(request: protos.google.cloud.datacatalog.v1beta1.IListTagsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListTagsRequest, protos.google.cloud.datacatalog.v1beta1.IListTagsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ITag>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListTagsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListTagsRequest, protos.google.cloud.datacatalog.v1beta1.IListTagsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ITag>

Returns

Type	Description
void

listTags(request, callback)

listTags(request: protos.google.cloud.datacatalog.v1beta1.IListTagsRequest, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListTagsRequest, protos.google.cloud.datacatalog.v1beta1.IListTagsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ITag>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListTagsRequest
callback	PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListTagsRequest, protos.google.cloud.datacatalog.v1beta1.IListTagsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ITag>

Returns

Type	Description
void

listTagsAsync(request, options)

listTagsAsync(request?: protos.google.cloud.datacatalog.v1beta1.IListTagsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datacatalog.v1beta1.ITag>;

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	Description
request	protos.google.cloud.datacatalog.v1beta1.IListTagsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.datacatalog.v1beta1.ITag>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Data Catalog resource to list the tags of. The resource
   *  could be an Entry google.cloud.datacatalog.v1beta1.Entry  or an
   *  EntryGroup google.cloud.datacatalog.v1beta1.EntryGroup.
   *  Examples:
   *  * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
   *  * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of tags to return. Default is 10. Max limit is 1000.
   */
  // const pageSize = 1234
  /**
   *  Token that specifies which page is requested. If empty, the first page is
   *  returned.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListTags();

listTagsStream(request, options)

listTagsStream(request?: protos.google.cloud.datacatalog.v1beta1.IListTagsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IListTagsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	string
location	string

Returns

Type	Description
string	{string} Resource name string.

lookupEntry(request, options)

lookupEntry(request?: protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest | undefined, {} | undefined]>;

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Entry]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The full name of the Google Cloud Platform resource the Data Catalog
   *  entry represents. See:
   *  https://cloud.google.com/apis/design/resource_names#full_resource_name.
   *  Full names are case-sensitive.
   *  Examples:
   *   * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
   *   * //pubsub.googleapis.com/projects/projectId/topics/topicId
   */
  // const linkedResource = 'abc123'
  /**
   *  The SQL name of the entry. SQL names are case-sensitive.
   *  Examples:
   *    * `pubsub.project_id.topic_id`
   *    * ``pubsub.project_id.`topic.id.with.dots` ``
   *    * `bigquery.table.project_id.dataset_id.table_id`
   *    * `bigquery.dataset.project_id.dataset_id`
   *    * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id`
   *  `*_id`s shoud satisfy the standard SQL rules for identifiers.
   *  https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
   */
  // const sqlResource = 'abc123'

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

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

  async function callLookupEntry() {
    // Construct request
    const request = {};

    // Run request
    const response = await datacatalogClient.lookupEntry(request);
    console.log(response);
  }

  callLookupEntry();

lookupEntry(request, options, callback)

lookupEntry(request: protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

lookupEntry(request, callback)

lookupEntry(request: protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.ILookupEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

matchEntryFromEntryName(entryName)

matchEntryFromEntryName(entryName: string): string | number;

Parse the entry from Entry resource.

Parameter

Name	Description
entryName	string A fully-qualified path representing Entry resource.

Returns

Type	Description
string | number	{string} A string representing the entry.

matchEntryFromTagName(tagName)

matchEntryFromTagName(tagName: string): string | number;

Parse the entry from Tag resource.

Parameter

Name	Description
tagName	string A fully-qualified path representing Tag resource.

Returns

Type	Description
string | number	{string} A string representing the entry.

matchEntryGroupFromEntryGroupName(entryGroupName)

matchEntryGroupFromEntryGroupName(entryGroupName: string): string | number;

Parse the entry_group from EntryGroup resource.

Parameter

Name	Description
entryGroupName	string A fully-qualified path representing EntryGroup resource.

Returns

Type	Description
string | number	{string} A string representing the entry_group.

matchEntryGroupFromEntryName(entryName)

matchEntryGroupFromEntryName(entryName: string): string | number;

Parse the entry_group from Entry resource.

Parameter

Name	Description
entryName	string A fully-qualified path representing Entry resource.

Returns

Type	Description
string | number	{string} A string representing the entry_group.

matchEntryGroupFromTagName(tagName)

matchEntryGroupFromTagName(tagName: string): string | number;

Parse the entry_group from Tag resource.

Parameter

Name	Description
tagName	string A fully-qualified path representing Tag resource.

Returns

Type	Description
string | number	{string} A string representing the entry_group.

matchFieldFromTagTemplateFieldName(tagTemplateFieldName)

matchFieldFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the field from TagTemplateField resource.

Parameter

Name	Description
tagTemplateFieldName	string A fully-qualified path representing TagTemplateField resource.

Returns

Type	Description
string | number	{string} A string representing the field.

matchLocationFromEntryGroupName(entryGroupName)

matchLocationFromEntryGroupName(entryGroupName: string): string | number;

Parse the location from EntryGroup resource.

Parameter

Name	Description
entryGroupName	string A fully-qualified path representing EntryGroup resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromEntryName(entryName)

matchLocationFromEntryName(entryName: string): string | number;

Parse the location from Entry resource.

Parameter

Name	Description
entryName	string A fully-qualified path representing Entry resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Name	Description
locationName	string A fully-qualified path representing Location resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromPolicyTagName(policyTagName)

matchLocationFromPolicyTagName(policyTagName: string): string | number;

Parse the location from PolicyTag resource.

Parameter

Name	Description
policyTagName	string A fully-qualified path representing PolicyTag resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromTagName(tagName)

matchLocationFromTagName(tagName: string): string | number;

Parse the location from Tag resource.

Parameter

Name	Description
tagName	string A fully-qualified path representing Tag resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromTagTemplateFieldName(tagTemplateFieldName)

matchLocationFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the location from TagTemplateField resource.

Parameter

Name	Description
tagTemplateFieldName	string A fully-qualified path representing TagTemplateField resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromTagTemplateName(tagTemplateName)

matchLocationFromTagTemplateName(tagTemplateName: string): string | number;

Parse the location from TagTemplate resource.

Parameter

Name	Description
tagTemplateName	string A fully-qualified path representing TagTemplate resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromTaxonomyName(taxonomyName)

matchLocationFromTaxonomyName(taxonomyName: string): string | number;

Parse the location from Taxonomy resource.

Parameter

Name	Description
taxonomyName	string A fully-qualified path representing Taxonomy resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchPolicyTagFromPolicyTagName(policyTagName)

matchPolicyTagFromPolicyTagName(policyTagName: string): string | number;

Parse the policy_tag from PolicyTag resource.

Parameter

Name	Description
policyTagName	string A fully-qualified path representing PolicyTag resource.

Returns

Type	Description
string | number	{string} A string representing the policy_tag.

matchProjectFromEntryGroupName(entryGroupName)

matchProjectFromEntryGroupName(entryGroupName: string): string | number;

Parse the project from EntryGroup resource.

Parameter

Name	Description
entryGroupName	string A fully-qualified path representing EntryGroup resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromEntryName(entryName)

matchProjectFromEntryName(entryName: string): string | number;

Parse the project from Entry resource.

Parameter

Name	Description
entryName	string A fully-qualified path representing Entry resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Name	Description
locationName	string A fully-qualified path representing Location resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromPolicyTagName(policyTagName)

matchProjectFromPolicyTagName(policyTagName: string): string | number;

Parse the project from PolicyTag resource.

Parameter

Name	Description
policyTagName	string A fully-qualified path representing PolicyTag resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Name	Description
projectName	string A fully-qualified path representing Project resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromTagName(tagName)

matchProjectFromTagName(tagName: string): string | number;

Parse the project from Tag resource.

Parameter

Name	Description
tagName	string A fully-qualified path representing Tag resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromTagTemplateFieldName(tagTemplateFieldName)

matchProjectFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the project from TagTemplateField resource.

Parameter

Name	Description
tagTemplateFieldName	string A fully-qualified path representing TagTemplateField resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromTagTemplateName(tagTemplateName)

matchProjectFromTagTemplateName(tagTemplateName: string): string | number;

Parse the project from TagTemplate resource.

Parameter

Name	Description
tagTemplateName	string A fully-qualified path representing TagTemplate resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromTaxonomyName(taxonomyName)

matchProjectFromTaxonomyName(taxonomyName: string): string | number;

Parse the project from Taxonomy resource.

Parameter

Name	Description
taxonomyName	string A fully-qualified path representing Taxonomy resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchTagFromTagName(tagName)

matchTagFromTagName(tagName: string): string | number;

Parse the tag from Tag resource.

Parameter

Name	Description
tagName	string A fully-qualified path representing Tag resource.

Returns

Type	Description
string | number	{string} A string representing the tag.

matchTagTemplateFromTagTemplateFieldName(tagTemplateFieldName)

matchTagTemplateFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the tag_template from TagTemplateField resource.

Parameter

Name	Description
tagTemplateFieldName	string A fully-qualified path representing TagTemplateField resource.

Returns

Type	Description
string | number	{string} A string representing the tag_template.

matchTagTemplateFromTagTemplateName(tagTemplateName)

matchTagTemplateFromTagTemplateName(tagTemplateName: string): string | number;

Parse the tag_template from TagTemplate resource.

Parameter

Name	Description
tagTemplateName	string A fully-qualified path representing TagTemplate resource.

Returns

Type	Description
string | number	{string} A string representing the tag_template.

matchTaxonomyFromPolicyTagName(policyTagName)

matchTaxonomyFromPolicyTagName(policyTagName: string): string | number;

Parse the taxonomy from PolicyTag resource.

Parameter

Name	Description
policyTagName	string A fully-qualified path representing PolicyTag resource.

Returns

Type	Description
string | number	{string} A string representing the taxonomy.

matchTaxonomyFromTaxonomyName(taxonomyName)

matchTaxonomyFromTaxonomyName(taxonomyName: string): string | number;

Parse the taxonomy from Taxonomy resource.

Parameter

Name	Description
taxonomyName	string A fully-qualified path representing Taxonomy resource.

Returns

Type	Description
string | number	{string} A string representing the taxonomy.

policyTagPath(project, location, taxonomy, policyTag)

policyTagPath(project: string, location: string, taxonomy: string, policyTag: string): string;

Return a fully-qualified policyTag resource name string.

Parameters

Name	Description
project	string
location	string
taxonomy	string
policyTag	string

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	string

Returns

Type	Description
string	{string} Resource name string.

renameTagTemplateField(request, options)

renameTagTemplateField(request?: protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, (protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest | undefined), {} | undefined]>;

Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, (protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplateField]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the tag template. Example:
   *  * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
   */
  // const name = 'abc123'
  /**
   *  Required. The new ID of this tag template field. For example, `my_new_field`.
   */
  // const newTagTemplateFieldId = 'abc123'

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

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

  async function callRenameTagTemplateField() {
    // Construct request
    const request = {
      name,
      newTagTemplateFieldId,
    };

    // Run request
    const response = await datacatalogClient.renameTagTemplateField(request);
    console.log(response);
  }

  callRenameTagTemplateField();

renameTagTemplateField(request, options, callback)

renameTagTemplateField(request: protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

renameTagTemplateField(request, callback)

renameTagTemplateField(request: protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.IRenameTagTemplateFieldRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

searchCatalog(request, options)

searchCatalog(request?: protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResult[], protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest | null, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResponse]>;

Searches Data Catalog for multiple resources like entries, tags that match a query.

This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequentally call Get methods.

Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries.

See [Data Catalog Search Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Promise<[protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResult[], protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest | null, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [SearchCatalogResult]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

searchCatalog(request, options, callback)

searchCatalog(request: protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResult>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResult>

Returns

Type	Description
void

searchCatalog(request, callback)

searchCatalog(request: protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResult>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest
callback	PaginationCallback<protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResult>

Returns

Type	Description
void

searchCatalogAsync(request, options)

searchCatalogAsync(request?: protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResult>;

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	Description
request	protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.datacatalog.v1beta1.ISearchCatalogResult>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The scope of this search request. A `scope` that has empty
   *  `include_org_ids`, `include_project_ids` AND false
   *  `include_gcp_public_datasets` is considered invalid. Data Catalog will
   *  return an error in such a case.
   */
  // const scope = {}
  /**
   *  Required. The query string in search query syntax. The query must be non-empty.
   *  Query strings can be simple as "x" or more qualified as:
   *  * name:x
   *  * column:x
   *  * description:y
   *  Note: Query tokens need to have a minimum of 3 characters for substring
   *  matching to work correctly. See Data Catalog Search
   *  Syntax (https://cloud.google.com/data-catalog/docs/how-to/search-reference)
   *  for more information.
   */
  // const query = 'abc123'
  /**
   *  Number of results in the search page. If <=0 then="" defaults="" to="" 10.="" max="" limit="" *="" for="" page_size="" is="" 1000.="" throws="" an="" invalid="" argument="" for="" page_size=""> 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. Pagination token returned in an earlier
   *  SearchCatalogResponse.next_page_token google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token, which
   *  indicates that this is a continuation of a prior
   *  SearchCatalogRequest google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog
   *  call, and that the system should return the next page of data. If empty,
   *  the first page is returned.
   */
  // const pageToken = 'abc123'
  /**
   *  Specifies the ordering of results, currently supported case-sensitive
   *  choices are:
   *    * `relevance`, only supports descending
   *    * `last_modified_timestamp asc|desc`, defaults to descending if not
   *      specified
   *  If not specified, defaults to `relevance` descending.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callSearchCatalog();

searchCatalogStream(request, options)

searchCatalogStream(request?: protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>;

Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

Callers must have following Google IAM permission - datacatalog.tagTemplates.setIamPolicy to set policies on tag templates. - datacatalog.entries.setIamPolicy to set policies on entries. - datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Parameters

Name	Description
request	protos.google.iam.v1.ISetIamPolicyRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy is being specified.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  REQUIRED: The complete policy to be applied to the `resource`. The size of
   *  the policy is limited to a few 10s of KB. An empty policy is a
   *  valid policy but certain Cloud Platform services (such as Projects)
   *  might reject them.
   */
  // const policy = {}

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

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

  async function callSetIamPolicy() {
    // Construct request
    const request = {
      resource,
      policy,
    };

    // Run request
    const response = await datacatalogClient.setIamPolicy(request);
    console.log(response);
  }

  callSetIamPolicy();

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.ISetIamPolicyRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.ISetIamPolicyRequest
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

tagPath(project, location, entryGroup, entry, tag)

tagPath(project: string, location: string, entryGroup: string, entry: string, tag: string): string;

Return a fully-qualified tag resource name string.

Parameters

Name	Description
project	string
location	string
entryGroup	string
entry	string
tag	string

Returns

Type	Description
string	{string} Resource name string.

tagTemplateFieldPath(project, location, tagTemplate, field)

tagTemplateFieldPath(project: string, location: string, tagTemplate: string, field: string): string;

Return a fully-qualified tagTemplateField resource name string.

Parameters

Name	Description
project	string
location	string
tagTemplate	string
field	string

Returns

Type	Description
string	{string} Resource name string.

tagTemplatePath(project, location, tagTemplate)

tagTemplatePath(project: string, location: string, tagTemplate: string): string;

Return a fully-qualified tagTemplate resource name string.

Parameters

Name	Description
project	string
location	string
tagTemplate	string

Returns

Type	Description
string	{string} Resource name string.

taxonomyPath(project, location, taxonomy)

taxonomyPath(project: string, location: string, taxonomy: string): string;

Return a fully-qualified taxonomy resource name string.

Parameters

Name	Description
project	string
location	string
taxonomy	string

Returns

Type	Description
string	{string} Resource name string.

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>;

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

A caller is not required to have Google IAM permission to make this request.

Parameters

Name	Description
request	protos.google.iam.v1.ITestIamPermissionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy detail is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  The set of permissions to check for the `resource`. Permissions with
   *  wildcards (such as '*' or 'storage.*') are not allowed. For more
   *  information see
   *  IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
   */
  // const permissions = 'abc123'

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

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

  async function callTestIamPermissions() {
    // Construct request
    const request = {
      resource,
      permissions,
    };

    // Run request
    const response = await datacatalogClient.testIamPermissions(request);
    console.log(response);
  }

  callTestIamPermissions();

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.ITestIamPermissionsRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.ITestIamPermissionsRequest
callback	Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateEntry(request, options)

updateEntry(request?: protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest | undefined, {} | undefined]>;

Updates an existing entry. Users should enable the Data Catalog API in the project identified by the entry.name parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Entry]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The updated entry. The "name" field must be set.
   */
  // const entry = {}
  /**
   *  The fields to update on the entry. If absent or empty, all modifiable
   *  fields are updated.
   *  The following fields are modifiable:
   *  * For entries with type `DATA_STREAM`:
   *     * `schema`
   *  * For entries with type `FILESET`
   *     * `schema`
   *     * `display_name`
   *     * `description`
   *     * `gcs_fileset_spec`
   *     * `gcs_fileset_spec.file_patterns`
   *  * For entries with `user_specified_type`
   *     * `schema`
   *     * `display_name`
   *     * `description`
   *     * user_specified_type
   *     * user_specified_system
   *     * linked_resource
   *     * source_system_timestamps
   */
  // const updateMask = {}

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

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

  async function callUpdateEntry() {
    // Construct request
    const request = {
      entry,
    };

    // Run request
    const response = await datacatalogClient.updateEntry(request);
    console.log(response);
  }

  callUpdateEntry();

updateEntry(request, options, callback)

updateEntry(request: protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateEntry(request, callback)

updateEntry(request: protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntry, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateEntryGroup(request, options)

updateEntryGroup(request?: protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IEntryGroup, (protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest | undefined), {} | undefined]>;

Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the entry_group.name parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IEntryGroup, (protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [EntryGroup]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The updated entry group. "name" field must be set.
   */
  // const entryGroup = {}
  /**
   *  The fields to update on the entry group. If absent or empty, all modifiable
   *  fields are updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateEntryGroup() {
    // Construct request
    const request = {
      entryGroup,
    };

    // Run request
    const response = await datacatalogClient.updateEntryGroup(request);
    console.log(response);
  }

  callUpdateEntryGroup();

updateEntryGroup(request, options, callback)

updateEntryGroup(request: protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateEntryGroup(request, callback)

updateEntryGroup(request: protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.IEntryGroup, protos.google.cloud.datacatalog.v1beta1.IUpdateEntryGroupRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateTag(request, options)

updateTag(request?: protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest | undefined, {} | undefined]>;

Updates an existing tag.

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest | undefined, {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Tag]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The updated tag. The "name" field must be set.
   */
  // const tag = {}
  /**
   *  The fields to update on the Tag. If absent or empty, all modifiable fields
   *  are updated. Currently the only modifiable field is the field `fields`.
   */
  // const updateMask = {}

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

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

  async function callUpdateTag() {
    // Construct request
    const request = {
      tag,
    };

    // Run request
    const response = await datacatalogClient.updateTag(request);
    console.log(response);
  }

  callUpdateTag();

updateTag(request, options, callback)

updateTag(request: protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateTag(request, callback)

updateTag(request: protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITag, protos.google.cloud.datacatalog.v1beta1.IUpdateTagRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateTagTemplate(request, options)

updateTagTemplate(request?: protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplate, (protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest | undefined), {} | undefined]>;

Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the tag_template.name parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplate, (protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplate]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The template to update. The "name" field must be set.
   */
  // const tagTemplate = {}
  /**
   *  The field mask specifies the parts of the template to overwrite.
   *  Allowed fields:
   *    * `display_name`
   *  If absent or empty, all of the allowed fields above will be updated.
   */
  // const updateMask = {}

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

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

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

    // Run request
    const response = await datacatalogClient.updateTagTemplate(request);
    console.log(response);
  }

  callUpdateTagTemplate();

updateTagTemplate(request, options, callback)

updateTagTemplate(request: protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateTagTemplate(request, callback)

updateTagTemplate(request: protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplate, protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateTagTemplateField(request, options)

updateTagTemplateField(request?: protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, (protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest | undefined), {} | undefined]>;

Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, (protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest | undefined), {} | undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplateField]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the tag template field. Example:
   *  * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
   */
  // const name = 'abc123'
  /**
   *  Required. The template to update.
   */
  // const tagTemplateField = {}
  /**
   *  Optional. The field mask specifies the parts of the template to be updated.
   *  Allowed fields:
   *    * `display_name`
   *    * `type.enum_type`
   *    * `is_required`
   *  If `update_mask` is not set or empty, all of the allowed fields above will
   *  be updated.
   *  When updating an enum type, the provided values will be merged with the
   *  existing values. Therefore, enum values can only be added, existing enum
   *  values cannot be deleted nor renamed. Updating a template field from
   *  optional to required is NOT allowed.
   */
  // const updateMask = {}

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

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

  async function callUpdateTagTemplateField() {
    // Construct request
    const request = {
      name,
      tagTemplateField,
    };

    // Run request
    const response = await datacatalogClient.updateTagTemplateField(request);
    console.log(response);
  }

  callUpdateTagTemplateField();

updateTagTemplateField(request, options, callback)

updateTagTemplateField(request: protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest
options	CallOptions
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateTagTemplateField(request, callback)

updateTagTemplateField(request: protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest
callback	Callback<protos.google.cloud.datacatalog.v1beta1.ITagTemplateField, protos.google.cloud.datacatalog.v1beta1.IUpdateTagTemplateFieldRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void