AnnotationPayload

google.cloud.automl.v1beta1. AnnotationPayload

Represents an AnnotationPayload.

Constructor

new AnnotationPayload(propertiesopt)

Constructs a new AnnotationPayload.

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

Properties to set

Implements:
  • IAnnotationPayload

Members

annotationSpecId

AnnotationPayload annotationSpecId.

classification

AnnotationPayload classification.

detail

AnnotationPayload detail.

displayName

AnnotationPayload displayName.

imageObjectDetection

AnnotationPayload imageObjectDetection.

tables

AnnotationPayload tables.

textExtraction

AnnotationPayload textExtraction.

textSentiment

AnnotationPayload textSentiment.

translation

AnnotationPayload translation.

videoClassification

AnnotationPayload videoClassification.

videoObjectTracking

AnnotationPayload videoObjectTracking.

Methods

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

Converts this AnnotationPayload to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new AnnotationPayload instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.automl.v1beta1.AnnotationPayload

AnnotationPayload instance

(static) decode(reader, lengthopt) → {google.cloud.automl.v1beta1.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

Returns:
Type Description
google.cloud.automl.v1beta1.AnnotationPayload

AnnotationPayload

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.v1beta1.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

Returns:
Type Description
google.cloud.automl.v1beta1.AnnotationPayload

AnnotationPayload

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.v1beta1.IAnnotationPayload

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

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

AnnotationPayload 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.automl.v1beta1.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

Returns:
Type Description
google.cloud.automl.v1beta1.AnnotationPayload

AnnotationPayload

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for AnnotationPayload

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 AnnotationPayload message. Also converts values to other types if specified.

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

AnnotationPayload

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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