Represents an Annotation.
Package
@google-cloud/datalabeling!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.datalabeling.v1beta1.IAnnotation);
Constructs a new Annotation.
Type | Name | Description |
---|---|---|
IAnnotation | properties |
Properties to set |
Properties
annotationMetadata
public annotationMetadata?: (google.cloud.datalabeling.v1beta1.IAnnotationMetadata|null);
Annotation annotationMetadata.
Type | Description |
---|---|
(google.cloud.datalabeling.v1beta1.IAnnotationMetadata|null) |
annotationSentiment
public annotationSentiment: (google.cloud.datalabeling.v1beta1.AnnotationSentiment|keyof typeof google.cloud.datalabeling.v1beta1.AnnotationSentiment);
Annotation annotationSentiment.
Type | Description |
---|---|
(google.cloud.datalabeling.v1beta1.AnnotationSentiment|keyof typeof google.cloud.datalabeling.v1beta1.AnnotationSentiment) |
annotationSource
public annotationSource: (google.cloud.datalabeling.v1beta1.AnnotationSource|keyof typeof google.cloud.datalabeling.v1beta1.AnnotationSource);
Annotation annotationSource.
Type | Description |
---|---|
(google.cloud.datalabeling.v1beta1.AnnotationSource|keyof typeof google.cloud.datalabeling.v1beta1.AnnotationSource) |
annotationValue
public annotationValue?: (google.cloud.datalabeling.v1beta1.IAnnotationValue|null);
Annotation annotationValue.
Type | Description |
---|---|
(google.cloud.datalabeling.v1beta1.IAnnotationValue|null) |
name
public name: string;
Annotation name.
Type | Description |
---|---|
string |
Methods
create(properties)
public static create(properties?: google.cloud.datalabeling.v1beta1.IAnnotation): google.cloud.datalabeling.v1beta1.Annotation;
Creates a new Annotation instance using the specified properties.
Type | Name | Description |
---|---|---|
IAnnotation | properties |
Properties to set |
Type | Description |
---|---|
google.cloud.datalabeling.v1beta1.Annotation | Annotation instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datalabeling.v1beta1.Annotation;
Decodes an Annotation message from the specified reader or buffer.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
number | length |
Message length if known beforehand |
Type | Description |
---|---|
google.cloud.datalabeling.v1beta1.Annotation | Annotation |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datalabeling.v1beta1.Annotation;
Decodes an Annotation message from the specified reader or buffer, length delimited.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
Type | Description |
---|---|
google.cloud.datalabeling.v1beta1.Annotation | Annotation |
encode(message, writer)
public static encode(message: google.cloud.datalabeling.v1beta1.IAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Annotation message. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IAnnotation | message |
Annotation message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.datalabeling.v1beta1.IAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Annotation message, length delimited. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IAnnotation | message |
Annotation message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.datalabeling.v1beta1.Annotation;
Creates an Annotation message from a plain object. Also converts values to their respective internal types.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | object |
Plain object |
Type | Description |
---|---|
google.cloud.datalabeling.v1beta1.Annotation | Annotation |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Annotation to JSON.
Type | Description |
---|---|
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datalabeling.v1beta1.Annotation, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an Annotation message. Also converts values to other types if specified.
Type | Name | Description |
---|---|---|
google.cloud.datalabeling.v1beta1.Annotation | message |
Annotation |
$protobuf.IConversionOptions | options |
Conversion options |
Type | Description |
---|---|
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies an Annotation message.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | message |
Plain object to verify |
Type | Description |
---|---|
(string|null) |
|