Class protos.google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata

Represents an AnnotatedDatasetMetadata.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

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

Constructs a new AnnotatedDatasetMetadata.

Parameter

Type	Name	Description
IAnnotatedDatasetMetadata	properties	Properties to set

Properties

annotationRequestConfig

public annotationRequestConfig?: ("imageClassificationConfig"|"boundingPolyConfig"|"polylineConfig"|"segmentationConfig"|"videoClassificationConfig"|"objectDetectionConfig"|"objectTrackingConfig"|"eventConfig"|"textClassificationConfig"|"textEntityExtractionConfig");

AnnotatedDatasetMetadata annotationRequestConfig.

Property Value

Type	Description
("imageClassificationConfig"\|"boundingPolyConfig"\|"polylineConfig"\|"segmentationConfig"\|"videoClassificationConfig"\|"objectDetectionConfig"\|"objectTrackingConfig"\|"eventConfig"\|"textClassificationConfig"\|"textEntityExtractionConfig")

boundingPolyConfig

public boundingPolyConfig?: (google.cloud.datalabeling.v1beta1.IBoundingPolyConfig|null);

AnnotatedDatasetMetadata boundingPolyConfig.

Property Value

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

eventConfig

public eventConfig?: (google.cloud.datalabeling.v1beta1.IEventConfig|null);

AnnotatedDatasetMetadata eventConfig.

Property Value

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

humanAnnotationConfig

public humanAnnotationConfig?: (google.cloud.datalabeling.v1beta1.IHumanAnnotationConfig|null);

AnnotatedDatasetMetadata humanAnnotationConfig.

Property Value

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

imageClassificationConfig

public imageClassificationConfig?: (google.cloud.datalabeling.v1beta1.IImageClassificationConfig|null);

AnnotatedDatasetMetadata imageClassificationConfig.

Property Value

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

objectDetectionConfig

public objectDetectionConfig?: (google.cloud.datalabeling.v1beta1.IObjectDetectionConfig|null);

AnnotatedDatasetMetadata objectDetectionConfig.

Property Value

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

objectTrackingConfig

public objectTrackingConfig?: (google.cloud.datalabeling.v1beta1.IObjectTrackingConfig|null);

AnnotatedDatasetMetadata objectTrackingConfig.

Property Value

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

polylineConfig

public polylineConfig?: (google.cloud.datalabeling.v1beta1.IPolylineConfig|null);

AnnotatedDatasetMetadata polylineConfig.

Property Value

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

segmentationConfig

public segmentationConfig?: (google.cloud.datalabeling.v1beta1.ISegmentationConfig|null);

AnnotatedDatasetMetadata segmentationConfig.

Property Value

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

textClassificationConfig

public textClassificationConfig?: (google.cloud.datalabeling.v1beta1.ITextClassificationConfig|null);

AnnotatedDatasetMetadata textClassificationConfig.

Property Value

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

textEntityExtractionConfig

public textEntityExtractionConfig?: (google.cloud.datalabeling.v1beta1.ITextEntityExtractionConfig|null);

AnnotatedDatasetMetadata textEntityExtractionConfig.

Property Value

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

videoClassificationConfig

public videoClassificationConfig?: (google.cloud.datalabeling.v1beta1.IVideoClassificationConfig|null);

AnnotatedDatasetMetadata videoClassificationConfig.

Property Value

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

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IAnnotatedDatasetMetadata): google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata;

Creates a new AnnotatedDatasetMetadata instance using the specified properties.

Parameter

Type	Name	Description
IAnnotatedDatasetMetadata	properties	Properties to set

Returns

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

decode(reader, length)

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

Decodes an AnnotatedDatasetMetadata 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.AnnotatedDatasetMetadata	AnnotatedDatasetMetadata

decodeDelimited(reader)

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

Decodes an AnnotatedDatasetMetadata 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.AnnotatedDatasetMetadata	AnnotatedDatasetMetadata

encode(message, writer)

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

Encodes the specified AnnotatedDatasetMetadata message. Does not implicitly messages.

Parameters

Type	Name	Description
IAnnotatedDatasetMetadata	message	AnnotatedDatasetMetadata 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.IAnnotatedDatasetMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Type	Name	Description
IAnnotatedDatasetMetadata	message	AnnotatedDatasetMetadata 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.AnnotatedDatasetMetadata;

Creates an AnnotatedDatasetMetadata 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.AnnotatedDatasetMetadata	AnnotatedDatasetMetadata

toJSON()

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

Converts this AnnotatedDatasetMetadata to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Type	Name	Description
google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata	message	AnnotatedDatasetMetadata
$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 an AnnotatedDatasetMetadata 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