Class v1.PolicyTagManagerSerializationClient

Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags. v1

Package

@google-cloud/datacatalog!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of PolicyTagManagerSerializationClient.

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

policyTagManagerSerializationStub

policyTagManagerSerializationStub?: 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.

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.

exportTaxonomies(request, options)

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

Parameters

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

Returns

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

exportTaxonomies(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

exportTaxonomies(request, callback)

exportTaxonomies(request: protos.google.cloud.datacatalog.v1.IExportTaxonomiesRequest, callback: Callback<protos.google.cloud.datacatalog.v1.IExportTaxonomiesResponse, protos.google.cloud.datacatalog.v1.IExportTaxonomiesRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1.IExportTaxonomiesRequest	request
Callback<protos.google.cloud.datacatalog.v1.IExportTaxonomiesResponse, protos.google.cloud.datacatalog.v1.IExportTaxonomiesRequest \| 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

importTaxonomies(request, options)

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

Parameters

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

Returns

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

importTaxonomies(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

importTaxonomies(request, callback)

importTaxonomies(request: protos.google.cloud.datacatalog.v1.IImportTaxonomiesRequest, callback: Callback<protos.google.cloud.datacatalog.v1.IImportTaxonomiesResponse, protos.google.cloud.datacatalog.v1.IImportTaxonomiesRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1.IImportTaxonomiesRequest	request
Callback<protos.google.cloud.datacatalog.v1.IImportTaxonomiesResponse, protos.google.cloud.datacatalog.v1.IImportTaxonomiesRequest \| 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.

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.

replaceTaxonomy(request, options)

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

Parameters

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

Returns

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

replaceTaxonomy(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

replaceTaxonomy(request, callback)

replaceTaxonomy(request: protos.google.cloud.datacatalog.v1.IReplaceTaxonomyRequest, callback: Callback<protos.google.cloud.datacatalog.v1.ITaxonomy, protos.google.cloud.datacatalog.v1.IReplaceTaxonomyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Type	Name	Description
protos.google.cloud.datacatalog.v1.IReplaceTaxonomyRequest	request
Callback<protos.google.cloud.datacatalog.v1.ITaxonomy, protos.google.cloud.datacatalog.v1.IReplaceTaxonomyRequest \| 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.