Class v1beta1.DataCatalogClient

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

Package

@google-cloud/datacatalog!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of DataCatalogClient.

Parameter
TypeNameDescription
ClientOptionsopts

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
TypeDescription
string

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

dataCatalogStub

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

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
TypeDescription
{ [name: string]: Function; }

pathTemplates

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

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

scopes

static get scopes(): string[];

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

Property Value
TypeDescription
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

warn

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

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createEntry(request, options)

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

createEntry(request, options, callback)

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

createEntry(request, callback)

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

createEntryGroup(request, options)

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

createEntryGroup(request, options, callback)

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

createEntryGroup(request, callback)

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

createTag(request, options)

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

createTag(request, options, callback)

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

createTag(request, callback)

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

createTagTemplate(request, options)

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

createTagTemplate(request, options, callback)

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

createTagTemplate(request, callback)

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

createTagTemplateField(request, options)

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

createTagTemplateField(request, options, callback)

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

createTagTemplateField(request, callback)

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

deleteEntry(request, options)

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

deleteEntry(request, options, callback)

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

deleteEntry(request, callback)

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

deleteEntryGroup(request, options)

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

deleteEntryGroup(request, options, callback)

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

deleteEntryGroup(request, callback)

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

deleteTag(request, options)

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

deleteTag(request, options, callback)

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

deleteTag(request, callback)

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

deleteTagTemplate(request, options)

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

deleteTagTemplate(request, options, callback)

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

deleteTagTemplate(request, callback)

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

deleteTagTemplateField(request, options)

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

deleteTagTemplateField(request, options, callback)

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

deleteTagTemplateField(request, callback)

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

entryGroupPath(project, location, entryGroup)

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

Return a fully-qualified entryGroup resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringentryGroup
Returns
TypeDescription
string

{string} Resource name string.

entryPath(project, location, entryGroup, entry)

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

Return a fully-qualified entry resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringentryGroup
stringentry
Returns
TypeDescription
string

{string} Resource name string.

getEntry(request, options)

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

getEntry(request, options, callback)

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

getEntry(request, callback)

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

getEntryGroup(request, options)

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

getEntryGroup(request, options, callback)

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

getEntryGroup(request, callback)

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

getIamPolicy(request, options)

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

getIamPolicy(request, options, callback)

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

getIamPolicy(request, callback)

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

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
TypeNameDescription
Callback<string, undefined, undefined>callback
Returns
TypeDescription
void

getTagTemplate(request, options)

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

getTagTemplate(request, options, callback)

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

getTagTemplate(request, callback)

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

initialize()

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

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listEntries(request, options)

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

listEntries(request, options, callback)

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

listEntries(request, callback)

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

listEntriesAsync(request, options)

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

Equivalent to listEntries, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
TypeNameDescription
protos.google.cloud.datacatalog.v1beta1.IListEntriesRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Entry]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEntriesStream(request, options)

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

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

Parameters
TypeNameDescription
protos.google.cloud.datacatalog.v1beta1.IListEntriesRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Entry] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEntriesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEntryGroups(request, options)

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

listEntryGroups(request, options, callback)

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

listEntryGroups(request, callback)

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

listEntryGroupsAsync(request, options)

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

Equivalent to listEntryGroups, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
TypeNameDescription
protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [EntryGroup]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEntryGroupsStream(request, options)

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

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

Parameters
TypeNameDescription
protos.google.cloud.datacatalog.v1beta1.IListEntryGroupsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [EntryGroup] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEntryGroupsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTags(request, options)

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

listTags(request, options, callback)

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

listTags(request, callback)

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

listTagsAsync(request, options)

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

Equivalent to listTags, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
TypeNameDescription
protos.google.cloud.datacatalog.v1beta1.IListTagsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Tag]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTagsStream(request, options)

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

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

Parameters
TypeNameDescription
protos.google.cloud.datacatalog.v1beta1.IListTagsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Tag] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTagsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
Returns
TypeDescription
string

{string} Resource name string.

lookupEntry(request, options)

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

lookupEntry(request, options, callback)

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

lookupEntry(request, callback)

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

matchEntryFromEntryName(entryName)

matchEntryFromEntryName(entryName: string): string | number;

Parse the entry from Entry resource.

Parameter
TypeNameDescription
stringentryName

A fully-qualified path representing Entry resource.

Returns
TypeDescription
string | number

{string} A string representing the entry.

matchEntryFromTagName(tagName)

matchEntryFromTagName(tagName: string): string | number;

Parse the entry from Tag resource.

Parameter
TypeNameDescription
stringtagName

A fully-qualified path representing Tag resource.

Returns
TypeDescription
string | number

{string} A string representing the entry.

matchEntryGroupFromEntryGroupName(entryGroupName)

matchEntryGroupFromEntryGroupName(entryGroupName: string): string | number;

Parse the entry_group from EntryGroup resource.

Parameter
TypeNameDescription
stringentryGroupName

A fully-qualified path representing EntryGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the entry_group.

matchEntryGroupFromEntryName(entryName)

matchEntryGroupFromEntryName(entryName: string): string | number;

Parse the entry_group from Entry resource.

Parameter
TypeNameDescription
stringentryName

A fully-qualified path representing Entry resource.

Returns
TypeDescription
string | number

{string} A string representing the entry_group.

matchEntryGroupFromTagName(tagName)

matchEntryGroupFromTagName(tagName: string): string | number;

Parse the entry_group from Tag resource.

Parameter
TypeNameDescription
stringtagName

A fully-qualified path representing Tag resource.

Returns
TypeDescription
string | number

{string} A string representing the entry_group.

matchFieldFromTagTemplateFieldName(tagTemplateFieldName)

matchFieldFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the field from TagTemplateField resource.

Parameter
TypeNameDescription
stringtagTemplateFieldName

A fully-qualified path representing TagTemplateField resource.

Returns
TypeDescription
string | number

{string} A string representing the field.

matchLocationFromEntryGroupName(entryGroupName)

matchLocationFromEntryGroupName(entryGroupName: string): string | number;

Parse the location from EntryGroup resource.

Parameter
TypeNameDescription
stringentryGroupName

A fully-qualified path representing EntryGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEntryName(entryName)

matchLocationFromEntryName(entryName: string): string | number;

Parse the location from Entry resource.

Parameter
TypeNameDescription
stringentryName

A fully-qualified path representing Entry resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
TypeNameDescription
stringlocationName

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromPolicyTagName(policyTagName)

matchLocationFromPolicyTagName(policyTagName: string): string | number;

Parse the location from PolicyTag resource.

Parameter
TypeNameDescription
stringpolicyTagName

A fully-qualified path representing PolicyTag resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTagName(tagName)

matchLocationFromTagName(tagName: string): string | number;

Parse the location from Tag resource.

Parameter
TypeNameDescription
stringtagName

A fully-qualified path representing Tag resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTagTemplateFieldName(tagTemplateFieldName)

matchLocationFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the location from TagTemplateField resource.

Parameter
TypeNameDescription
stringtagTemplateFieldName

A fully-qualified path representing TagTemplateField resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTagTemplateName(tagTemplateName)

matchLocationFromTagTemplateName(tagTemplateName: string): string | number;

Parse the location from TagTemplate resource.

Parameter
TypeNameDescription
stringtagTemplateName

A fully-qualified path representing TagTemplate resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTaxonomyName(taxonomyName)

matchLocationFromTaxonomyName(taxonomyName: string): string | number;

Parse the location from Taxonomy resource.

Parameter
TypeNameDescription
stringtaxonomyName

A fully-qualified path representing Taxonomy resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchPolicyTagFromPolicyTagName(policyTagName)

matchPolicyTagFromPolicyTagName(policyTagName: string): string | number;

Parse the policy_tag from PolicyTag resource.

Parameter
TypeNameDescription
stringpolicyTagName

A fully-qualified path representing PolicyTag resource.

Returns
TypeDescription
string | number

{string} A string representing the policy_tag.

matchProjectFromEntryGroupName(entryGroupName)

matchProjectFromEntryGroupName(entryGroupName: string): string | number;

Parse the project from EntryGroup resource.

Parameter
TypeNameDescription
stringentryGroupName

A fully-qualified path representing EntryGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromEntryName(entryName)

matchProjectFromEntryName(entryName: string): string | number;

Parse the project from Entry resource.

Parameter
TypeNameDescription
stringentryName

A fully-qualified path representing Entry resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
TypeNameDescription
stringlocationName

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromPolicyTagName(policyTagName)

matchProjectFromPolicyTagName(policyTagName: string): string | number;

Parse the project from PolicyTag resource.

Parameter
TypeNameDescription
stringpolicyTagName

A fully-qualified path representing PolicyTag resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
TypeNameDescription
stringprojectName

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTagName(tagName)

matchProjectFromTagName(tagName: string): string | number;

Parse the project from Tag resource.

Parameter
TypeNameDescription
stringtagName

A fully-qualified path representing Tag resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTagTemplateFieldName(tagTemplateFieldName)

matchProjectFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the project from TagTemplateField resource.

Parameter
TypeNameDescription
stringtagTemplateFieldName

A fully-qualified path representing TagTemplateField resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTagTemplateName(tagTemplateName)

matchProjectFromTagTemplateName(tagTemplateName: string): string | number;

Parse the project from TagTemplate resource.

Parameter
TypeNameDescription
stringtagTemplateName

A fully-qualified path representing TagTemplate resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTaxonomyName(taxonomyName)

matchProjectFromTaxonomyName(taxonomyName: string): string | number;

Parse the project from Taxonomy resource.

Parameter
TypeNameDescription
stringtaxonomyName

A fully-qualified path representing Taxonomy resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchTagFromTagName(tagName)

matchTagFromTagName(tagName: string): string | number;

Parse the tag from Tag resource.

Parameter
TypeNameDescription
stringtagName

A fully-qualified path representing Tag resource.

Returns
TypeDescription
string | number

{string} A string representing the tag.

matchTagTemplateFromTagTemplateFieldName(tagTemplateFieldName)

matchTagTemplateFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the tag_template from TagTemplateField resource.

Parameter
TypeNameDescription
stringtagTemplateFieldName

A fully-qualified path representing TagTemplateField resource.

Returns
TypeDescription
string | number

{string} A string representing the tag_template.

matchTagTemplateFromTagTemplateName(tagTemplateName)

matchTagTemplateFromTagTemplateName(tagTemplateName: string): string | number;

Parse the tag_template from TagTemplate resource.

Parameter
TypeNameDescription
stringtagTemplateName

A fully-qualified path representing TagTemplate resource.

Returns
TypeDescription
string | number

{string} A string representing the tag_template.

matchTaxonomyFromPolicyTagName(policyTagName)

matchTaxonomyFromPolicyTagName(policyTagName: string): string | number;

Parse the taxonomy from PolicyTag resource.

Parameter
TypeNameDescription
stringpolicyTagName

A fully-qualified path representing PolicyTag resource.

Returns
TypeDescription
string | number

{string} A string representing the taxonomy.

matchTaxonomyFromTaxonomyName(taxonomyName)

matchTaxonomyFromTaxonomyName(taxonomyName: string): string | number;

Parse the taxonomy from Taxonomy resource.

Parameter
TypeNameDescription
stringtaxonomyName

A fully-qualified path representing Taxonomy resource.

Returns
TypeDescription
string | number

{string} A string representing the taxonomy.

policyTagPath(project, location, taxonomy, policyTag)

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

Return a fully-qualified policyTag resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringtaxonomy
stringpolicyTag
Returns
TypeDescription
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
TypeNameDescription
stringproject
Returns
TypeDescription
string

{string} Resource name string.

renameTagTemplateField(request, options)

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

renameTagTemplateField(request, options, callback)

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

renameTagTemplateField(request, callback)

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

searchCatalog(request, options)

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

searchCatalog(request, options, callback)

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

searchCatalog(request, callback)

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

searchCatalogAsync(request, options)

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

Equivalent to searchCatalog, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
TypeNameDescription
protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [SearchCatalogResult]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

searchCatalogStream(request, options)

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

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

Parameters
TypeNameDescription
protos.google.cloud.datacatalog.v1beta1.ISearchCatalogRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [SearchCatalogResult] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using searchCatalogAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

setIamPolicy(request, options)

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

setIamPolicy(request, options, callback)

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

setIamPolicy(request, callback)

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

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

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

Return a fully-qualified tag resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringentryGroup
stringentry
stringtag
Returns
TypeDescription
string

{string} Resource name string.

tagTemplateFieldPath(project, location, tagTemplate, field)

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

Return a fully-qualified tagTemplateField resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringtagTemplate
stringfield
Returns
TypeDescription
string

{string} Resource name string.

tagTemplatePath(project, location, tagTemplate)

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

Return a fully-qualified tagTemplate resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringtagTemplate
Returns
TypeDescription
string

{string} Resource name string.

taxonomyPath(project, location, taxonomy)

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

Return a fully-qualified taxonomy resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringtaxonomy
Returns
TypeDescription
string

{string} Resource name string.

testIamPermissions(request, options)

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

testIamPermissions(request, options, callback)

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

testIamPermissions(request, callback)

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

updateEntry(request, options)

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

updateEntry(request, options, callback)

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

updateEntry(request, callback)

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

updateEntryGroup(request, options)

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

updateEntryGroup(request, options, callback)

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

updateEntryGroup(request, callback)

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

updateTag(request, options)

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

updateTag(request, options, callback)

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

updateTag(request, callback)

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

updateTagTemplate(request, options)

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

updateTagTemplate(request, options, callback)

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

updateTagTemplate(request, callback)

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

updateTagTemplateField(request, options)

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

updateTagTemplateField(request, options, callback)

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

updateTagTemplateField(request, callback)

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