Class protos.google.cloud.dataplex.v1.DataTaxonomy (3.7.0)

Represents a DataTaxonomy.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataplex.v1.IDataTaxonomy);

Constructs a new DataTaxonomy.

Parameter
Name Description
properties IDataTaxonomy

Properties to set

Properties

attributeCount

public attributeCount: number;

DataTaxonomy attributeCount.

classCount

public classCount: number;

DataTaxonomy classCount.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

DataTaxonomy createTime.

description

public description: string;

DataTaxonomy description.

displayName

public displayName: string;

DataTaxonomy displayName.

etag

public etag: string;

DataTaxonomy etag.

labels

public labels: { [k: string]: string };

DataTaxonomy labels.

name

public name: string;

DataTaxonomy name.

uid

public uid: string;

DataTaxonomy uid.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

DataTaxonomy updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.IDataTaxonomy): google.cloud.dataplex.v1.DataTaxonomy;

Creates a new DataTaxonomy instance using the specified properties.

Parameter
Name Description
properties IDataTaxonomy

Properties to set

Returns
Type Description
DataTaxonomy

DataTaxonomy instance

decode(reader, length)

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

Decodes a DataTaxonomy message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
DataTaxonomy

DataTaxonomy

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DataTaxonomy

DataTaxonomy

encode(message, writer)

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

Encodes the specified DataTaxonomy message. Does not implicitly messages.

Parameters
Name Description
message IDataTaxonomy

DataTaxonomy 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.dataplex.v1.IDataTaxonomy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IDataTaxonomy

DataTaxonomy 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.dataplex.v1.DataTaxonomy;

Creates a DataTaxonomy 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
DataTaxonomy

DataTaxonomy

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for DataTaxonomy

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

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

Converts this DataTaxonomy to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message DataTaxonomy

DataTaxonomy

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 DataTaxonomy 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