AnnotationPayload

google.cloud.automl.v1. AnnotationPayload

Represents an AnnotationPayload.

Constructor

new AnnotationPayload(propertiesopt)

Constructs a new AnnotationPayload.

Parameters:
Name Type Attributes Description
properties google.cloud.automl.v1.IAnnotationPayload <optional>

Properties to set

Implements:
  • IAnnotationPayload

Members

annotationSpecId :string

AnnotationPayload annotationSpecId.

classification :google.cloud.automl.v1.IClassificationAnnotation|null|undefined

AnnotationPayload classification.

detail :"translation"|"classification"|"imageObjectDetection"|"textExtraction"|"textSentiment"|undefined

AnnotationPayload detail.

displayName :string

AnnotationPayload displayName.

imageObjectDetection :google.cloud.automl.v1.IImageObjectDetectionAnnotation|null|undefined

AnnotationPayload imageObjectDetection.

textExtraction :google.cloud.automl.v1.ITextExtractionAnnotation|null|undefined

AnnotationPayload textExtraction.

textSentiment :google.cloud.automl.v1.ITextSentimentAnnotation|null|undefined

AnnotationPayload textSentiment.

translation :google.cloud.automl.v1.ITranslationAnnotation|null|undefined

AnnotationPayload translation.

Methods

(static) create(propertiesopt) → {google.cloud.automl.v1.AnnotationPayload}

Creates a new AnnotationPayload instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.automl.v1.IAnnotationPayload <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.automl.v1.AnnotationPayload}

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

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.automl.v1.AnnotationPayload}

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

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

Reader or buffer to decode from

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 AnnotationPayload message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.automl.v1.IAnnotationPayload

AnnotationPayload message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

Parameters:
Name Type Attributes Description
message google.cloud.automl.v1.IAnnotationPayload

AnnotationPayload message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.automl.v1.AnnotationPayload}

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

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

Plain object

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

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

Parameters:
Name Type Attributes Description
message google.cloud.automl.v1.AnnotationPayload

AnnotationPayload

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies an AnnotationPayload message.

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

Plain object to verify

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

Converts this AnnotationPayload to JSON.