Represents an AnnotationValue.
Package
@google-cloud/datalabelingConstructors
(constructor)(properties)
constructor(properties?: google.cloud.datalabeling.v1beta1.IAnnotationValue);Constructs a new AnnotationValue.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAnnotationValue
Properties to set |
Properties
imageBoundingPolyAnnotation
public imageBoundingPolyAnnotation?: (google.cloud.datalabeling.v1beta1.IImageBoundingPolyAnnotation|null);AnnotationValue imageBoundingPolyAnnotation.
imageClassificationAnnotation
public imageClassificationAnnotation?: (google.cloud.datalabeling.v1beta1.IImageClassificationAnnotation|null);AnnotationValue imageClassificationAnnotation.
imagePolylineAnnotation
public imagePolylineAnnotation?: (google.cloud.datalabeling.v1beta1.IImagePolylineAnnotation|null);AnnotationValue imagePolylineAnnotation.
imageSegmentationAnnotation
public imageSegmentationAnnotation?: (google.cloud.datalabeling.v1beta1.IImageSegmentationAnnotation|null);AnnotationValue imageSegmentationAnnotation.
textClassificationAnnotation
public textClassificationAnnotation?: (google.cloud.datalabeling.v1beta1.ITextClassificationAnnotation|null);AnnotationValue textClassificationAnnotation.
textEntityExtractionAnnotation
public textEntityExtractionAnnotation?: (google.cloud.datalabeling.v1beta1.ITextEntityExtractionAnnotation|null);AnnotationValue textEntityExtractionAnnotation.
valueType
public valueType?: ("imageClassificationAnnotation"|"imageBoundingPolyAnnotation"|"imagePolylineAnnotation"|"imageSegmentationAnnotation"|"textClassificationAnnotation"|"textEntityExtractionAnnotation"|"videoClassificationAnnotation"|"videoObjectTrackingAnnotation"|"videoEventAnnotation");AnnotationValue valueType.
videoClassificationAnnotation
public videoClassificationAnnotation?: (google.cloud.datalabeling.v1beta1.IVideoClassificationAnnotation|null);AnnotationValue videoClassificationAnnotation.
videoEventAnnotation
public videoEventAnnotation?: (google.cloud.datalabeling.v1beta1.IVideoEventAnnotation|null);AnnotationValue videoEventAnnotation.
videoObjectTrackingAnnotation
public videoObjectTrackingAnnotation?: (google.cloud.datalabeling.v1beta1.IVideoObjectTrackingAnnotation|null);AnnotationValue videoObjectTrackingAnnotation.
Methods
create(properties)
public static create(properties?: google.cloud.datalabeling.v1beta1.IAnnotationValue): google.cloud.datalabeling.v1beta1.AnnotationValue;Creates a new AnnotationValue instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAnnotationValue
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.datalabeling.v1beta1.AnnotationValue | AnnotationValue instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datalabeling.v1beta1.AnnotationValue;Decodes an AnnotationValue message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.cloud.datalabeling.v1beta1.AnnotationValue | AnnotationValue |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datalabeling.v1beta1.AnnotationValue;Decodes an AnnotationValue message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.cloud.datalabeling.v1beta1.AnnotationValue | AnnotationValue |
encode(message, writer)
public static encode(message: google.cloud.datalabeling.v1beta1.IAnnotationValue, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AnnotationValue message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAnnotationValue
AnnotationValue message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.datalabeling.v1beta1.IAnnotationValue, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AnnotationValue message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAnnotationValue
AnnotationValue message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.datalabeling.v1beta1.AnnotationValue;Creates an AnnotationValue message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.cloud.datalabeling.v1beta1.AnnotationValue | AnnotationValue |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AnnotationValue
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this AnnotationValue to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datalabeling.v1beta1.AnnotationValue, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an AnnotationValue message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.datalabeling.v1beta1.AnnotationValue
AnnotationValue |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an AnnotationValue message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|