Class protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset (2.3.0)

Represents an AnnotatedDataset.

Package

Constructors

(constructor)(properties)

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

Constructs a new AnnotatedDataset.

Parameter

Name	Description
properties	`IAnnotatedDataset` Properties to set

Properties

annotationSource

public annotationSource: (google.cloud.datalabeling.v1beta1.AnnotationSource|keyof typeof google.cloud.datalabeling.v1beta1.AnnotationSource);

AnnotatedDataset annotationSource.

annotationType

public annotationType: (google.cloud.datalabeling.v1beta1.AnnotationType|keyof typeof google.cloud.datalabeling.v1beta1.AnnotationType);

AnnotatedDataset annotationType.

blockingResources

public blockingResources: string[];

AnnotatedDataset blockingResources.

completedExampleCount

public completedExampleCount: (number|Long|string);

AnnotatedDataset completedExampleCount.

createTime

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

AnnotatedDataset createTime.

description

public description: string;

AnnotatedDataset description.

displayName

public displayName: string;

AnnotatedDataset displayName.

exampleCount

public exampleCount: (number|Long|string);

AnnotatedDataset exampleCount.

labelStats

public labelStats?: (google.cloud.datalabeling.v1beta1.ILabelStats|null);

AnnotatedDataset labelStats.

metadata

public metadata?: (google.cloud.datalabeling.v1beta1.IAnnotatedDatasetMetadata|null);

AnnotatedDataset metadata.

name

public name: string;

AnnotatedDataset name.

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IAnnotatedDataset): google.cloud.datalabeling.v1beta1.AnnotatedDataset;

Creates a new AnnotatedDataset instance using the specified properties.

Parameter

Name	Description
properties	`IAnnotatedDataset` Properties to set

Returns

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

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified AnnotatedDataset message. Does not implicitly messages.

Parameters

Name	Description
message	`IAnnotatedDataset` AnnotatedDataset 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.IAnnotatedDataset, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IAnnotatedDataset` AnnotatedDataset 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.AnnotatedDataset;

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

toJSON()

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

Converts this AnnotatedDataset to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.datalabeling.v1beta1.AnnotatedDataset` AnnotatedDataset
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 AnnotatedDataset message.

Parameter

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

Returns

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