Class v1beta1.PolicyTagManagerClient

Version 2.4.2

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

The policy tag manager API service allows clients to manage their taxonomies and policy tags. v1beta1

Package

@google-cloud/datacatalog!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of PolicyTagManagerClient.

Parameter

Type	Name	Description
ClientOptions	opts

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

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

Property Value

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

pathTemplates

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

Property Value

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

policyTagManagerStub

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

Property Value

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

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

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

Property Value

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

warn

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

Property Value

Type	Description
(code: string, message: string, warnType?: string) => void

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createPolicyTag(request, options)

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

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.ICreatePolicyTagRequest	request
CallOptions	options

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IPolicyTag, (protos.google.cloud.datacatalog.v1beta1.ICreatePolicyTagRequest | undefined), {} | undefined]>

createPolicyTag(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createPolicyTag(request, callback)

createPolicyTag(request: protos.google.cloud.datacatalog.v1beta1.ICreatePolicyTagRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IPolicyTag, protos.google.cloud.datacatalog.v1beta1.ICreatePolicyTagRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.ICreatePolicyTagRequest	request
Callback<protos.google.cloud.datacatalog.v1beta1.IPolicyTag, protos.google.cloud.datacatalog.v1beta1.ICreatePolicyTagRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
void

createTaxonomy(request, options)

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

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.ICreateTaxonomyRequest	request
CallOptions	options

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITaxonomy, (protos.google.cloud.datacatalog.v1beta1.ICreateTaxonomyRequest | undefined), {} | undefined]>

createTaxonomy(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createTaxonomy(request, callback)

createTaxonomy(request: protos.google.cloud.datacatalog.v1beta1.ICreateTaxonomyRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITaxonomy, protos.google.cloud.datacatalog.v1beta1.ICreateTaxonomyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.ICreateTaxonomyRequest	request
Callback<protos.google.cloud.datacatalog.v1beta1.ITaxonomy, protos.google.cloud.datacatalog.v1beta1.ICreateTaxonomyRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
void

deletePolicyTag(request, options)

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

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IDeletePolicyTagRequest	request
CallOptions	options

Returns

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

deletePolicyTag(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

deletePolicyTag(request, callback)

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

Parameters

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

Returns

Type	Description
void

deleteTaxonomy(request, options)

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

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IDeleteTaxonomyRequest	request
CallOptions	options

Returns

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

deleteTaxonomy(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

deleteTaxonomy(request, callback)

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

Parameters

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

Returns

Type	Description
void

entryGroupPath(project, location, entryGroup)

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

Return a fully-qualified entryGroup resource name string.

Parameters

Type	Name	Description
string	project
string	location
string	entryGroup

Returns

Type	Description
string	{string} Resource name string.

entryPath(project, location, entryGroup, entry)

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

Return a fully-qualified entry resource name string.

Parameters

Type	Name	Description
string	project
string	location
string	entryGroup
string	entry

Returns

Type	Description
string	{string} Resource name string.

getIamPolicy(request, options)

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

Parameters

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

Returns

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

getIamPolicy(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

getIamPolicy(request, callback)

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

Parameters

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

Returns

Type	Description
void

getPolicyTag(request, options)

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

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IGetPolicyTagRequest	request
CallOptions	options

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IPolicyTag, protos.google.cloud.datacatalog.v1beta1.IGetPolicyTagRequest | undefined, {} | undefined]>

getPolicyTag(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

getPolicyTag(request, callback)

getPolicyTag(request: protos.google.cloud.datacatalog.v1beta1.IGetPolicyTagRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IPolicyTag, protos.google.cloud.datacatalog.v1beta1.IGetPolicyTagRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IGetPolicyTagRequest	request
Callback<protos.google.cloud.datacatalog.v1beta1.IPolicyTag, protos.google.cloud.datacatalog.v1beta1.IGetPolicyTagRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

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

Parameter

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

Returns

Type	Description
void

getTaxonomy(request, options)

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

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IGetTaxonomyRequest	request
CallOptions	options

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITaxonomy, protos.google.cloud.datacatalog.v1beta1.IGetTaxonomyRequest | undefined, {} | undefined]>

getTaxonomy(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

getTaxonomy(request, callback)

getTaxonomy(request: protos.google.cloud.datacatalog.v1beta1.IGetTaxonomyRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITaxonomy, protos.google.cloud.datacatalog.v1beta1.IGetTaxonomyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IGetTaxonomyRequest	request
Callback<protos.google.cloud.datacatalog.v1beta1.ITaxonomy, protos.google.cloud.datacatalog.v1beta1.IGetTaxonomyRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
void

initialize()

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

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

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

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listPolicyTags(request, options)

listPolicyTags(request?: protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.IPolicyTag[], protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest | null, protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsResponse]>;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest	request
CallOptions	options

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IPolicyTag[], protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest | null, protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsResponse]>

listPolicyTags(request, options, callback)

listPolicyTags(request: protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest, protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IPolicyTag>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest	request
CallOptions	options
PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest, protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IPolicyTag>	callback

Returns

Type	Description
void

listPolicyTags(request, callback)

listPolicyTags(request: protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest, protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IPolicyTag>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest	request
PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest, protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.IPolicyTag>	callback

Returns

Type	Description
void

listPolicyTagsAsync(request, options)

listPolicyTagsAsync(request?: protos.google.cloud.datacatalog.v1beta1.IListPolicyTagsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datacatalog.v1beta1.IPolicyTag>;

Equivalent to listPolicyTags, but returns an iterable object.

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

Parameters

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

Returns

Type

Description

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

{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 [PolicyTag]. 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.

listPolicyTagsStream(request, options)

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

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

Parameters

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

Returns

Type

Description

Transform

{Stream} An object stream which emits an object representing [PolicyTag] 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 listPolicyTagsAsync() 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.

listTaxonomies(request, options)

listTaxonomies(request?: protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest, options?: CallOptions): Promise<[protos.google.cloud.datacatalog.v1beta1.ITaxonomy[], protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest | null, protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesResponse]>;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest	request
CallOptions	options

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITaxonomy[], protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest | null, protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesResponse]>

listTaxonomies(request, options, callback)

listTaxonomies(request: protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest, protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ITaxonomy>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest	request
CallOptions	options
PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest, protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ITaxonomy>	callback

Returns

Type	Description
void

listTaxonomies(request, callback)

listTaxonomies(request: protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest, callback: PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest, protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ITaxonomy>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest	request
PaginationCallback<protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest, protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesResponse | null | undefined, protos.google.cloud.datacatalog.v1beta1.ITaxonomy>	callback

Returns

Type	Description
void

listTaxonomiesAsync(request, options)

listTaxonomiesAsync(request?: protos.google.cloud.datacatalog.v1beta1.IListTaxonomiesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datacatalog.v1beta1.ITaxonomy>;

Equivalent to listTaxonomies, but returns an iterable object.

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

Parameters

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

Returns

Type

Description

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

{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 [Taxonomy]. 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.

listTaxonomiesStream(request, options)

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

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

Parameters

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

Returns

Type

Description

Transform

{Stream} An object stream which emits an object representing [Taxonomy] 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 listTaxonomiesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters

Type	Name	Description
string	project
string	location

Returns

Type	Description
string	{string} Resource name string.

matchEntryFromEntryName(entryName)

matchEntryFromEntryName(entryName: string): string | number;

Parse the entry from Entry resource.

Parameter

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

Returns

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

matchEntryFromTagName(tagName)

matchEntryFromTagName(tagName: string): string | number;

Parse the entry from Tag resource.

Parameter

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

Returns

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

matchEntryGroupFromEntryGroupName(entryGroupName)

matchEntryGroupFromEntryGroupName(entryGroupName: string): string | number;

Parse the entry_group from EntryGroup resource.

Parameter

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

Returns

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

matchEntryGroupFromEntryName(entryName)

matchEntryGroupFromEntryName(entryName: string): string | number;

Parse the entry_group from Entry resource.

Parameter

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

Returns

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

matchEntryGroupFromTagName(tagName)

matchEntryGroupFromTagName(tagName: string): string | number;

Parse the entry_group from Tag resource.

Parameter

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

Returns

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

matchFieldFromTagTemplateFieldName(tagTemplateFieldName)

matchFieldFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the field from TagTemplateField resource.

Parameter

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

Returns

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

matchLocationFromEntryGroupName(entryGroupName)

matchLocationFromEntryGroupName(entryGroupName: string): string | number;

Parse the location from EntryGroup resource.

Parameter

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

Returns

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

matchLocationFromEntryName(entryName)

matchLocationFromEntryName(entryName: string): string | number;

Parse the location from Entry resource.

Parameter

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

Returns

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

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

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

Returns

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

matchLocationFromPolicyTagName(policyTagName)

matchLocationFromPolicyTagName(policyTagName: string): string | number;

Parse the location from PolicyTag resource.

Parameter

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

Returns

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

matchLocationFromTagName(tagName)

matchLocationFromTagName(tagName: string): string | number;

Parse the location from Tag resource.

Parameter

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

Returns

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

matchLocationFromTagTemplateFieldName(tagTemplateFieldName)

matchLocationFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the location from TagTemplateField resource.

Parameter

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

Returns

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

matchLocationFromTagTemplateName(tagTemplateName)

matchLocationFromTagTemplateName(tagTemplateName: string): string | number;

Parse the location from TagTemplate resource.

Parameter

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

Returns

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

matchLocationFromTaxonomyName(taxonomyName)

matchLocationFromTaxonomyName(taxonomyName: string): string | number;

Parse the location from Taxonomy resource.

Parameter

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

Returns

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

matchPolicyTagFromPolicyTagName(policyTagName)

matchPolicyTagFromPolicyTagName(policyTagName: string): string | number;

Parse the policy_tag from PolicyTag resource.

Parameter

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

Returns

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

matchProjectFromEntryGroupName(entryGroupName)

matchProjectFromEntryGroupName(entryGroupName: string): string | number;

Parse the project from EntryGroup resource.

Parameter

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

Returns

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

matchProjectFromEntryName(entryName)

matchProjectFromEntryName(entryName: string): string | number;

Parse the project from Entry resource.

Parameter

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

Returns

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

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

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

Returns

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

matchProjectFromPolicyTagName(policyTagName)

matchProjectFromPolicyTagName(policyTagName: string): string | number;

Parse the project from PolicyTag resource.

Parameter

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

Returns

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

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

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

Returns

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

matchProjectFromTagName(tagName)

matchProjectFromTagName(tagName: string): string | number;

Parse the project from Tag resource.

Parameter

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

Returns

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

matchProjectFromTagTemplateFieldName(tagTemplateFieldName)

matchProjectFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the project from TagTemplateField resource.

Parameter

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

Returns

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

matchProjectFromTagTemplateName(tagTemplateName)

matchProjectFromTagTemplateName(tagTemplateName: string): string | number;

Parse the project from TagTemplate resource.

Parameter

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

Returns

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

matchProjectFromTaxonomyName(taxonomyName)

matchProjectFromTaxonomyName(taxonomyName: string): string | number;

Parse the project from Taxonomy resource.

Parameter

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

Returns

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

matchTagFromTagName(tagName)

matchTagFromTagName(tagName: string): string | number;

Parse the tag from Tag resource.

Parameter

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

Returns

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

matchTagTemplateFromTagTemplateFieldName(tagTemplateFieldName)

matchTagTemplateFromTagTemplateFieldName(tagTemplateFieldName: string): string | number;

Parse the tag_template from TagTemplateField resource.

Parameter

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

Returns

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

matchTagTemplateFromTagTemplateName(tagTemplateName)

matchTagTemplateFromTagTemplateName(tagTemplateName: string): string | number;

Parse the tag_template from TagTemplate resource.

Parameter

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

Returns

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

matchTaxonomyFromPolicyTagName(policyTagName)

matchTaxonomyFromPolicyTagName(policyTagName: string): string | number;

Parse the taxonomy from PolicyTag resource.

Parameter

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

Returns

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

matchTaxonomyFromTaxonomyName(taxonomyName)

matchTaxonomyFromTaxonomyName(taxonomyName: string): string | number;

Parse the taxonomy from Taxonomy resource.

Parameter

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

Returns

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

policyTagPath(project, location, taxonomy, policyTag)

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

Return a fully-qualified policyTag resource name string.

Parameters

Type	Name	Description
string	project
string	location
string	taxonomy
string	policyTag

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Type	Name	Description
string	project

Returns

Type	Description
string	{string} Resource name string.

setIamPolicy(request, options)

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

Parameters

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

Returns

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

setIamPolicy(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

setIamPolicy(request, callback)

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

Parameters

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

Returns

Type	Description
void

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

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

Return a fully-qualified tag resource name string.

Parameters

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

Returns

Type	Description
string	{string} Resource name string.

tagTemplateFieldPath(project, location, tagTemplate, field)

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

Return a fully-qualified tagTemplateField resource name string.

Parameters

Type	Name	Description
string	project
string	location
string	tagTemplate
string	field

Returns

Type	Description
string	{string} Resource name string.

tagTemplatePath(project, location, tagTemplate)

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

Return a fully-qualified tagTemplate resource name string.

Parameters

Type	Name	Description
string	project
string	location
string	tagTemplate

Returns

Type	Description
string	{string} Resource name string.

taxonomyPath(project, location, taxonomy)

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

Return a fully-qualified taxonomy resource name string.

Parameters

Type	Name	Description
string	project
string	location
string	taxonomy

Returns

Type	Description
string	{string} Resource name string.

testIamPermissions(request, options)

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

Parameters

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

Returns

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

testIamPermissions(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

testIamPermissions(request, callback)

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

Parameters

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

Returns

Type	Description
void

updatePolicyTag(request, options)

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

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IUpdatePolicyTagRequest	request
CallOptions	options

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.IPolicyTag, (protos.google.cloud.datacatalog.v1beta1.IUpdatePolicyTagRequest | undefined), {} | undefined]>

updatePolicyTag(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

updatePolicyTag(request, callback)

updatePolicyTag(request: protos.google.cloud.datacatalog.v1beta1.IUpdatePolicyTagRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.IPolicyTag, protos.google.cloud.datacatalog.v1beta1.IUpdatePolicyTagRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IUpdatePolicyTagRequest	request
Callback<protos.google.cloud.datacatalog.v1beta1.IPolicyTag, protos.google.cloud.datacatalog.v1beta1.IUpdatePolicyTagRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
void

updateTaxonomy(request, options)

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

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IUpdateTaxonomyRequest	request
CallOptions	options

Returns

Type	Description
Promise<[protos.google.cloud.datacatalog.v1beta1.ITaxonomy, (protos.google.cloud.datacatalog.v1beta1.IUpdateTaxonomyRequest | undefined), {} | undefined]>

updateTaxonomy(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

updateTaxonomy(request, callback)

updateTaxonomy(request: protos.google.cloud.datacatalog.v1beta1.IUpdateTaxonomyRequest, callback: Callback<protos.google.cloud.datacatalog.v1beta1.ITaxonomy, protos.google.cloud.datacatalog.v1beta1.IUpdateTaxonomyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1beta1.IUpdateTaxonomyRequest	request
Callback<protos.google.cloud.datacatalog.v1beta1.ITaxonomy, protos.google.cloud.datacatalog.v1beta1.IUpdateTaxonomyRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
void