Data Catalog API service allows you to discover, understand, and manage your data. v1
Package
@google-cloud/datacatalogConstructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of DataCatalogClient.
| Name | Description |
|---|---|
| opts | ClientOptions
|
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
dataCatalogStub
dataCatalogStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| 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
]>;
Creates an entry.
You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.
You must enable the Data Catalog API in the project identified by the parent
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
An entry group can have a maximum of 100,000 entries.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.ICreateEntryRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.IEntry , protos. google.cloud.datacatalog.v1.ICreateEntryRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Entry]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entry group this entry belongs to.
* Note: The entry itself and its child resources might not be stored in
* the location specified in its name.
*/
// const parent = 'abc123'
/**
* Required. The ID of the entry to create.
* The ID must contain only letters (a-z, A-Z), numbers (0-9),
* and underscores (_).
* The maximum size is 64 bytes when encoded in UTF-8.
*/
// const entryId = 'abc123'
/**
* Required. The entry to create.
*/
// const entry = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callCreateEntry
()
{
// Construct request
const
request
=
{
parent
,
entryId
,
entry
,
};
// Run request
const
response
=
await
datacatalogClient
.
createEntry
(
request
);
console
.
log
(
response
);
}
callCreateEntry
();
createEntry(request, options, callback)
createEntry
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateEntryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
IEntry
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateEntryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Creates an entry group.
An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups.
Data Catalog automatically creates entry groups with names that start with the @
symbol for the following resources:
* BigQuery entries ( @bigquery
) * Pub/Sub topics ( @pubsub
) * Dataproc Metastore services ( @dataproc_metastore_{SERVICE_NAME_HASH}
)
You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @
symbol, it is reserved for automatically created groups.
Entry groups, like entries, can be searched.
A maximum of 10,000 entry groups may be created per organization across all locations.
You must enable the Data Catalog API in the project identified by the parent
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.ICreateEntryGroupRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.IEntryGroup , protos. google.cloud.datacatalog.v1.ICreateEntryGroupRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [EntryGroup]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The names of the project and location that the new entry group belongs to.
* Note: The entry group itself and its child resources might not be
* stored in the location specified in its name.
*/
// const parent = 'abc123'
/**
* Required. The ID of the entry group to create.
* The ID must contain only letters (a-z, A-Z), numbers (0-9),
* underscores (_), and must start with a letter or underscore.
* The maximum size is 64 bytes when encoded in UTF-8.
*/
// const entryGroupId = 'abc123'
/**
* The entry group to create. Defaults to empty.
*/
// const entryGroup = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callCreateEntryGroup
()
{
// Construct request
const
request
=
{
parent
,
entryGroupId
,
};
// Run request
const
response
=
await
datacatalogClient
.
createEntryGroup
(
request
);
console
.
log
(
response
);
}
callCreateEntryGroup
();
createEntryGroup(request, options, callback)
createEntryGroup
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateEntryGroupRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
IEntryGroup
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateEntryGroupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Creates a tag and assigns it to:
* An if the method name is projects.locations.entryGroups.entries.tags.create
. * Or if the method name is projects.locations.entryGroups.tags.create
.
Note: The project identified by the parent
parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.ICreateTagRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITag , protos. google.cloud.datacatalog.v1.ICreateTagRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Tag]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the resource to attach this tag to.
* Tags can be attached to entries or entry groups. An entry can have up to
* 1000 attached tags.
* Note: The tag and its child resources might not be stored in
* the location specified in its name.
*/
// const parent = 'abc123'
/**
* Required. The tag to create.
*/
// const tag = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callCreateTag
()
{
// Construct request
const
request
=
{
parent
,
tag
,
};
// Run request
const
response
=
await
datacatalogClient
.
createTag
(
request
);
console
.
log
(
response
);
}
callCreateTag
();
createTag(request, options, callback)
createTag
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateTagRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
ITag
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateTagRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Creates a tag template.
You must enable the Data Catalog API in the project identified by the parent
parameter. For more information, see [Data Catalog resource project] ( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.ICreateTagTemplateRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITagTemplate , protos. google.cloud.datacatalog.v1.ICreateTagTemplateRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplate]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the project and the template location
* region (https://cloud.google.com/data-catalog/docs/concepts/regions).
*/
// const parent = 'abc123'
/**
* Required. The ID of the tag template to create.
* The ID must contain only lowercase letters (a-z), numbers (0-9),
* or underscores (_), and must start with a letter or underscore.
* The maximum size is 64 bytes when encoded in UTF-8.
*/
// const tagTemplateId = 'abc123'
/**
* Required. The tag template to create.
*/
// const tagTemplate = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callCreateTagTemplate
()
{
// Construct request
const
request
=
{
parent
,
tagTemplateId
,
tagTemplate
,
};
// Run request
const
response
=
await
datacatalogClient
.
createTagTemplate
(
request
);
console
.
log
(
response
);
}
callCreateTagTemplate
();
createTagTemplate(request, options, callback)
createTagTemplate
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateTagTemplateRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
ITagTemplate
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateTagTemplateRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Creates a field in a tag template.
You must enable the Data Catalog API in the project identified by the parent
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.ICreateTagTemplateFieldRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITagTemplateField , (protos. google.cloud.datacatalog.v1.ICreateTagTemplateFieldRequest | undefined), {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplateField]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the project and the template location
* region (https://cloud.google.com/data-catalog/docs/concepts/regions).
*/
// const parent = 'abc123'
/**
* Required. The ID of the tag template field to create.
* Note: Adding a required field to an existing template is *not* allowed.
* Field IDs can contain letters (both uppercase and lowercase), numbers
* (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
* character long and at most 128 characters long. Field IDs must also be
* unique within their template.
*/
// const tagTemplateFieldId = 'abc123'
/**
* Required. The tag template field to create.
*/
// const tagTemplateField = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callCreateTagTemplateField
()
{
// Construct request
const
request
=
{
parent
,
tagTemplateFieldId
,
tagTemplateField
,
};
// Run request
const
response
=
await
datacatalogClient
.
createTagTemplateField
(
request
);
console
.
log
(
response
);
}
callCreateTagTemplateField
();
createTagTemplateField(request, options, callback)
createTagTemplateField
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateTagTemplateFieldRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
ITagTemplateField
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ICreateTagTemplateFieldRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Deletes an existing entry.
You can delete only the entries created by the method.
You must enable the Data Catalog API in the project identified by the name
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteEntryRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.datacatalog.v1.IDeleteEntryRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entry to delete.
*/
// const name = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callDeleteEntry
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datacatalogClient
.
deleteEntry
(
request
);
console
.
log
(
response
);
}
callDeleteEntry
();
deleteEntry(request, options, callback)
deleteEntry
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteEntryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteEntryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteEntryRequest
|
| callback | Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.datacatalog.v1.IDeleteEntryRequest
| null | undefined, {} | null | undefined>
|
| 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
]>;
Deletes an entry group.
You must enable the Data Catalog API in the project identified by the name
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteEntryGroupRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.datacatalog.v1.IDeleteEntryGroupRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entry group to delete.
*/
// const name = 'abc123'
/**
* Optional. If true, deletes all entries in the entry group.
*/
// const force = true
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callDeleteEntryGroup
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datacatalogClient
.
deleteEntryGroup
(
request
);
console
.
log
(
response
);
}
callDeleteEntryGroup
();
deleteEntryGroup(request, options, callback)
deleteEntryGroup
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteEntryGroupRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteEntryGroupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteEntryGroupRequest
|
| callback | Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.datacatalog.v1.IDeleteEntryGroupRequest
| null | undefined, {} | null | undefined>
|
| 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
]>;
Deletes a tag.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteTagRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.datacatalog.v1.IDeleteTagRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the tag to delete.
*/
// const name = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callDeleteTag
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datacatalogClient
.
deleteTag
(
request
);
console
.
log
(
response
);
}
callDeleteTag
();
deleteTag(request, options, callback)
deleteTag
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteTagRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteTagRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteTagRequest
|
| callback | Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.datacatalog.v1.IDeleteTagRequest
| null | undefined, {} | null | undefined>
|
| 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
]>;
Deletes a tag template and all tags that use it.
You must enable the Data Catalog API in the project identified by the name
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteTagTemplateRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.datacatalog.v1.IDeleteTagTemplateRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the tag template to delete.
*/
// const name = 'abc123'
/**
* Required. If true, deletes all tags that use this template.
* Currently, `true` is the only supported value.
*/
// const force = true
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callDeleteTagTemplate
()
{
// Construct request
const
request
=
{
name
,
force
,
};
// Run request
const
response
=
await
datacatalogClient
.
deleteTagTemplate
(
request
);
console
.
log
(
response
);
}
callDeleteTagTemplate
();
deleteTagTemplate(request, options, callback)
deleteTagTemplate
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteTagTemplateRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteTagTemplateRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteTagTemplateRequest
|
| callback | Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.datacatalog.v1.IDeleteTagTemplateRequest
| null | undefined, {} | null | undefined>
|
| 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
]>;
Deletes a field in a tag template and all uses of this field from the tags based on this template.
You must enable the Data Catalog API in the project identified by the name
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteTagTemplateFieldRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.protobuf.IEmpty , (protos. google.cloud.datacatalog.v1.IDeleteTagTemplateFieldRequest | undefined), {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the tag template field to delete.
*/
// const name = 'abc123'
/**
* Required. If true, deletes this field from any tags that use it.
* Currently, `true` is the only supported value.
*/
// const force = true
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callDeleteTagTemplateField
()
{
// Construct request
const
request
=
{
name
,
force
,
};
// Run request
const
response
=
await
datacatalogClient
.
deleteTagTemplateField
(
request
);
console
.
log
(
response
);
}
callDeleteTagTemplateField
();
deleteTagTemplateField(request, options, callback)
deleteTagTemplateField
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteTagTemplateFieldRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IDeleteTagTemplateFieldRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IDeleteTagTemplateFieldRequest
|
| callback | Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.datacatalog.v1.IDeleteTagTemplateFieldRequest
| null | undefined, {} | null | undefined>
|
| Type | Description |
|---|---|
| void |
entryGroupPath(project, location, entryGroup)
entryGroupPath
(
project
:
string
,
location
:
string
,
entryGroup
:
string
)
:
string
;
Return a fully-qualified entryGroup resource name string.
| Name | Description |
|---|---|
| project | string
|
| location | string
|
| entryGroup | string
|
| 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.
| Name | Description |
|---|---|
| project | string
|
| location | string
|
| entryGroup | string
|
| entry | string
|
| 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
]>;
Gets an entry.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IGetEntryRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.IEntry , protos. google.cloud.datacatalog.v1.IGetEntryRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Entry]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entry to get.
*/
// const name = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callGetEntry
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datacatalogClient
.
getEntry
(
request
);
console
.
log
(
response
);
}
callGetEntry
();
getEntry(request, options, callback)
getEntry
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IGetEntryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
IEntry
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IGetEntryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Gets an entry group.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IGetEntryGroupRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.IEntryGroup , protos. google.cloud.datacatalog.v1.IGetEntryGroupRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [EntryGroup]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entry group to get.
*/
// const name = 'abc123'
/**
* The fields to return. If empty or omitted, all fields are returned.
*/
// const readMask = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callGetEntryGroup
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datacatalogClient
.
getEntryGroup
(
request
);
console
.
log
(
response
);
}
callGetEntryGroup
();
getEntryGroup(request, options, callback)
getEntryGroup
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IGetEntryGroupRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
IEntryGroup
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IGetEntryGroupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| Type | Description |
|---|---|
| void |
getIamPolicy(request, options)
getIamPolicy
(
request
?:
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
|
undefined
,
{}
|
undefined
]>;
Gets the access control policy for a resource.
May return:
* A NOT_FOUND
error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy.
Supported resources are:
- Tag templates - Entry groups
Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.
To call this method, you must have the following Google IAM permissions:
-
datacatalog.tagTemplates.getIamPolicyto get policies on tag templates. -datacatalog.entryGroups.getIamPolicyto get policies on entry groups.
| Name | Description |
| request | protos. google.iam.v1.IGetIamPolicyRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.iam.v1.IPolicy , protos. google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to
* `GetIamPolicy`. This field is only used by Cloud IAM.
*/
// const options = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callGetIamPolicy
()
{
// Construct request
const
request
=
{
resource
,
};
// Run request
const
response
=
await
datacatalogClient
.
getIamPolicy
(
request
);
console
.
log
(
response
);
}
callGetIamPolicy
();
getIamPolicy(request, options, callback)
getIamPolicy
(
request
:
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| request | protos. google.iam.v1.IGetIamPolicyRequest
|
| options | CallOptions
|
| callback | Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.IGetIamPolicyRequest
| null | undefined, {} | null | undefined>
|
| 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
;
| Name | Description |
| request | protos. google.iam.v1.IGetIamPolicyRequest
|
| callback | Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.IGetIamPolicyRequest
| null | undefined, {} | null | undefined>
|
| Type | Description |
|---|---|
| void |
getProjectId()
getProjectId
()
:
Promise<string>
;
| Type | Description |
|---|---|
| Promise <string> |
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
| Name | Description |
| callback | Callback
<string, undefined, undefined>
|
| 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
]>;
Gets a tag template.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IGetTagTemplateRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITagTemplate , protos. google.cloud.datacatalog.v1.IGetTagTemplateRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplate]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the tag template to get.
*/
// const name = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callGetTagTemplate
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
datacatalogClient
.
getTagTemplate
(
request
);
console
.
log
(
response
);
}
callGetTagTemplate
();
getTagTemplate(request, options, callback)
getTagTemplate
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IGetTagTemplateRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
ITagTemplate
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IGetTagTemplateRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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.
| 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
]>;
Lists entries.
Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use .
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IListEntriesRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.IEntry [], protos. google.cloud.datacatalog.v1.IListEntriesRequest | null, protos. google.cloud.datacatalog.v1.IListEntriesResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Entry]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
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
;
| Name | Description |
| 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
>
|
| 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
;
| Name | Description |
| 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
>
|
| 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.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IListEntriesRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| 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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entry group that contains the entries to list.
* Can be provided in URL format.
*/
// const parent = 'abc123'
/**
* The maximum number of items to return. Default is 10. Maximum limit is
* 1000. Throws an invalid argument if `page_size` is more than 1000.
*/
// const pageSize = 1234
/**
* Pagination token that specifies the next page to return. If empty, the
* first page is returned.
*/
// const pageToken = 'abc123'
/**
* The fields to return for each entry. If empty or omitted, all
* fields are returned.
* For example, to return a list of entries with only the `name` field,
* set `read_mask` to only one path with the `name` value.
*/
// const readMask = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callListEntries
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
datacatalogClient
.
listEntriesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListEntries
();
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.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IListEntriesRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| 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 |
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
]>;
Lists entry groups.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IListEntryGroupsRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.IEntryGroup [], protos. google.cloud.datacatalog.v1.IListEntryGroupsRequest | null, protos. google.cloud.datacatalog.v1.IListEntryGroupsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [EntryGroup]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
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
;
| Name | Description |
| 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
>
|
| 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
;
| Name | Description |
| 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
>
|
| 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.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IListEntryGroupsRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| 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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the location that contains the entry groups to list.
* Can be provided as a URL.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of items to return.
* Default is 10. Maximum limit is 1000.
* Throws an invalid argument if `page_size` is greater than 1000.
*/
// const pageSize = 1234
/**
* Optional. Pagination token that specifies the next page to return.
* If empty, returns the first page.
*/
// const pageToken = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callListEntryGroups
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
datacatalogClient
.
listEntryGroupsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListEntryGroups
();
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.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IListEntryGroupsRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| 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 |
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
]>;
Lists tags assigned to an .
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IListTagsRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITag [], protos. google.cloud.datacatalog.v1.IListTagsRequest | null, protos. google.cloud.datacatalog.v1.IListTagsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Tag]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
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
;
| Name | Description |
| 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
>
|
| 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
;
| Name | Description |
| 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
>
|
| 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.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IListTagsRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| 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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the Data Catalog resource to list the tags of.
* The resource can be an Entry google.cloud.datacatalog.v1.Entry
* or an EntryGroup google.cloud.datacatalog.v1.EntryGroup
* (without `/entries/{entries}` at the end).
*/
// const parent = 'abc123'
/**
* The maximum number of tags to return. Default is 10. Maximum limit is 1000.
*/
// const pageSize = 1234
/**
* Pagination token that specifies the next page to return. If empty, the
* first page is returned.
*/
// const pageToken = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callListTags
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
datacatalogClient
.
listTagsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListTags
();
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.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IListTagsRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| 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 |
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
| Name | Description |
|---|---|
| project | string
|
| location | string
|
| 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
]>;
Gets an entry by its target resource name.
The resource name comes from the source Google Cloud Platform service.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.ILookupEntryRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.IEntry , protos. google.cloud.datacatalog.v1.ILookupEntryRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Entry]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The full name of the Google Cloud Platform resource the Data Catalog
* entry represents. For more information, see Full Resource Name
* (https://cloud.google.com/apis/design/resource_names#full_resource_name).
* Full names are case-sensitive. For example:
* * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
* * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
*/
// const linkedResource = 'abc123'
/**
* The SQL name of the entry. SQL names are case-sensitive.
* Examples:
* * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`
* * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\`
* * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`
* * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`
* * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}`
* Identifiers (`*_ID`) should comply with the
* Lexical structure in Standard SQL
* (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
*/
// const sqlResource = 'abc123'
/**
* Fully qualified name (FQN) of the resource.
* FQNs take two forms:
* * For non-regionalized resources:
* `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
* * For regionalized resources:
* `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
* Example for a DPMS table:
* `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
*/
// const fullyQualifiedName = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callLookupEntry
()
{
// Construct request
const
request
=
{};
// Run request
const
response
=
await
datacatalogClient
.
lookupEntry
(
request
);
console
.
log
(
response
);
}
callLookupEntry
();
lookupEntry(request, options, callback)
lookupEntry
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ILookupEntryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
IEntry
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
ILookupEntryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| Type | Description |
|---|---|
| void |
matchEntryFromEntryName(entryName)
matchEntryFromEntryName
(
entryName
:
string
)
:
string
|
number
;
Parse the entry from Entry resource.
| Name | Description |
| entryName | string
A fully-qualified path representing Entry resource. |
| Type | Description |
| string | number | {string} A string representing the entry. |
matchEntryFromTagName(tagName)
matchEntryFromTagName
(
tagName
:
string
)
:
string
|
number
;
Parse the entry from Tag resource.
| Name | Description |
| tagName | string
A fully-qualified path representing Tag resource. |
| Type | Description |
| string | number | {string} A string representing the entry. |
matchEntryGroupFromEntryGroupName(entryGroupName)
matchEntryGroupFromEntryGroupName
(
entryGroupName
:
string
)
:
string
|
number
;
Parse the entry_group from EntryGroup resource.
| Name | Description |
| entryGroupName | string
A fully-qualified path representing EntryGroup resource. |
| 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.
| Name | Description |
| entryName | string
A fully-qualified path representing Entry resource. |
| 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.
| Name | Description |
| tagName | string
A fully-qualified path representing Tag resource. |
| 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.
| Name | Description |
| tagTemplateFieldEnumValueName | string
A fully-qualified path representing TagTemplateFieldEnumValue resource. |
| 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.
| Name | Description |
| tagTemplateFieldName | string
A fully-qualified path representing TagTemplateField resource. |
| Type | Description |
| string | number | {string} A string representing the field. |
matchLocationFromEntryGroupName(entryGroupName)
matchLocationFromEntryGroupName
(
entryGroupName
:
string
)
:
string
|
number
;
Parse the location from EntryGroup resource.
| Name | Description |
| entryGroupName | string
A fully-qualified path representing EntryGroup resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromEntryName(entryName)
matchLocationFromEntryName
(
entryName
:
string
)
:
string
|
number
;
Parse the location from Entry resource.
| Name | Description |
| entryName | string
A fully-qualified path representing Entry resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
| Name | Description |
| locationName | string
A fully-qualified path representing Location resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromPolicyTagName(policyTagName)
matchLocationFromPolicyTagName
(
policyTagName
:
string
)
:
string
|
number
;
Parse the location from PolicyTag resource.
| Name | Description |
| policyTagName | string
A fully-qualified path representing PolicyTag resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromTagName(tagName)
matchLocationFromTagName
(
tagName
:
string
)
:
string
|
number
;
Parse the location from Tag resource.
| Name | Description |
| tagName | string
A fully-qualified path representing Tag resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName)
matchLocationFromTagTemplateFieldEnumValueName
(
tagTemplateFieldEnumValueName
:
string
)
:
string
|
number
;
Parse the location from TagTemplateFieldEnumValue resource.
| Name | Description |
| tagTemplateFieldEnumValueName | string
A fully-qualified path representing TagTemplateFieldEnumValue resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromTagTemplateFieldName(tagTemplateFieldName)
matchLocationFromTagTemplateFieldName
(
tagTemplateFieldName
:
string
)
:
string
|
number
;
Parse the location from TagTemplateField resource.
| Name | Description |
| tagTemplateFieldName | string
A fully-qualified path representing TagTemplateField resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromTagTemplateName(tagTemplateName)
matchLocationFromTagTemplateName
(
tagTemplateName
:
string
)
:
string
|
number
;
Parse the location from TagTemplate resource.
| Name | Description |
| tagTemplateName | string
A fully-qualified path representing TagTemplate resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromTaxonomyName(taxonomyName)
matchLocationFromTaxonomyName
(
taxonomyName
:
string
)
:
string
|
number
;
Parse the location from Taxonomy resource.
| Name | Description |
| taxonomyName | string
A fully-qualified path representing Taxonomy resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchPolicyTagFromPolicyTagName(policyTagName)
matchPolicyTagFromPolicyTagName
(
policyTagName
:
string
)
:
string
|
number
;
Parse the policy_tag from PolicyTag resource.
| Name | Description |
| policyTagName | string
A fully-qualified path representing PolicyTag resource. |
| Type | Description |
| string | number | {string} A string representing the policy_tag. |
matchProjectFromEntryGroupName(entryGroupName)
matchProjectFromEntryGroupName
(
entryGroupName
:
string
)
:
string
|
number
;
Parse the project from EntryGroup resource.
| Name | Description |
| entryGroupName | string
A fully-qualified path representing EntryGroup resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromEntryName(entryName)
matchProjectFromEntryName
(
entryName
:
string
)
:
string
|
number
;
Parse the project from Entry resource.
| Name | Description |
| entryName | string
A fully-qualified path representing Entry resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
| Name | Description |
| locationName | string
A fully-qualified path representing Location resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromPolicyTagName(policyTagName)
matchProjectFromPolicyTagName
(
policyTagName
:
string
)
:
string
|
number
;
Parse the project from PolicyTag resource.
| Name | Description |
| policyTagName | string
A fully-qualified path representing PolicyTag resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
| Name | Description |
| projectName | string
A fully-qualified path representing Project resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromTagName(tagName)
matchProjectFromTagName
(
tagName
:
string
)
:
string
|
number
;
Parse the project from Tag resource.
| Name | Description |
| tagName | string
A fully-qualified path representing Tag resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromTagTemplateFieldEnumValueName(tagTemplateFieldEnumValueName)
matchProjectFromTagTemplateFieldEnumValueName
(
tagTemplateFieldEnumValueName
:
string
)
:
string
|
number
;
Parse the project from TagTemplateFieldEnumValue resource.
| Name | Description |
| tagTemplateFieldEnumValueName | string
A fully-qualified path representing TagTemplateFieldEnumValue resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromTagTemplateFieldName(tagTemplateFieldName)
matchProjectFromTagTemplateFieldName
(
tagTemplateFieldName
:
string
)
:
string
|
number
;
Parse the project from TagTemplateField resource.
| Name | Description |
| tagTemplateFieldName | string
A fully-qualified path representing TagTemplateField resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromTagTemplateName(tagTemplateName)
matchProjectFromTagTemplateName
(
tagTemplateName
:
string
)
:
string
|
number
;
Parse the project from TagTemplate resource.
| Name | Description |
| tagTemplateName | string
A fully-qualified path representing TagTemplate resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromTaxonomyName(taxonomyName)
matchProjectFromTaxonomyName
(
taxonomyName
:
string
)
:
string
|
number
;
Parse the project from Taxonomy resource.
| Name | Description |
| taxonomyName | string
A fully-qualified path representing Taxonomy resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchTagFromTagName(tagName)
matchTagFromTagName
(
tagName
:
string
)
:
string
|
number
;
Parse the tag from Tag resource.
| Name | Description |
| tagName | string
A fully-qualified path representing Tag resource. |
| 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.
| Name | Description |
| tagTemplateFieldEnumValueName | string
A fully-qualified path representing TagTemplateFieldEnumValue resource. |
| 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.
| Name | Description |
| tagTemplateFieldEnumValueName | string
A fully-qualified path representing TagTemplateFieldEnumValue resource. |
| 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.
| Name | Description |
| tagTemplateFieldName | string
A fully-qualified path representing TagTemplateField resource. |
| 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.
| Name | Description |
| tagTemplateName | string
A fully-qualified path representing TagTemplate resource. |
| Type | Description |
| string | number | {string} A string representing the tag_template. |
matchTaxonomyFromPolicyTagName(policyTagName)
matchTaxonomyFromPolicyTagName
(
policyTagName
:
string
)
:
string
|
number
;
Parse the taxonomy from PolicyTag resource.
| Name | Description |
| policyTagName | string
A fully-qualified path representing PolicyTag resource. |
| Type | Description |
| string | number | {string} A string representing the taxonomy. |
matchTaxonomyFromTaxonomyName(taxonomyName)
matchTaxonomyFromTaxonomyName
(
taxonomyName
:
string
)
:
string
|
number
;
Parse the taxonomy from Taxonomy resource.
| Name | Description |
| taxonomyName | string
A fully-qualified path representing Taxonomy resource. |
| 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.
| Name | Description |
|---|---|
| project | string
|
| location | string
|
| taxonomy | string
|
| policyTag | string
|
| Type | Description |
| string | {string} Resource name string. |
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
| Name | Description |
|---|---|
| project | string
|
| 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
]>;
Renames a field in a tag template.
You must enable the Data Catalog API in the project identified by the name
parameter. For more information, see [Data Catalog resource project] ( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITagTemplateField , (protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldRequest | undefined), {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplateField]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the tag template field.
*/
// const name = 'abc123'
/**
* Required. The new ID of this tag template field. For example, `my_new_field`.
*/
// const newTagTemplateFieldId = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callRenameTagTemplateField
()
{
// Construct request
const
request
=
{
name
,
newTagTemplateFieldId
,
};
// Run request
const
response
=
await
datacatalogClient
.
renameTagTemplateField
(
request
);
console
.
log
(
response
);
}
callRenameTagTemplateField
();
renameTagTemplateField(request, options, callback)
renameTagTemplateField
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IRenameTagTemplateFieldRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
ITagTemplateField
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IRenameTagTemplateFieldRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITagTemplateField , (protos. google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest | undefined), {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplateField]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the enum field value.
*/
// const name = 'abc123'
/**
* Required. The new display name of the enum value. For example, `my_new_enum_value`.
*/
// const newEnumValueDisplayName = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callRenameTagTemplateFieldEnumValue
()
{
// Construct request
const
request
=
{
name
,
newEnumValueDisplayName
,
};
// Run request
const
response
=
await
datacatalogClient
.
renameTagTemplateFieldEnumValue
(
request
);
console
.
log
(
response
);
}
callRenameTagTemplateFieldEnumValue
();
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
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Searches Data Catalog for multiple resources like entries and tags that match a query.
This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.
Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.
For more information, see [Data Catalog search syntax] ( https://cloud.google.com/data-catalog/docs/how-to/search-reference ).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.ISearchCatalogRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ISearchCatalogResult [], protos. google.cloud.datacatalog.v1.ISearchCatalogRequest | null, protos. google.cloud.datacatalog.v1.ISearchCatalogResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [SearchCatalogResult]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
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
;
| Name | Description |
| 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
>
|
| 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
;
| Name | Description |
| 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
>
|
| 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.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.ISearchCatalogRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| 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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The scope of this search request.
* The `scope` is invalid if `include_org_ids`, `include_project_ids` are
* empty AND `include_gcp_public_datasets` is set to `false`. In this case,
* the request returns an error.
*/
// const scope = {}
/**
* Optional. The query string with a minimum of 3 characters and specific syntax.
* For more information, see
* Data Catalog search
* syntax (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
* An empty query string returns all data assets (in the specified scope)
* that you have access to.
* A query string can be a simple `xyz` or qualified by predicates:
* * `name:x`
* * `column:y`
* * `description:z`
*/
// const query = 'abc123'
/**
* Number of results to return in a single search page.
* Can't be negative or 0, defaults to 10 in this case.
* The maximum number is 1000. If exceeded, throws an "invalid argument"
* exception.
*/
// const pageSize = 1234
/**
* Optional. Pagination token that, if specified, returns the next page of search
* results. If empty, returns the first page.
* This token is returned in the SearchCatalogResponse.next_page_token google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token
* field of the response to a previous
* SearchCatalogRequest google.cloud.datacatalog.v1.DataCatalog.SearchCatalog
* call.
*/
// const pageToken = 'abc123'
/**
* Specifies the order of results.
* Currently supported case-sensitive values are:
* * `relevance` that can only be descending
* * `last_modified_timestamp asc|desc` with descending (`desc`) as default
* If this parameter is omitted, it defaults to the descending `relevance`.
*/
// const orderBy = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callSearchCatalog
()
{
// Construct request
const
request
=
{
scope
,
};
// Run request
const
iterable
=
await
datacatalogClient
.
searchCatalogAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callSearchCatalog
();
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.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.ISearchCatalogRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| 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 |
setIamPolicy(request, options)
setIamPolicy
(
request
?:
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
|
undefined
,
{}
|
undefined
]>;
Sets an access control policy for a resource. Replaces any existing policy.
Supported resources are:
- Tag templates - Entry groups
Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.
To call this method, you must have the following Google IAM permissions:
-
datacatalog.tagTemplates.setIamPolicyto set policies on tag templates. -datacatalog.entryGroups.setIamPolicyto set policies on entry groups.
| Name | Description |
| request | protos. google.iam.v1.ISetIamPolicyRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.iam.v1.IPolicy , protos. google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of
* the policy is limited to a few 10s of KB. An empty policy is a
* valid policy but certain Cloud Platform services (such as Projects)
* might reject them.
*/
// const policy = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callSetIamPolicy
()
{
// Construct request
const
request
=
{
resource
,
policy
,
};
// Run request
const
response
=
await
datacatalogClient
.
setIamPolicy
(
request
);
console
.
log
(
response
);
}
callSetIamPolicy
();
setIamPolicy(request, options, callback)
setIamPolicy
(
request
:
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| request | protos. google.iam.v1.ISetIamPolicyRequest
|
| options | CallOptions
|
| callback | Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.ISetIamPolicyRequest
| null | undefined, {} | null | undefined>
|
| 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
;
| Name | Description |
| request | protos. google.iam.v1.ISetIamPolicyRequest
|
| callback | Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.ISetIamPolicyRequest
| null | undefined, {} | null | undefined>
|
| 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.
| Name | Description |
|---|---|
| project | string
|
| location | string
|
| entryGroup | string
|
| entry | string
|
| tag | string
|
| 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.
| Name | Description |
|---|---|
| project | string
|
| location | string
|
| tagTemplate | string
|
| tagTemplateFieldId | string
|
| enumValueDisplayName | string
|
| 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.
| Name | Description |
|---|---|
| project | string
|
| location | string
|
| tagTemplate | string
|
| field | string
|
| 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.
| Name | Description |
|---|---|
| project | string
|
| location | string
|
| tagTemplate | string
|
| 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.
| Name | Description |
|---|---|
| project | string
|
| location | string
|
| taxonomy | string
|
| 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
]>;
Gets your permissions on a resource.
Returns an empty set of permissions if the resource doesn't exist.
Supported resources are:
- Tag templates - Entry groups
Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog.
No Google IAM permissions are required to call this method.
| Name | Description |
| request | protos. google.iam.v1.ITestIamPermissionsRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.iam.v1.ITestIamPermissionsResponse , protos. google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
*/
// const permissions = 'abc123'
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callTestIamPermissions
()
{
// Construct request
const
request
=
{
resource
,
permissions
,
};
// Run request
const
response
=
await
datacatalogClient
.
testIamPermissions
(
request
);
console
.
log
(
response
);
}
callTestIamPermissions
();
testIamPermissions(request, options, callback)
testIamPermissions
(
request
:
protos
.
google
.
iam
.
v1
.
ITestIamPermissionsRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
iam
.
v1
.
ITestIamPermissionsResponse
,
protos
.
google
.
iam
.
v1
.
ITestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| request | protos. google.iam.v1.ITestIamPermissionsRequest
|
| options | CallOptions
|
| callback | Callback
<protos. google.iam.v1.ITestIamPermissionsResponse
, protos. google.iam.v1.ITestIamPermissionsRequest
| null | undefined, {} | null | undefined>
|
| 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
;
| Name | Description |
| request | protos. google.iam.v1.ITestIamPermissionsRequest
|
| callback | Callback
<protos. google.iam.v1.ITestIamPermissionsResponse
, protos. google.iam.v1.ITestIamPermissionsRequest
| null | undefined, {} | null | undefined>
|
| 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
]>;
Updates an existing entry.
You must enable the Data Catalog API in the project identified by the entry.name
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IUpdateEntryRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.IEntry , protos. google.cloud.datacatalog.v1.IUpdateEntryRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Entry]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Updates for the entry. The `name` field must be set.
*/
// const entry = {}
/**
* Names of fields whose values to overwrite on an entry.
* If this parameter is absent or empty, all modifiable fields
* are overwritten. If such fields are non-required and omitted in the
* request body, their values are emptied.
* You can modify only the fields listed below.
* For entries with type `DATA_STREAM`:
* * `schema`
* For entries with type `FILESET`:
* * `schema`
* * `display_name`
* * `description`
* * `gcs_fileset_spec`
* * `gcs_fileset_spec.file_patterns`
* For entries with `user_specified_type`:
* * `schema`
* * `display_name`
* * `description`
* * `user_specified_type`
* * `user_specified_system`
* * `linked_resource`
* * `source_system_timestamps`
*/
// const updateMask = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callUpdateEntry
()
{
// Construct request
const
request
=
{
entry
,
};
// Run request
const
response
=
await
datacatalogClient
.
updateEntry
(
request
);
console
.
log
(
response
);
}
callUpdateEntry
();
updateEntry(request, options, callback)
updateEntry
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateEntryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
IEntry
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateEntryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Updates an entry group.
You must enable the Data Catalog API in the project identified by the entry_group.name
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IUpdateEntryGroupRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.IEntryGroup , protos. google.cloud.datacatalog.v1.IUpdateEntryGroupRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [EntryGroup]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Updates for the entry group. The `name` field must be set.
*/
// const entryGroup = {}
/**
* Names of fields whose values to overwrite on an entry group.
* If this parameter is absent or empty, all modifiable fields
* are overwritten. If such fields are non-required and omitted in the
* request body, their values are emptied.
*/
// const updateMask = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callUpdateEntryGroup
()
{
// Construct request
const
request
=
{
entryGroup
,
};
// Run request
const
response
=
await
datacatalogClient
.
updateEntryGroup
(
request
);
console
.
log
(
response
);
}
callUpdateEntryGroup
();
updateEntryGroup(request, options, callback)
updateEntryGroup
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateEntryGroupRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
IEntryGroup
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateEntryGroupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Updates an existing tag.
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IUpdateTagRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITag , protos. google.cloud.datacatalog.v1.IUpdateTagRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Tag]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The updated tag. The "name" field must be set.
*/
// const tag = {}
/**
* Names of fields whose values to overwrite on a tag. Currently, a tag has
* the only modifiable field with the name `fields`.
* In general, if this parameter is absent or empty, all modifiable fields
* are overwritten. If such fields are non-required and omitted in the
* request body, their values are emptied.
*/
// const updateMask = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callUpdateTag
()
{
// Construct request
const
request
=
{
tag
,
};
// Run request
const
response
=
await
datacatalogClient
.
updateTag
(
request
);
console
.
log
(
response
);
}
callUpdateTag
();
updateTag(request, options, callback)
updateTag
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateTagRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
ITag
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateTagRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Updates a tag template.
You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.
You must enable the Data Catalog API in the project identified by the tag_template.name
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IUpdateTagTemplateRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITagTemplate , protos. google.cloud.datacatalog.v1.IUpdateTagTemplateRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplate]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The template to update. The `name` field must be set.
*/
// const tagTemplate = {}
/**
* Names of fields whose values to overwrite on a tag template. Currently,
* only `display_name` and `is_publicly_readable` can be overwritten.
* If this parameter is absent or empty, all modifiable fields
* are overwritten. If such fields are non-required and omitted in the
* request body, their values are emptied.
* Note: Updating the `is_publicly_readable` field may require up to 12
* hours to take effect in search results. Additionally, it also requires
* the `tagTemplates.getIamPolicy` and `tagTemplates.setIamPolicy`
* permissions.
*/
// const updateMask = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callUpdateTagTemplate
()
{
// Construct request
const
request
=
{
tagTemplate
,
};
// Run request
const
response
=
await
datacatalogClient
.
updateTagTemplate
(
request
);
console
.
log
(
response
);
}
callUpdateTagTemplate
();
updateTagTemplate(request, options, callback)
updateTagTemplate
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateTagTemplateRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
ITagTemplate
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateTagTemplateRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| 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
]>;
Updates a field in a tag template.
You can't update the field type with this method.
You must enable the Data Catalog API in the project identified by the name
parameter. For more information, see [Data Catalog resource project]( https://cloud.google.com/data-catalog/docs/concepts/resource-project
).
| Name | Description |
| request | protos. google.cloud.datacatalog.v1.IUpdateTagTemplateFieldRequest
The request object that will be sent. |
| options | CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Promise <[protos. google.cloud.datacatalog.v1.ITagTemplateField , (protos. google.cloud.datacatalog.v1.IUpdateTagTemplateFieldRequest | undefined), {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TagTemplateField]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the tag template field.
*/
// const name = 'abc123'
/**
* Required. The template to update.
*/
// const tagTemplateField = {}
/**
* Optional. Names of fields whose values to overwrite on an individual field of a tag
* template. The following fields are modifiable:
* * `display_name`
* * `type.enum_type`
* * `is_required`
* If this parameter is absent or empty, all modifiable fields
* are overwritten. If such fields are non-required and omitted in the request
* body, their values are emptied with one exception: when updating an enum
* type, the provided values are merged with the existing values. Therefore,
* enum values can only be added, existing enum values cannot be deleted or
* renamed.
* Additionally, updating a template field from optional to required is
* *not* allowed.
*/
// const updateMask = {}
// Imports the Datacatalog library
const
{
DataCatalogClient
}
=
require
(
' @google-cloud/datacatalog
'
).
v1
;
// Instantiates a client
const
datacatalogClient
=
new
DataCatalogClient
();
async
function
callUpdateTagTemplateField
()
{
// Construct request
const
request
=
{
name
,
tagTemplateField
,
};
// Run request
const
response
=
await
datacatalogClient
.
updateTagTemplateField
(
request
);
console
.
log
(
response
);
}
callUpdateTagTemplateField
();
updateTagTemplateField(request, options, callback)
updateTagTemplateField
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateTagTemplateFieldRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
v1
.
ITagTemplateField
,
protos
.
google
.
cloud
.
datacatalog
.
v1
.
IUpdateTagTemplateFieldRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
| Name | Description |
| 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>
|
| 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
;
| Name | Description |
| 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>
|
| Type | Description |
|---|---|
| void |
