Class protos.google.cloud.datalabeling.v1beta1.AnnotationValue

Represents an AnnotationValue.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datalabeling.v1beta1.IAnnotationValue);

Constructs a new AnnotationValue.

Parameter

Type	Name	Description
IAnnotationValue	properties	Properties to set

Properties

imageBoundingPolyAnnotation

public imageBoundingPolyAnnotation?: (google.cloud.datalabeling.v1beta1.IImageBoundingPolyAnnotation|null);

AnnotationValue imageBoundingPolyAnnotation.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IImageBoundingPolyAnnotation\|null)

imageClassificationAnnotation

public imageClassificationAnnotation?: (google.cloud.datalabeling.v1beta1.IImageClassificationAnnotation|null);

AnnotationValue imageClassificationAnnotation.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IImageClassificationAnnotation\|null)

imagePolylineAnnotation

public imagePolylineAnnotation?: (google.cloud.datalabeling.v1beta1.IImagePolylineAnnotation|null);

AnnotationValue imagePolylineAnnotation.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IImagePolylineAnnotation\|null)

imageSegmentationAnnotation

public imageSegmentationAnnotation?: (google.cloud.datalabeling.v1beta1.IImageSegmentationAnnotation|null);

AnnotationValue imageSegmentationAnnotation.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IImageSegmentationAnnotation\|null)

textClassificationAnnotation

public textClassificationAnnotation?: (google.cloud.datalabeling.v1beta1.ITextClassificationAnnotation|null);

AnnotationValue textClassificationAnnotation.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ITextClassificationAnnotation\|null)

textEntityExtractionAnnotation

public textEntityExtractionAnnotation?: (google.cloud.datalabeling.v1beta1.ITextEntityExtractionAnnotation|null);

AnnotationValue textEntityExtractionAnnotation.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ITextEntityExtractionAnnotation\|null)

valueType

public valueType?: ("imageClassificationAnnotation"|"imageBoundingPolyAnnotation"|"imagePolylineAnnotation"|"imageSegmentationAnnotation"|"textClassificationAnnotation"|"textEntityExtractionAnnotation"|"videoClassificationAnnotation"|"videoObjectTrackingAnnotation"|"videoEventAnnotation");

AnnotationValue valueType.

Property Value

Type	Description
("imageClassificationAnnotation"\|"imageBoundingPolyAnnotation"\|"imagePolylineAnnotation"\|"imageSegmentationAnnotation"\|"textClassificationAnnotation"\|"textEntityExtractionAnnotation"\|"videoClassificationAnnotation"\|"videoObjectTrackingAnnotation"\|"videoEventAnnotation")

videoClassificationAnnotation

public videoClassificationAnnotation?: (google.cloud.datalabeling.v1beta1.IVideoClassificationAnnotation|null);

AnnotationValue videoClassificationAnnotation.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IVideoClassificationAnnotation\|null)

videoEventAnnotation

public videoEventAnnotation?: (google.cloud.datalabeling.v1beta1.IVideoEventAnnotation|null);

AnnotationValue videoEventAnnotation.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IVideoEventAnnotation\|null)

videoObjectTrackingAnnotation

public videoObjectTrackingAnnotation?: (google.cloud.datalabeling.v1beta1.IVideoObjectTrackingAnnotation|null);

AnnotationValue videoObjectTrackingAnnotation.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.IVideoObjectTrackingAnnotation\|null)

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IAnnotationValue): google.cloud.datalabeling.v1beta1.AnnotationValue;

Creates a new AnnotationValue instance using the specified properties.

Parameter

Type	Name	Description
IAnnotationValue	properties	Properties to set

Returns

Type	Description
google.cloud.datalabeling.v1beta1.AnnotationValue	AnnotationValue instance

decode(reader, length)

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

Decodes an AnnotationValue message from the specified reader or buffer.

Parameters

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from
number	length	Message length if known beforehand

Returns

Type	Description
google.cloud.datalabeling.v1beta1.AnnotationValue	AnnotationValue

decodeDelimited(reader)

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

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

Parameter

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from

Returns

Type	Description
google.cloud.datalabeling.v1beta1.AnnotationValue	AnnotationValue

encode(message, writer)

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

Encodes the specified AnnotationValue message. Does not implicitly messages.

Parameters

Type	Name	Description
IAnnotationValue	message	AnnotationValue message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

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

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

Parameters

Type	Name	Description
IAnnotationValue	message	AnnotationValue message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

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

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

Parameter

Type	Name	Description
{ [k: string]: any }	object	Plain object

Returns

Type	Description
google.cloud.datalabeling.v1beta1.AnnotationValue	AnnotationValue

toJSON()

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

Converts this AnnotationValue to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Type	Name	Description
google.cloud.datalabeling.v1beta1.AnnotationValue	message	AnnotationValue
$protobuf.IConversionOptions	options	Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

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

Verifies an AnnotationValue message.

Parameter

Type	Name	Description
{ [k: string]: any }	message	Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not