DataCatalog

google.cloud.datacatalog.v1. DataCatalog

Represents a DataCatalog

Constructor

new DataCatalog(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new DataCatalog service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createEntry(request, callback) → {undefined}

Calls CreateEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateEntryRequest

CreateEntryRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.CreateEntryCallback

Node-style callback called with the error, if any, and Entry

Returns:
Type Description
undefined

createEntry(request) → {Promise.<google.cloud.datacatalog.v1.Entry>}

Calls CreateEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateEntryRequest

CreateEntryRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.Entry>

Promise

createEntryGroup(request, callback) → {undefined}

Calls CreateEntryGroup.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateEntryGroupRequest

CreateEntryGroupRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroupCallback

Node-style callback called with the error, if any, and EntryGroup

Returns:
Type Description
undefined

createEntryGroup(request) → {Promise.<google.cloud.datacatalog.v1.EntryGroup>}

Calls CreateEntryGroup.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateEntryGroupRequest

CreateEntryGroupRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.EntryGroup>

Promise

createTag(request, callback) → {undefined}

Calls CreateTag.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateTagRequest

CreateTagRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.CreateTagCallback

Node-style callback called with the error, if any, and Tag

Returns:
Type Description
undefined

createTag(request) → {Promise.<google.cloud.datacatalog.v1.Tag>}

Calls CreateTag.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateTagRequest

CreateTagRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.Tag>

Promise

createTagTemplate(request, callback) → {undefined}

Calls CreateTagTemplate.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateTagTemplateRequest

CreateTagTemplateRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateCallback

Node-style callback called with the error, if any, and TagTemplate

Returns:
Type Description
undefined

createTagTemplate(request) → {Promise.<google.cloud.datacatalog.v1.TagTemplate>}

Calls CreateTagTemplate.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateTagTemplateRequest

CreateTagTemplateRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.TagTemplate>

Promise

createTagTemplateField(request, callback) → {undefined}

Calls CreateTagTemplateField.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateTagTemplateFieldRequest

CreateTagTemplateFieldRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateFieldCallback

Node-style callback called with the error, if any, and TagTemplateField

Returns:
Type Description
undefined

createTagTemplateField(request) → {Promise.<google.cloud.datacatalog.v1.TagTemplateField>}

Calls CreateTagTemplateField.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ICreateTagTemplateFieldRequest

CreateTagTemplateFieldRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.TagTemplateField>

Promise

deleteEntry(request, callback) → {undefined}

Calls DeleteEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteEntryRequest

DeleteEntryRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.DeleteEntryCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteEntry(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteEntryRequest

DeleteEntryRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteEntryGroup(request, callback) → {undefined}

Calls DeleteEntryGroup.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteEntryGroupRequest

DeleteEntryGroupRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroupCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteEntryGroup(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteEntryGroup.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteEntryGroupRequest

DeleteEntryGroupRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteTag(request, callback) → {undefined}

Calls DeleteTag.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteTagRequest

DeleteTagRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.DeleteTagCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteTag(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteTag.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteTagRequest

DeleteTagRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteTagTemplate(request, callback) → {undefined}

Calls DeleteTagTemplate.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteTagTemplateRequest

DeleteTagTemplateRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteTagTemplate(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteTagTemplate.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteTagTemplateRequest

DeleteTagTemplateRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteTagTemplateField(request, callback) → {undefined}

Calls DeleteTagTemplateField.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteTagTemplateFieldRequest

DeleteTagTemplateFieldRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateFieldCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteTagTemplateField(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteTagTemplateField.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IDeleteTagTemplateFieldRequest

DeleteTagTemplateFieldRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getEntry(request, callback) → {undefined}

Calls GetEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IGetEntryRequest

GetEntryRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.GetEntryCallback

Node-style callback called with the error, if any, and Entry

Returns:
Type Description
undefined

getEntry(request) → {Promise.<google.cloud.datacatalog.v1.Entry>}

Calls GetEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IGetEntryRequest

GetEntryRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.Entry>

Promise

getEntryGroup(request, callback) → {undefined}

Calls GetEntryGroup.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IGetEntryGroupRequest

GetEntryGroupRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.GetEntryGroupCallback

Node-style callback called with the error, if any, and EntryGroup

Returns:
Type Description
undefined

getEntryGroup(request) → {Promise.<google.cloud.datacatalog.v1.EntryGroup>}

Calls GetEntryGroup.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IGetEntryGroupRequest

GetEntryGroupRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.EntryGroup>

Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

getTagTemplate(request, callback) → {undefined}

Calls GetTagTemplate.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IGetTagTemplateRequest

GetTagTemplateRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.GetTagTemplateCallback

Node-style callback called with the error, if any, and TagTemplate

Returns:
Type Description
undefined

getTagTemplate(request) → {Promise.<google.cloud.datacatalog.v1.TagTemplate>}

Calls GetTagTemplate.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IGetTagTemplateRequest

GetTagTemplateRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.TagTemplate>

Promise

importEntries(request, callback) → {undefined}

Calls ImportEntries.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IImportEntriesRequest

ImportEntriesRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.ImportEntriesCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

importEntries(request) → {Promise.<google.longrunning.Operation>}

Calls ImportEntries.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IImportEntriesRequest

ImportEntriesRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

listEntries(request, callback) → {undefined}

Calls ListEntries.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IListEntriesRequest

ListEntriesRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.ListEntriesCallback

Node-style callback called with the error, if any, and ListEntriesResponse

Returns:
Type Description
undefined

listEntries(request) → {Promise.<google.cloud.datacatalog.v1.ListEntriesResponse>}

Calls ListEntries.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IListEntriesRequest

ListEntriesRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.ListEntriesResponse>

Promise

listEntryGroups(request, callback) → {undefined}

Calls ListEntryGroups.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IListEntryGroupsRequest

ListEntryGroupsRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.ListEntryGroupsCallback

Node-style callback called with the error, if any, and ListEntryGroupsResponse

Returns:
Type Description
undefined

listEntryGroups(request) → {Promise.<google.cloud.datacatalog.v1.ListEntryGroupsResponse>}

Calls ListEntryGroups.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IListEntryGroupsRequest

ListEntryGroupsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.ListEntryGroupsResponse>

Promise

listTags(request, callback) → {undefined}

Calls ListTags.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IListTagsRequest

ListTagsRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.ListTagsCallback

Node-style callback called with the error, if any, and ListTagsResponse

Returns:
Type Description
undefined

listTags(request) → {Promise.<google.cloud.datacatalog.v1.ListTagsResponse>}

Calls ListTags.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IListTagsRequest

ListTagsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.ListTagsResponse>

Promise

lookupEntry(request, callback) → {undefined}

Calls LookupEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ILookupEntryRequest

LookupEntryRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.LookupEntryCallback

Node-style callback called with the error, if any, and Entry

Returns:
Type Description
undefined

lookupEntry(request) → {Promise.<google.cloud.datacatalog.v1.Entry>}

Calls LookupEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ILookupEntryRequest

LookupEntryRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.Entry>

Promise

modifyEntryContacts(request, callback) → {undefined}

Calls ModifyEntryContacts.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IModifyEntryContactsRequest

ModifyEntryContactsRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.ModifyEntryContactsCallback

Node-style callback called with the error, if any, and Contacts

Returns:
Type Description
undefined

modifyEntryContacts(request) → {Promise.<google.cloud.datacatalog.v1.Contacts>}

Calls ModifyEntryContacts.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IModifyEntryContactsRequest

ModifyEntryContactsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.Contacts>

Promise

modifyEntryOverview(request, callback) → {undefined}

Calls ModifyEntryOverview.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IModifyEntryOverviewRequest

ModifyEntryOverviewRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.ModifyEntryOverviewCallback

Node-style callback called with the error, if any, and EntryOverview

Returns:
Type Description
undefined

modifyEntryOverview(request) → {Promise.<google.cloud.datacatalog.v1.EntryOverview>}

Calls ModifyEntryOverview.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IModifyEntryOverviewRequest

ModifyEntryOverviewRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.EntryOverview>

Promise

reconcileTags(request, callback) → {undefined}

Calls ReconcileTags.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IReconcileTagsRequest

ReconcileTagsRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.ReconcileTagsCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

reconcileTags(request) → {Promise.<google.longrunning.Operation>}

Calls ReconcileTags.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IReconcileTagsRequest

ReconcileTagsRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

renameTagTemplateField(request, callback) → {undefined}

Calls RenameTagTemplateField.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IRenameTagTemplateFieldRequest

RenameTagTemplateFieldRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldCallback

Node-style callback called with the error, if any, and TagTemplateField

Returns:
Type Description
undefined

renameTagTemplateField(request) → {Promise.<google.cloud.datacatalog.v1.TagTemplateField>}

Calls RenameTagTemplateField.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IRenameTagTemplateFieldRequest

RenameTagTemplateFieldRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.TagTemplateField>

Promise

renameTagTemplateFieldEnumValue(request, callback) → {undefined}

Calls RenameTagTemplateFieldEnumValue.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest

RenameTagTemplateFieldEnumValueRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValueCallback

Node-style callback called with the error, if any, and TagTemplateField

Returns:
Type Description
undefined

renameTagTemplateFieldEnumValue(request) → {Promise.<google.cloud.datacatalog.v1.TagTemplateField>}

Calls RenameTagTemplateFieldEnumValue.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IRenameTagTemplateFieldEnumValueRequest

RenameTagTemplateFieldEnumValueRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.TagTemplateField>

Promise

searchCatalog(request, callback) → {undefined}

Calls SearchCatalog.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ISearchCatalogRequest

SearchCatalogRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.SearchCatalogCallback

Node-style callback called with the error, if any, and SearchCatalogResponse

Returns:
Type Description
undefined

searchCatalog(request) → {Promise.<google.cloud.datacatalog.v1.SearchCatalogResponse>}

Calls SearchCatalog.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.ISearchCatalogRequest

SearchCatalogRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.SearchCatalogResponse>

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

starEntry(request, callback) → {undefined}

Calls StarEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IStarEntryRequest

StarEntryRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.StarEntryCallback

Node-style callback called with the error, if any, and StarEntryResponse

Returns:
Type Description
undefined

starEntry(request) → {Promise.<google.cloud.datacatalog.v1.StarEntryResponse>}

Calls StarEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IStarEntryRequest

StarEntryRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.StarEntryResponse>

Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns:
Type Description
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

Returns:
Type Description
Promise.<google.iam.v1.TestIamPermissionsResponse>

Promise

unstarEntry(request, callback) → {undefined}

Calls UnstarEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUnstarEntryRequest

UnstarEntryRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.UnstarEntryCallback

Node-style callback called with the error, if any, and UnstarEntryResponse

Returns:
Type Description
undefined

unstarEntry(request) → {Promise.<google.cloud.datacatalog.v1.UnstarEntryResponse>}

Calls UnstarEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUnstarEntryRequest

UnstarEntryRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.UnstarEntryResponse>

Promise

updateEntry(request, callback) → {undefined}

Calls UpdateEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateEntryRequest

UpdateEntryRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.UpdateEntryCallback

Node-style callback called with the error, if any, and Entry

Returns:
Type Description
undefined

updateEntry(request) → {Promise.<google.cloud.datacatalog.v1.Entry>}

Calls UpdateEntry.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateEntryRequest

UpdateEntryRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.Entry>

Promise

updateEntryGroup(request, callback) → {undefined}

Calls UpdateEntryGroup.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateEntryGroupRequest

UpdateEntryGroupRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroupCallback

Node-style callback called with the error, if any, and EntryGroup

Returns:
Type Description
undefined

updateEntryGroup(request) → {Promise.<google.cloud.datacatalog.v1.EntryGroup>}

Calls UpdateEntryGroup.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateEntryGroupRequest

UpdateEntryGroupRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.EntryGroup>

Promise

updateTag(request, callback) → {undefined}

Calls UpdateTag.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateTagRequest

UpdateTagRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.UpdateTagCallback

Node-style callback called with the error, if any, and Tag

Returns:
Type Description
undefined

updateTag(request) → {Promise.<google.cloud.datacatalog.v1.Tag>}

Calls UpdateTag.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateTagRequest

UpdateTagRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.Tag>

Promise

updateTagTemplate(request, callback) → {undefined}

Calls UpdateTagTemplate.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateTagTemplateRequest

UpdateTagTemplateRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateCallback

Node-style callback called with the error, if any, and TagTemplate

Returns:
Type Description
undefined

updateTagTemplate(request) → {Promise.<google.cloud.datacatalog.v1.TagTemplate>}

Calls UpdateTagTemplate.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateTagTemplateRequest

UpdateTagTemplateRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.TagTemplate>

Promise

updateTagTemplateField(request, callback) → {undefined}

Calls UpdateTagTemplateField.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateTagTemplateFieldRequest

UpdateTagTemplateFieldRequest message or plain object

callback google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateFieldCallback

Node-style callback called with the error, if any, and TagTemplateField

Returns:
Type Description
undefined

updateTagTemplateField(request) → {Promise.<google.cloud.datacatalog.v1.TagTemplateField>}

Calls UpdateTagTemplateField.

Parameters:
Name Type Description
request google.cloud.datacatalog.v1.IUpdateTagTemplateFieldRequest

UpdateTagTemplateFieldRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.datacatalog.v1.TagTemplateField>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {DataCatalog}

Creates new DataCatalog service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
DataCatalog

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateEntryCallback(error, responseopt)

Callback as used by createEntry.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.Entry <optional>

Entry

CreateEntryGroupCallback(error, responseopt)

Callback as used by createEntryGroup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.EntryGroup <optional>

EntryGroup

CreateTagCallback(error, responseopt)

Callback as used by createTag.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.Tag <optional>

Tag

CreateTagTemplateCallback(error, responseopt)

Callback as used by createTagTemplate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.TagTemplate <optional>

TagTemplate

CreateTagTemplateFieldCallback(error, responseopt)

Callback as used by createTagTemplateField.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.TagTemplateField <optional>

TagTemplateField

DeleteEntryCallback(error, responseopt)

Callback as used by deleteEntry.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteEntryGroupCallback(error, responseopt)

Callback as used by deleteEntryGroup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteTagCallback(error, responseopt)

Callback as used by deleteTag.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteTagTemplateCallback(error, responseopt)

Callback as used by deleteTagTemplate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteTagTemplateFieldCallback(error, responseopt)

Callback as used by deleteTagTemplateField.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetEntryCallback(error, responseopt)

Callback as used by getEntry.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.Entry <optional>

Entry

GetEntryGroupCallback(error, responseopt)

Callback as used by getEntryGroup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.EntryGroup <optional>

EntryGroup

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

GetTagTemplateCallback(error, responseopt)

Callback as used by getTagTemplate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.TagTemplate <optional>

TagTemplate

ImportEntriesCallback(error, responseopt)

Callback as used by importEntries.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

ListEntriesCallback(error, responseopt)

Callback as used by listEntries.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.ListEntriesResponse <optional>

ListEntriesResponse

ListEntryGroupsCallback(error, responseopt)

Callback as used by listEntryGroups.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.ListEntryGroupsResponse <optional>

ListEntryGroupsResponse

ListTagsCallback(error, responseopt)

Callback as used by listTags.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.ListTagsResponse <optional>

ListTagsResponse

LookupEntryCallback(error, responseopt)

Callback as used by lookupEntry.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.Entry <optional>

Entry

ModifyEntryContactsCallback(error, responseopt)

Callback as used by modifyEntryContacts.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.Contacts <optional>

Contacts

ModifyEntryOverviewCallback(error, responseopt)

Callback as used by modifyEntryOverview.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.EntryOverview <optional>

EntryOverview

ReconcileTagsCallback(error, responseopt)

Callback as used by reconcileTags.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

RenameTagTemplateFieldCallback(error, responseopt)

Callback as used by renameTagTemplateField.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.TagTemplateField <optional>

TagTemplateField

RenameTagTemplateFieldEnumValueCallback(error, responseopt)

Callback as used by renameTagTemplateFieldEnumValue.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.TagTemplateField <optional>

TagTemplateField

SearchCatalogCallback(error, responseopt)

Callback as used by searchCatalog.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.SearchCatalogResponse <optional>

SearchCatalogResponse

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

StarEntryCallback(error, responseopt)

Callback as used by starEntry.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.StarEntryResponse <optional>

StarEntryResponse

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.TestIamPermissionsResponse <optional>

TestIamPermissionsResponse

UnstarEntryCallback(error, responseopt)

Callback as used by unstarEntry.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.UnstarEntryResponse <optional>

UnstarEntryResponse

UpdateEntryCallback(error, responseopt)

Callback as used by updateEntry.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.Entry <optional>

Entry

UpdateEntryGroupCallback(error, responseopt)

Callback as used by updateEntryGroup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.EntryGroup <optional>

EntryGroup

UpdateTagCallback(error, responseopt)

Callback as used by updateTag.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.Tag <optional>

Tag

UpdateTagTemplateCallback(error, responseopt)

Callback as used by updateTagTemplate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.TagTemplate <optional>

TagTemplate

UpdateTagTemplateFieldCallback(error, responseopt)

Callback as used by updateTagTemplateField.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.datacatalog.v1.TagTemplateField <optional>

TagTemplateField