Class protos.google.cloud.datalabeling.v1beta1.LabelOperationMetadata (3.2.2)

Represents a LabelOperationMetadata.

Package

@google-cloud/datalabeling

Constructors

(constructor)(properties)

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

Constructs a new LabelOperationMetadata.

Parameter
NameDescription
properties ILabelOperationMetadata

Properties to set

Properties

createTime

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

LabelOperationMetadata createTime.

details

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

LabelOperationMetadata details.

imageBoundingBoxDetails

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

LabelOperationMetadata imageBoundingBoxDetails.

imageBoundingPolyDetails

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

LabelOperationMetadata imageBoundingPolyDetails.

imageClassificationDetails

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

LabelOperationMetadata imageClassificationDetails.

imageOrientedBoundingBoxDetails

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

LabelOperationMetadata imageOrientedBoundingBoxDetails.

imagePolylineDetails

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

LabelOperationMetadata imagePolylineDetails.

imageSegmentationDetails

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

LabelOperationMetadata imageSegmentationDetails.

partialFailures

public partialFailures: google.rpc.IStatus[];

LabelOperationMetadata partialFailures.

progressPercent

public progressPercent: number;

LabelOperationMetadata progressPercent.

textClassificationDetails

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

LabelOperationMetadata textClassificationDetails.

textEntityExtractionDetails

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

LabelOperationMetadata textEntityExtractionDetails.

videoClassificationDetails

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

LabelOperationMetadata videoClassificationDetails.

videoEventDetails

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

LabelOperationMetadata videoEventDetails.

videoObjectDetectionDetails

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

LabelOperationMetadata videoObjectDetectionDetails.

videoObjectTrackingDetails

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

LabelOperationMetadata videoObjectTrackingDetails.

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
NameDescription
properties ILabelOperationMetadata

Properties to set

Returns
TypeDescription
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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
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
NameDescription
message ILabelOperationMetadata

LabelOperationMetadata 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.datalabeling.v1beta1.ILabelOperationMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ILabelOperationMetadata

LabelOperationMetadata 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.datalabeling.v1beta1.LabelOperationMetadata;

Creates a LabelOperationMetadata 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.datalabeling.v1beta1.LabelOperationMetadata

LabelOperationMetadata

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for LabelOperationMetadata

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this LabelOperationMetadata to JSON.

Returns
TypeDescription
{ [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
NameDescription
message google.cloud.datalabeling.v1beta1.LabelOperationMetadata

LabelOperationMetadata

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a LabelOperationMetadata 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