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

Represents an AspectType.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

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

Constructs a new AspectType.

Parameter
Name Description
properties IAspectType

Properties to set

Properties

authorization

public authorization?: (google.cloud.dataplex.v1.AspectType.IAuthorization|null);

AspectType authorization.

createTime

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

AspectType createTime.

description

public description: string;

AspectType description.

displayName

public displayName: string;

AspectType displayName.

etag

public etag: string;

AspectType etag.

labels

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

AspectType labels.

metadataTemplate

public metadataTemplate?: (google.cloud.dataplex.v1.AspectType.IMetadataTemplate|null);

AspectType metadataTemplate.

name

public name: string;

AspectType name.

transferStatus

public transferStatus: (google.cloud.dataplex.v1.TransferStatus|keyof typeof google.cloud.dataplex.v1.TransferStatus);

AspectType transferStatus.

uid

public uid: string;

AspectType uid.

updateTime

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

AspectType updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.IAspectType): google.cloud.dataplex.v1.AspectType;

Creates a new AspectType instance using the specified properties.

Parameter
Name Description
properties IAspectType

Properties to set

Returns
Type Description
AspectType

AspectType instance

decode(reader, length)

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

Decodes an AspectType 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
AspectType

AspectType

decodeDelimited(reader)

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

Decodes an AspectType message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AspectType

AspectType

encode(message, writer)

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

Encodes the specified AspectType message. Does not implicitly messages.

Parameters
Name Description
message IAspectType

AspectType 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.IAspectType, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAspectType

AspectType 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.AspectType;

Creates an AspectType 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
AspectType

AspectType

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AspectType

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 AspectType to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AspectType

AspectType

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 an AspectType 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