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

Represents an Annotations.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataplex.v1.AspectType.MetadataTemplate.IAnnotations);

Constructs a new Annotations.

Parameter
NameDescription
properties IAnnotations

Properties to set

Properties

deprecated

public deprecated: string;

Annotations deprecated.

description

public description: string;

Annotations description.

displayName

public displayName: string;

Annotations displayName.

displayOrder

public displayOrder: number;

Annotations displayOrder.

stringType

public stringType: string;

Annotations stringType.

stringValues

public stringValues: string[];

Annotations stringValues.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.AspectType.MetadataTemplate.IAnnotations): google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations;

Creates a new Annotations instance using the specified properties.

Parameter
NameDescription
properties IAnnotations

Properties to set

Returns
TypeDescription
Annotations

Annotations instance

decode(reader, length)

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

Decodes an Annotations message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Annotations

Annotations

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Annotations

Annotations

encode(message, writer)

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

Encodes the specified Annotations message. Does not implicitly messages.

Parameters
NameDescription
message IAnnotations

Annotations message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dataplex.v1.AspectType.MetadataTemplate.IAnnotations, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAnnotations

Annotations message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations;

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

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

Plain object

Returns
TypeDescription
Annotations

Annotations

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Annotations

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Annotations to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Annotations

Annotations

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an Annotations message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not