Class protos.google.cloud.datacatalog.v1beta1.Taxonomy

Represents a Taxonomy.

Package

@google-cloud/datacatalog!

Constructors

(constructor)(properties)

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

Constructs a new Taxonomy.

Parameter
TypeNameDescription
ITaxonomyproperties

Properties to set

Properties

activatedPolicyTypes

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

Taxonomy activatedPolicyTypes.

Property Value
TypeDescription
google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType[]

description

public description: string;

Taxonomy description.

Property Value
TypeDescription
string

displayName

public displayName: string;

Taxonomy displayName.

Property Value
TypeDescription
string

name

public name: string;

Taxonomy name.

Property Value
TypeDescription
string

Methods

create(properties)

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

Creates a new Taxonomy instance using the specified properties.

Parameter
TypeNameDescription
ITaxonomyproperties

Properties to set

Returns
TypeDescription
google.cloud.datacatalog.v1beta1.Taxonomy

Taxonomy instance

decode(reader, length)

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

Decodes a Taxonomy message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.datacatalog.v1beta1.Taxonomy

Taxonomy

decodeDelimited(reader)

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

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.datacatalog.v1beta1.Taxonomy

Taxonomy

encode(message, writer)

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

Encodes the specified Taxonomy message. Does not implicitly messages.

Parameters
TypeNameDescription
ITaxonomymessage

Taxonomy message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
ITaxonomymessage

Taxonomy message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.cloud.datacatalog.v1beta1.Taxonomy

Taxonomy

toJSON()

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

Converts this Taxonomy to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.cloud.datacatalog.v1beta1.Taxonomymessage

Taxonomy

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Taxonomy message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not