Class protos.google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation

Represents an ImageBoundingPolyAnnotation.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datalabeling.v1beta1.IImageBoundingPolyAnnotation);

Constructs a new ImageBoundingPolyAnnotation.

Parameter
TypeNameDescription
IImageBoundingPolyAnnotationproperties

Properties to set

Properties

annotationSpec

public annotationSpec?: (google.cloud.datalabeling.v1beta1.IAnnotationSpec|null);

ImageBoundingPolyAnnotation annotationSpec.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.IAnnotationSpec|null)

boundedArea

public boundedArea?: ("boundingPoly"|"normalizedBoundingPoly");

ImageBoundingPolyAnnotation boundedArea.

Property Value
TypeDescription
("boundingPoly"|"normalizedBoundingPoly")

boundingPoly

public boundingPoly?: (google.cloud.datalabeling.v1beta1.IBoundingPoly|null);

ImageBoundingPolyAnnotation boundingPoly.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.IBoundingPoly|null)

normalizedBoundingPoly

public normalizedBoundingPoly?: (google.cloud.datalabeling.v1beta1.INormalizedBoundingPoly|null);

ImageBoundingPolyAnnotation normalizedBoundingPoly.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.INormalizedBoundingPoly|null)

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IImageBoundingPolyAnnotation): google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation;

Creates a new ImageBoundingPolyAnnotation instance using the specified properties.

Parameter
TypeNameDescription
IImageBoundingPolyAnnotationproperties

Properties to set

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation

ImageBoundingPolyAnnotation instance

decode(reader, length)

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

Decodes an ImageBoundingPolyAnnotation message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation

ImageBoundingPolyAnnotation

decodeDelimited(reader)

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

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation

ImageBoundingPolyAnnotation

encode(message, writer)

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

Encodes the specified ImageBoundingPolyAnnotation message. Does not implicitly messages.

Parameters
TypeNameDescription
IImageBoundingPolyAnnotationmessage

ImageBoundingPolyAnnotation message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
IImageBoundingPolyAnnotationmessage

ImageBoundingPolyAnnotation message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

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

Plain object

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation

ImageBoundingPolyAnnotation

toJSON()

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

Converts this ImageBoundingPolyAnnotation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotationmessage

ImageBoundingPolyAnnotation

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an ImageBoundingPolyAnnotation message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not