Class protos.google.cloud.automl.v1beta1.AnnotationPayload

Represents an AnnotationPayload.

Package

@google-cloud/automl

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.automl.v1beta1.IAnnotationPayload);

Constructs a new AnnotationPayload.

Parameter
NameDescription
properties IAnnotationPayload

Properties to set

Properties

annotationSpecId

public annotationSpecId: string;

AnnotationPayload annotationSpecId.

classification

public classification?: (google.cloud.automl.v1beta1.IClassificationAnnotation|null);

AnnotationPayload classification.

detail

public detail?: ("translation"|"classification"|"imageObjectDetection"|"videoClassification"|"videoObjectTracking"|"textExtraction"|"textSentiment"|"tables");

AnnotationPayload detail.

displayName

public displayName: string;

AnnotationPayload displayName.

imageObjectDetection

public imageObjectDetection?: (google.cloud.automl.v1beta1.IImageObjectDetectionAnnotation|null);

AnnotationPayload imageObjectDetection.

tables

public tables?: (google.cloud.automl.v1beta1.ITablesAnnotation|null);

AnnotationPayload tables.

textExtraction

public textExtraction?: (google.cloud.automl.v1beta1.ITextExtractionAnnotation|null);

AnnotationPayload textExtraction.

textSentiment

public textSentiment?: (google.cloud.automl.v1beta1.ITextSentimentAnnotation|null);

AnnotationPayload textSentiment.

translation

public translation?: (google.cloud.automl.v1beta1.ITranslationAnnotation|null);

AnnotationPayload translation.

videoClassification

public videoClassification?: (google.cloud.automl.v1beta1.IVideoClassificationAnnotation|null);

AnnotationPayload videoClassification.

videoObjectTracking

public videoObjectTracking?: (google.cloud.automl.v1beta1.IVideoObjectTrackingAnnotation|null);

AnnotationPayload videoObjectTracking.

Methods

create(properties)

public static create(properties?: google.cloud.automl.v1beta1.IAnnotationPayload): google.cloud.automl.v1beta1.AnnotationPayload;

Creates a new AnnotationPayload instance using the specified properties.

Parameter
NameDescription
properties IAnnotationPayload

Properties to set

Returns
TypeDescription
google.cloud.automl.v1beta1.AnnotationPayload

AnnotationPayload instance

decode(reader, length)

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

Decodes an AnnotationPayload message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.automl.v1beta1.AnnotationPayload

AnnotationPayload

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.automl.v1beta1.AnnotationPayload

AnnotationPayload

encode(message, writer)

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

Encodes the specified AnnotationPayload message. Does not implicitly messages.

Parameters
NameDescription
message IAnnotationPayload

AnnotationPayload message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IAnnotationPayload

AnnotationPayload message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.automl.v1beta1.AnnotationPayload

AnnotationPayload

toJSON()

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

Converts this AnnotationPayload to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.automl.v1beta1.AnnotationPayload

AnnotationPayload

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AnnotationPayload message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not