AnnotationValue

google.cloud.datalabeling.v1beta1. AnnotationValue

Represents an AnnotationValue.

Constructor

new AnnotationValue(propertiesopt)

Constructs a new AnnotationValue.

Parameters:
Name Type Attributes Description
properties google.cloud.datalabeling.v1beta1.IAnnotationValue <optional>

Properties to set

Implements:
  • IAnnotationValue

Members

imageBoundingPolyAnnotation

AnnotationValue imageBoundingPolyAnnotation.

imageClassificationAnnotation

AnnotationValue imageClassificationAnnotation.

imagePolylineAnnotation

AnnotationValue imagePolylineAnnotation.

imageSegmentationAnnotation

AnnotationValue imageSegmentationAnnotation.

textClassificationAnnotation

AnnotationValue textClassificationAnnotation.

textEntityExtractionAnnotation

AnnotationValue textEntityExtractionAnnotation.

valueType

AnnotationValue valueType.

videoClassificationAnnotation

AnnotationValue videoClassificationAnnotation.

videoEventAnnotation

AnnotationValue videoEventAnnotation.

videoObjectTrackingAnnotation

AnnotationValue videoObjectTrackingAnnotation.

Methods

toJSON() → {Object.<string, *>}

Converts this AnnotationValue to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.datalabeling.v1beta1.AnnotationValue}

Creates a new AnnotationValue instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.datalabeling.v1beta1.IAnnotationValue <optional>

Properties to set

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

AnnotationValue instance

(static) decode(reader, lengthopt) → {google.cloud.datalabeling.v1beta1.AnnotationValue}

Decodes an AnnotationValue message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

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

AnnotationValue

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.datalabeling.v1beta1.AnnotationValue}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

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

AnnotationValue

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified AnnotationValue message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.datalabeling.v1beta1.IAnnotationValue

AnnotationValue message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.datalabeling.v1beta1.IAnnotationValue

AnnotationValue message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.datalabeling.v1beta1.AnnotationValue}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

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

AnnotationValue

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for AnnotationValue

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.datalabeling.v1beta1.AnnotationValue

AnnotationValue

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an AnnotationValue message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not