Class protos.google.cloud.datacatalog.v1.Taxonomy (2.5.0)

Represents a Taxonomy.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datacatalog.v1.ITaxonomy);

Constructs a new Taxonomy.

Parameter

Name	Description
properties	`ITaxonomy` Properties to set

Properties

activatedPolicyTypes

public activatedPolicyTypes: google.cloud.datacatalog.v1.Taxonomy.PolicyType[];

Taxonomy activatedPolicyTypes.

description

public description: string;

Taxonomy description.

displayName

public displayName: string;

Taxonomy displayName.

name

public name: string;

Taxonomy name.

policyTagCount

public policyTagCount: number;

Taxonomy policyTagCount.

taxonomyTimestamps

public taxonomyTimestamps?: (google.cloud.datacatalog.v1.ISystemTimestamps|null);

Taxonomy taxonomyTimestamps.

Methods

create(properties)

public static create(properties?: google.cloud.datacatalog.v1.ITaxonomy): google.cloud.datacatalog.v1.Taxonomy;

Creates a new Taxonomy instance using the specified properties.

Parameter

Name	Description
properties	`ITaxonomy` Properties to set

Returns

Type	Description
google.cloud.datacatalog.v1.Taxonomy	Taxonomy instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datacatalog.v1.Taxonomy;

Decodes a Taxonomy message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.datacatalog.v1.Taxonomy	Taxonomy

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datacatalog.v1.Taxonomy;

Decodes a Taxonomy message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.datacatalog.v1.Taxonomy	Taxonomy

encode(message, writer)

public static encode(message: google.cloud.datacatalog.v1.ITaxonomy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Taxonomy message. Does not implicitly messages.

Parameters

Name	Description
message	`ITaxonomy` Taxonomy message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datacatalog.v1.ITaxonomy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Taxonomy message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`ITaxonomy` Taxonomy message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datacatalog.v1.Taxonomy;

Creates a Taxonomy message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.datacatalog.v1.Taxonomy	Taxonomy

toJSON()

public toJSON(): { [k: string]: any };

Converts this Taxonomy to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.datacatalog.v1.Taxonomy, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Taxonomy message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.datacatalog.v1.Taxonomy` Taxonomy
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Taxonomy message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not