Class protos.google.cloud.datalabeling.v1beta1.LabelOperationMetadata

Represents a LabelOperationMetadata.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

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

Constructs a new LabelOperationMetadata.

Parameter

Type	Name	Description
ILabelOperationMetadata	properties	Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

LabelOperationMetadata createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

details

public details?: ("imageClassificationDetails"|"imageBoundingBoxDetails"|"imageBoundingPolyDetails"|"imageOrientedBoundingBoxDetails"|"imagePolylineDetails"|"imageSegmentationDetails"|"videoClassificationDetails"|"videoObjectDetectionDetails"|"videoObjectTrackingDetails"|"videoEventDetails"|"textClassificationDetails"|"textEntityExtractionDetails");

LabelOperationMetadata details.

Property Value

Type	Description
("imageClassificationDetails"\|"imageBoundingBoxDetails"\|"imageBoundingPolyDetails"\|"imageOrientedBoundingBoxDetails"\|"imagePolylineDetails"\|"imageSegmentationDetails"\|"videoClassificationDetails"\|"videoObjectDetectionDetails"\|"videoObjectTrackingDetails"\|"videoEventDetails"\|"textClassificationDetails"\|"textEntityExtractionDetails")

imageBoundingBoxDetails

public imageBoundingBoxDetails?: (google.cloud.datalabeling.v1beta1.ILabelImageBoundingBoxOperationMetadata|null);

LabelOperationMetadata imageBoundingBoxDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelImageBoundingBoxOperationMetadata\|null)

imageBoundingPolyDetails

public imageBoundingPolyDetails?: (google.cloud.datalabeling.v1beta1.ILabelImageBoundingPolyOperationMetadata|null);

LabelOperationMetadata imageBoundingPolyDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelImageBoundingPolyOperationMetadata\|null)

imageClassificationDetails

public imageClassificationDetails?: (google.cloud.datalabeling.v1beta1.ILabelImageClassificationOperationMetadata|null);

LabelOperationMetadata imageClassificationDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelImageClassificationOperationMetadata\|null)

imageOrientedBoundingBoxDetails

public imageOrientedBoundingBoxDetails?: (google.cloud.datalabeling.v1beta1.ILabelImageOrientedBoundingBoxOperationMetadata|null);

LabelOperationMetadata imageOrientedBoundingBoxDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelImageOrientedBoundingBoxOperationMetadata\|null)

imagePolylineDetails

public imagePolylineDetails?: (google.cloud.datalabeling.v1beta1.ILabelImagePolylineOperationMetadata|null);

LabelOperationMetadata imagePolylineDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelImagePolylineOperationMetadata\|null)

imageSegmentationDetails

public imageSegmentationDetails?: (google.cloud.datalabeling.v1beta1.ILabelImageSegmentationOperationMetadata|null);

LabelOperationMetadata imageSegmentationDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelImageSegmentationOperationMetadata\|null)

partialFailures

public partialFailures: google.rpc.IStatus[];

LabelOperationMetadata partialFailures.

Property Value

Type	Description
google.rpc.IStatus[]

progressPercent

public progressPercent: number;

LabelOperationMetadata progressPercent.

Property Value

Type	Description
number

textClassificationDetails

public textClassificationDetails?: (google.cloud.datalabeling.v1beta1.ILabelTextClassificationOperationMetadata|null);

LabelOperationMetadata textClassificationDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelTextClassificationOperationMetadata\|null)

textEntityExtractionDetails

public textEntityExtractionDetails?: (google.cloud.datalabeling.v1beta1.ILabelTextEntityExtractionOperationMetadata|null);

LabelOperationMetadata textEntityExtractionDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelTextEntityExtractionOperationMetadata\|null)

videoClassificationDetails

public videoClassificationDetails?: (google.cloud.datalabeling.v1beta1.ILabelVideoClassificationOperationMetadata|null);

LabelOperationMetadata videoClassificationDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelVideoClassificationOperationMetadata\|null)

videoEventDetails

public videoEventDetails?: (google.cloud.datalabeling.v1beta1.ILabelVideoEventOperationMetadata|null);

LabelOperationMetadata videoEventDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelVideoEventOperationMetadata\|null)

videoObjectDetectionDetails

public videoObjectDetectionDetails?: (google.cloud.datalabeling.v1beta1.ILabelVideoObjectDetectionOperationMetadata|null);

LabelOperationMetadata videoObjectDetectionDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelVideoObjectDetectionOperationMetadata\|null)

videoObjectTrackingDetails

public videoObjectTrackingDetails?: (google.cloud.datalabeling.v1beta1.ILabelVideoObjectTrackingOperationMetadata|null);

LabelOperationMetadata videoObjectTrackingDetails.

Property Value

Type	Description
(google.cloud.datalabeling.v1beta1.ILabelVideoObjectTrackingOperationMetadata\|null)

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.ILabelOperationMetadata): google.cloud.datalabeling.v1beta1.LabelOperationMetadata;

Creates a new LabelOperationMetadata instance using the specified properties.

Parameter

Type	Name	Description
ILabelOperationMetadata	properties	Properties to set

Returns

Type	Description
google.cloud.datalabeling.v1beta1.LabelOperationMetadata	LabelOperationMetadata instance

decode(reader, length)

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

Decodes a LabelOperationMetadata message from the specified reader or buffer.

Parameters

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from
number	length	Message length if known beforehand

Returns

Type	Description
google.cloud.datalabeling.v1beta1.LabelOperationMetadata	LabelOperationMetadata

decodeDelimited(reader)

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

Decodes a LabelOperationMetadata message from the specified reader or buffer, length delimited.

Parameter

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from

Returns

Type	Description
google.cloud.datalabeling.v1beta1.LabelOperationMetadata	LabelOperationMetadata

encode(message, writer)

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

Encodes the specified LabelOperationMetadata message. Does not implicitly messages.

Parameters

Type	Name	Description
ILabelOperationMetadata	message	LabelOperationMetadata message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

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

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

Parameters

Type	Name	Description
ILabelOperationMetadata	message	LabelOperationMetadata message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

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

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

Parameter

Type	Name	Description
{ [k: string]: any }	object	Plain object

Returns

Type	Description
google.cloud.datalabeling.v1beta1.LabelOperationMetadata	LabelOperationMetadata

toJSON()

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

Converts this LabelOperationMetadata to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Type	Name	Description
google.cloud.datalabeling.v1beta1.LabelOperationMetadata	message	LabelOperationMetadata
$protobuf.IConversionOptions	options	Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

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

Verifies a LabelOperationMetadata message.

Parameter

Type	Name	Description
{ [k: string]: any }	message	Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not