Class protos.google.cloud.aiplatform.v1.Annotation (1.14.1)

Represents an Annotation.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.IAnnotation);

Constructs a new Annotation.

Parameter
Name Description
properties IAnnotation

Properties to set

Properties

annotationSource

public annotationSource?: (google.cloud.aiplatform.v1.IUserActionReference|null);

Annotation annotationSource.

createTime

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

Annotation createTime.

etag

public etag: string;

Annotation etag.

labels

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

Annotation labels.

name

public name: string;

Annotation name.

payload

public payload?: (google.protobuf.IValue|null);

Annotation payload.

payloadSchemaUri

public payloadSchemaUri: string;

Annotation payloadSchemaUri.

updateTime

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

Annotation updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IAnnotation): google.cloud.aiplatform.v1.Annotation;

Creates a new Annotation instance using the specified properties.

Parameter
Name Description
properties IAnnotation

Properties to set
Returns
Type Description
google.cloud.aiplatform.v1.Annotation

Annotation instance

decode(reader, length)

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

Decodes an Annotation 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.aiplatform.v1.Annotation

Annotation

decodeDelimited(reader)

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

Decodes an Annotation 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.aiplatform.v1.Annotation

Annotation

encode(message, writer)

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

Encodes the specified Annotation message. Does not implicitly messages.

Parameters
Name Description
message IAnnotation

Annotation 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.aiplatform.v1.IAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAnnotation

Annotation 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.aiplatform.v1.Annotation;

Creates an Annotation 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.aiplatform.v1.Annotation

Annotation

toJSON()

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

Converts this Annotation to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.aiplatform.v1.Annotation

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