Class v1.DataCatalogClient

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

Package

@google-cloud/datacatalog!

Constructors

(constructor)(opts)

  constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

Construct an instance of DataCatalogClient.

Parameter

Type	Name	Description
ClientOptions	opts

Properties

apiEndpoint

  static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

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

Property Value

Type	Description
string

auth

  auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;

Property Value

Type	Description
gax. GoogleAuth

dataCatalogStub

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

Property Value

Type	Description
Promise <{ [name: string]: Function ; }>

descriptors

  descriptors 
 : 
  
 Descriptors 
 ;

Property Value

Type	Description
Descriptors

innerApiCalls

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

Property Value

Type	Description
{ [name: string]: Function ; }

pathTemplates

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

Property Value

Type	Description
{ [name: string]: gax. PathTemplate ; }

port

  static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

The port for this API service.

Property Value

Type	Description
number

scopes

  static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

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

Property Value

Type	Description
string[]

servicePath

  static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ;

The DNS address for this API service.

Property Value

Type	Description
string

warn

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

Property Value

Type	Description
(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 
 . 
 v1 
 . 
 ICreateEntryRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IEntry 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 ICreateEntryRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.ICreateEntryRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.IEntry , protos. google.cloud.datacatalog.v1.ICreateEntryRequest \| undefined, {} \| undefined]>

createEntry(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createEntry(request, callback)

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

Parameters

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

Returns

Type	Description
void

createEntryGroup(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.ICreateEntryGroupRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.IEntryGroup , protos. google.cloud.datacatalog.v1.ICreateEntryGroupRequest \| undefined, {} \| undefined]>

createEntryGroup(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createEntryGroup(request, callback)

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

Parameters

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

Returns

Type	Description
void

createTag(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.ICreateTagRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITag , protos. google.cloud.datacatalog.v1.ICreateTagRequest \| undefined, {} \| undefined]>

createTag(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createTag(request, callback)

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

Parameters

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

Returns

Type	Description
void

createTagTemplate(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.ICreateTagTemplateRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITagTemplate , protos. google.cloud.datacatalog.v1.ICreateTagTemplateRequest \| undefined, {} \| undefined]>

createTagTemplate(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createTagTemplate(request, callback)

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

Parameters

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

Returns

Type	Description
void

createTagTemplateField(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.ICreateTagTemplateFieldRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITagTemplateField , (protos. google.cloud.datacatalog.v1.ICreateTagTemplateFieldRequest \| undefined), {} \| undefined]>

createTagTemplateField(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createTagTemplateField(request, callback)

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

Parameters

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

Returns

Type	Description
void

deleteEntry(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IDeleteEntryRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.datacatalog.v1.IDeleteEntryRequest \| undefined, {} \| undefined]>

deleteEntry(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

deleteEntry(request, callback)

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

Parameters

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

Returns

Type	Description
void

deleteEntryGroup(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IDeleteEntryGroupRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.datacatalog.v1.IDeleteEntryGroupRequest \| undefined, {} \| undefined]>

deleteEntryGroup(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

deleteEntryGroup(request, callback)

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

Parameters

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

Returns

Type	Description
void

deleteTag(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IDeleteTagRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.datacatalog.v1.IDeleteTagRequest \| undefined, {} \| undefined]>

deleteTag(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

deleteTag(request, callback)

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

Parameters

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

Returns

Type	Description
void

deleteTagTemplate(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IDeleteTagTemplateRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.datacatalog.v1.IDeleteTagTemplateRequest \| undefined, {} \| undefined]>

deleteTagTemplate(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

deleteTagTemplate(request, callback)

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

Parameters

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

Returns

Type	Description
void

deleteTagTemplateField(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IDeleteTagTemplateFieldRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.protobuf.IEmpty , (protos. google.cloud.datacatalog.v1.IDeleteTagTemplateFieldRequest \| undefined), {} \| undefined]>

deleteTagTemplateField(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

deleteTagTemplateField(request, callback)

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

Parameters

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

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

Type	Name	Description
string	project
string	location
string	entryGroup

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

Type	Name	Description
string	project
string	location
string	entryGroup
string	entry

Returns

Type	Description
string	{string} Resource name string.

getEntry(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IGetEntryRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.IEntry , protos. google.cloud.datacatalog.v1.IGetEntryRequest \| undefined, {} \| undefined]>

getEntry(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

getEntry(request, callback)

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

Parameters

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

Returns

Type	Description
void

getEntryGroup(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IGetEntryGroupRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.IEntryGroup , protos. google.cloud.datacatalog.v1.IGetEntryGroupRequest \| undefined, {} \| undefined]>

getEntryGroup(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

getEntryGroup(request, callback)

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

Parameters

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

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 
 ]>;

Parameters

Type	Name	Description
protos. google.iam.v1.IGetIamPolicyRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.iam.v1.IPolicy , protos. google.iam.v1.IGetIamPolicyRequest \| undefined, {} \| undefined]>

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

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

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

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

Returns

Type	Description
void

getProjectId()

  getProjectId 
 () 
 : 
  
 Promise<string> 
 ;

Returns

Type	Description
Promise <string>

getProjectId(callback)

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

Parameter

Type	Name	Description
Callback <string, undefined, undefined>	callback

Returns

Type	Description
void

getTagTemplate(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IGetTagTemplateRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITagTemplate , protos. google.cloud.datacatalog.v1.IGetTagTemplateRequest \| undefined, {} \| undefined]>

getTagTemplate(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

getTagTemplate(request, callback)

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

Parameters

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

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 
 . 
 v1 
 . 
 IListEntriesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IEntry 
 [], 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IListEntriesRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IListEntriesResponse 
 ]>;

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IListEntriesRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.IEntry [], protos. google.cloud.datacatalog.v1.IListEntriesRequest \| null, protos. google.cloud.datacatalog.v1.IListEntriesResponse ]>

listEntries(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

listEntries(request, callback)

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

Parameters

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

Returns

Type	Description
void

listEntriesAsync(request, options)

  listEntriesAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IListEntriesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 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

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

Returns

Type	Description
AsyncIterable <protos. google.cloud.datacatalog.v1.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.

listEntriesStream(request, options)

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

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IListEntriesRequest	request	The request object that will be sent.
CallOptions	options	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 
 . 
 v1 
 . 
 IListEntryGroupsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IEntryGroup 
 [], 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IListEntryGroupsRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IListEntryGroupsResponse 
 ]>;

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IListEntryGroupsRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.IEntryGroup [], protos. google.cloud.datacatalog.v1.IListEntryGroupsRequest \| null, protos. google.cloud.datacatalog.v1.IListEntryGroupsResponse ]>

listEntryGroups(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

listEntryGroups(request, callback)

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

Parameters

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

Returns

Type	Description
void

listEntryGroupsAsync(request, options)

  listEntryGroupsAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IListEntryGroupsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 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

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

Returns

Type	Description
AsyncIterable <protos. google.cloud.datacatalog.v1.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.

listEntryGroupsStream(request, options)

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

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IListEntryGroupsRequest	request	The request object that will be sent.
CallOptions	options	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 
 . 
 v1 
 . 
 IListTagsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 ITag 
 [], 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IListTagsRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IListTagsResponse 
 ]>;

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IListTagsRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITag [], protos. google.cloud.datacatalog.v1.IListTagsRequest \| null, protos. google.cloud.datacatalog.v1.IListTagsResponse ]>

listTags(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

listTags(request, callback)

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

Parameters

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

Returns

Type	Description
void

listTagsAsync(request, options)

  listTagsAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IListTagsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 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

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

Returns

Type	Description
AsyncIterable <protos. google.cloud.datacatalog.v1.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.

listTagsStream(request, options)

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

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IListTagsRequest	request	The request object that will be sent.
CallOptions	options	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

Type	Name	Description
string	project
string	location

Returns

Type	Description
string	{string} Resource name string.

lookupEntry(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.ILookupEntryRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.IEntry , protos. google.cloud.datacatalog.v1.ILookupEntryRequest \| undefined, {} \| undefined]>

lookupEntry(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

lookupEntry(request, callback)

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

Parameters

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

Returns

Type	Description
void

matchEntryFromEntryName(entryName)

  matchEntryFromEntryName 
 ( 
 entryName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the entry from Entry resource.

Parameter

Type	Name	Description
string	entryName	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

Type	Name	Description
string	tagName	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

Type	Name	Description
string	entryGroupName	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

Type	Name	Description
string	entryName	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

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

Returns

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

matchEnumValueDisplayNameFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName)

  matchEnumValueDisplayNameFromTagTemplateFieldEnumValueName 
 ( 
 tagTemplateFieldEnumValueName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the enum_value_display_name from TagTemplateFieldEnumValue resource.

Parameter

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

Returns

Type	Description
string \| number	{string} A string representing the enum_value_display_name.

matchFieldFromTagTemplateFieldName(tagTemplateFieldName)

  matchFieldFromTagTemplateFieldName 
 ( 
 tagTemplateFieldName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the field from TagTemplateField resource.

Parameter

Type	Name	Description
string	tagTemplateFieldName	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

Type	Name	Description
string	entryGroupName	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

Type	Name	Description
string	entryName	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

Type	Name	Description
string	locationName	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

Type	Name	Description
string	policyTagName	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

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

Returns

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

matchLocationFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName)

  matchLocationFromTagTemplateFieldEnumValueName 
 ( 
 tagTemplateFieldEnumValueName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the location from TagTemplateFieldEnumValue resource.

Parameter

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

Type	Name	Description
string	tagTemplateFieldName	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

Type	Name	Description
string	tagTemplateName	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

Type	Name	Description
string	taxonomyName	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

Type	Name	Description
string	policyTagName	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

Type	Name	Description
string	entryGroupName	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

Type	Name	Description
string	entryName	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

Type	Name	Description
string	locationName	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

Type	Name	Description
string	policyTagName	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

Type	Name	Description
string	projectName	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

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

Returns

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

matchProjectFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName)

  matchProjectFromTagTemplateFieldEnumValueName 
 ( 
 tagTemplateFieldEnumValueName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from TagTemplateFieldEnumValue resource.

Parameter

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

Type	Name	Description
string	tagTemplateFieldName	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

Type	Name	Description
string	tagTemplateName	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

Type	Name	Description
string	taxonomyName	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

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

Returns

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

matchTagTemplateFieldIdFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName)

  matchTagTemplateFieldIdFromTagTemplateFieldEnumValueName 
 ( 
 tagTemplateFieldEnumValueName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the tag_template_field_id from TagTemplateFieldEnumValue resource.

Parameter

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

Returns

Type	Description
string \| number	{string} A string representing the tag_template_field_id.

matchTagTemplateFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName)

  matchTagTemplateFromTagTemplateFieldEnumValueName 
 ( 
 tagTemplateFieldEnumValueName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the tag_template from TagTemplateFieldEnumValue resource.

Parameter

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

Returns

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

matchTagTemplateFromTagTemplateFieldName(tagTemplateFieldName)

  matchTagTemplateFromTagTemplateFieldName 
 ( 
 tagTemplateFieldName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the tag_template from TagTemplateField resource.

Parameter

Type	Name	Description
string	tagTemplateFieldName	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

Type	Name	Description
string	tagTemplateName	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

Type	Name	Description
string	policyTagName	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

Type	Name	Description
string	taxonomyName	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

Type	Name	Description
string	project
string	location
string	taxonomy
string	policyTag

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

  projectPath 
 ( 
 project 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified project resource name string.

Parameter

Type	Name	Description
string	project

Returns

Type	Description
string	{string} Resource name string.

renameTagTemplateField(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITagTemplateField , (protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldRequest \| undefined), {} \| undefined]>

renameTagTemplateField(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

renameTagTemplateField(request, callback)

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

Parameters

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

Returns

Type	Description
void

renameTagTemplateFieldEnumValue(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITagTemplateField , (protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest \| undefined), {} \| undefined]>

renameTagTemplateFieldEnumValue(request, options, callback)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest	request
CallOptions	options
Callback <protos. google.cloud.datacatalog.v1.ITagTemplateField , protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

renameTagTemplateFieldEnumValue(request, callback)

  renameTagTemplateFieldEnumValue 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IRenameTagTemplateFieldEnumValueRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 ITagTemplateField 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 IRenameTagTemplateFieldEnumValueRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest	request
Callback <protos. google.cloud.datacatalog.v1.ITagTemplateField , protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest \| null \| undefined, {} \| null \| undefined>	callback

Returns

Type	Description
void

searchCatalog(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.ISearchCatalogRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ISearchCatalogResult [], protos. google.cloud.datacatalog.v1.ISearchCatalogRequest \| null, protos. google.cloud.datacatalog.v1.ISearchCatalogResponse ]>

searchCatalog(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

searchCatalog(request, callback)

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

Parameters

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

Returns

Type	Description
void

searchCatalogAsync(request, options)

  searchCatalogAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 ISearchCatalogRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 datacatalog 
 . 
 v1 
 . 
 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

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

Returns

Type	Description
AsyncIterable <protos. google.cloud.datacatalog.v1.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.

searchCatalogStream(request, options)

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

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.ISearchCatalogRequest	request	The request object that will be sent.
CallOptions	options	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 
 ]>;

Parameters

Type	Name	Description
protos. google.iam.v1.ISetIamPolicyRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.iam.v1.IPolicy , protos. google.iam.v1.ISetIamPolicyRequest \| undefined, {} \| undefined]>

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

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

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

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

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

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

Returns

Type	Description
string	{string} Resource name string.

tagTemplateFieldEnumValuePath(project, location, tagTemplate, tagTemplateFieldId, enumValueDisplayName)

  tagTemplateFieldEnumValuePath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 tagTemplate 
 : 
  
 string 
 , 
  
 tagTemplateFieldId 
 : 
  
 string 
 , 
  
 enumValueDisplayName 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified tagTemplateFieldEnumValue resource name string.

Parameters

Type	Name	Description
string	project
string	location
string	tagTemplate
string	tagTemplateFieldId
string	enumValueDisplayName

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

Type	Name	Description
string	project
string	location
string	tagTemplate
string	field

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

Type	Name	Description
string	project
string	location
string	tagTemplate

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

Type	Name	Description
string	project
string	location
string	taxonomy

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 
 ]>;

Parameters

Type	Name	Description
protos. google.iam.v1.ITestIamPermissionsRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.iam.v1.ITestIamPermissionsResponse , protos. google.iam.v1.ITestIamPermissionsRequest \| undefined, {} \| undefined]>

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

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

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

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

Returns

Type	Description
void

updateEntry(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IUpdateEntryRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.IEntry , protos. google.cloud.datacatalog.v1.IUpdateEntryRequest \| undefined, {} \| undefined]>

updateEntry(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

updateEntry(request, callback)

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

Parameters

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

Returns

Type	Description
void

updateEntryGroup(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IUpdateEntryGroupRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.IEntryGroup , protos. google.cloud.datacatalog.v1.IUpdateEntryGroupRequest \| undefined, {} \| undefined]>

updateEntryGroup(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

updateEntryGroup(request, callback)

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

Parameters

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

Returns

Type	Description
void

updateTag(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IUpdateTagRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITag , protos. google.cloud.datacatalog.v1.IUpdateTagRequest \| undefined, {} \| undefined]>

updateTag(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

updateTag(request, callback)

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

Parameters

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

Returns

Type	Description
void

updateTagTemplate(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IUpdateTagTemplateRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITagTemplate , protos. google.cloud.datacatalog.v1.IUpdateTagTemplateRequest \| undefined, {} \| undefined]>

updateTagTemplate(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

updateTagTemplate(request, callback)

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

Parameters

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

Returns

Type	Description
void

updateTagTemplateField(request, options)

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

Parameters

Type	Name	Description
protos. google.cloud.datacatalog.v1.IUpdateTagTemplateFieldRequest	request
CallOptions	options

Returns

Type	Description
Promise <[protos. google.cloud.datacatalog.v1.ITagTemplateField , (protos. google.cloud.datacatalog.v1.IUpdateTagTemplateFieldRequest \| undefined), {} \| undefined]>

updateTagTemplateField(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

updateTagTemplateField(request, callback)

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

Parameters

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

Returns

Type	Description
void

Class v1.DataCatalogClient Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(opts)

Properties

apiEndpoint

auth

dataCatalogStub

descriptors

innerApiCalls

pathTemplates

port

scopes

servicePath

warn

Methods

close()

createEntry(request, options)

createEntry(request, options, callback)

createEntry(request, callback)

createEntryGroup(request, options)

createEntryGroup(request, options, callback)

createEntryGroup(request, callback)

createTag(request, options)

createTag(request, options, callback)

createTag(request, callback)

createTagTemplate(request, options)

createTagTemplate(request, options, callback)

createTagTemplate(request, callback)

createTagTemplateField(request, options)

createTagTemplateField(request, options, callback)

createTagTemplateField(request, callback)

deleteEntry(request, options)

deleteEntry(request, options, callback)

deleteEntry(request, callback)

deleteEntryGroup(request, options)

deleteEntryGroup(request, options, callback)

deleteEntryGroup(request, callback)

deleteTag(request, options)

deleteTag(request, options, callback)

deleteTag(request, callback)

deleteTagTemplate(request, options)

deleteTagTemplate(request, options, callback)

deleteTagTemplate(request, callback)

deleteTagTemplateField(request, options)

deleteTagTemplateField(request, options, callback)

deleteTagTemplateField(request, callback)

entryGroupPath(project, location, entryGroup)

entryPath(project, location, entryGroup, entry)

getEntry(request, options)

getEntry(request, options, callback)

getEntry(request, callback)

getEntryGroup(request, options)

getEntryGroup(request, options, callback)

getEntryGroup(request, callback)

getIamPolicy(request, options)

getIamPolicy(request, options, callback)

getIamPolicy(request, callback)

getProjectId()

getProjectId(callback)

getTagTemplate(request, options)

getTagTemplate(request, options, callback)

getTagTemplate(request, callback)

initialize()

listEntries(request, options)

listEntries(request, options, callback)

listEntries(request, callback)

listEntriesAsync(request, options)

listEntriesStream(request, options)

listEntryGroups(request, options)

listEntryGroups(request, options, callback)

listEntryGroups(request, callback)

listEntryGroupsAsync(request, options)

listEntryGroupsStream(request, options)

listTags(request, options)

listTags(request, options, callback)

listTags(request, callback)

listTagsAsync(request, options)

listTagsStream(request, options)

locationPath(project, location)

Class v1.DataCatalogClient