Class protos.google.cloud.datalabeling.v1beta1.Evaluation

Represents an Evaluation.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

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

Constructs a new Evaluation.

Parameter
TypeNameDescription
IEvaluationproperties

Properties to set

Properties

annotationType

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

Evaluation annotationType.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.AnnotationType|keyof typeof google.cloud.datalabeling.v1beta1.AnnotationType)

config

public config?: (google.cloud.datalabeling.v1beta1.IEvaluationConfig|null);

Evaluation config.

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

createTime

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

Evaluation createTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

evaluatedItemCount

public evaluatedItemCount: (number|Long|string);

Evaluation evaluatedItemCount.

Property Value
TypeDescription
(number|Long|string)

evaluationJobRunTime

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

Evaluation evaluationJobRunTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

evaluationMetrics

public evaluationMetrics?: (google.cloud.datalabeling.v1beta1.IEvaluationMetrics|null);

Evaluation evaluationMetrics.

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

name

public name: string;

Evaluation name.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IEvaluation): google.cloud.datalabeling.v1beta1.Evaluation;

Creates a new Evaluation instance using the specified properties.

Parameter
TypeNameDescription
IEvaluationproperties

Properties to set

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.Evaluation

Evaluation instance

decode(reader, length)

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

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

Evaluation

decodeDelimited(reader)

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

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

Evaluation

encode(message, writer)

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

Encodes the specified Evaluation message. Does not implicitly messages.

Parameters
TypeNameDescription
IEvaluationmessage

Evaluation 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.IEvaluation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
TypeNameDescription
IEvaluationmessage

Evaluation 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.Evaluation;

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

Evaluation

toJSON()

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

Converts this Evaluation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.cloud.datalabeling.v1beta1.Evaluationmessage

Evaluation

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an Evaluation 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