Class protos.google.cloud.datalabeling.v1beta1.EvaluationJob (3.1.1)

Represents an EvaluationJob.

Package

@google-cloud/datalabeling

Constructors

(constructor)(properties)

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

Constructs a new EvaluationJob.

Parameter
Name Description
properties IEvaluationJob

Properties to set

Properties

annotationSpecSet

public annotationSpecSet: string;

EvaluationJob annotationSpecSet.

attempts

public attempts: google.cloud.datalabeling.v1beta1.IAttempt[];

EvaluationJob attempts.

createTime

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

EvaluationJob createTime.

description

public description: string;

EvaluationJob description.

evaluationJobConfig

public evaluationJobConfig?: (google.cloud.datalabeling.v1beta1.IEvaluationJobConfig|null);

EvaluationJob evaluationJobConfig.

labelMissingGroundTruth

public labelMissingGroundTruth: boolean;

EvaluationJob labelMissingGroundTruth.

modelVersion

public modelVersion: string;

EvaluationJob modelVersion.

name

public name: string;

EvaluationJob name.

schedule

public schedule: string;

EvaluationJob schedule.

state

public state: (google.cloud.datalabeling.v1beta1.EvaluationJob.State|keyof typeof google.cloud.datalabeling.v1beta1.EvaluationJob.State);

EvaluationJob state.

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IEvaluationJob): google.cloud.datalabeling.v1beta1.EvaluationJob;

Creates a new EvaluationJob instance using the specified properties.

Parameter
Name Description
properties IEvaluationJob

Properties to set
Returns
Type Description
google.cloud.datalabeling.v1beta1.EvaluationJob

EvaluationJob instance

decode(reader, length)

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

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

EvaluationJob

decodeDelimited(reader)

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

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

EvaluationJob

encode(message, writer)

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

Encodes the specified EvaluationJob message. Does not implicitly messages.

Parameters
Name Description
message IEvaluationJob

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

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

Parameters
Name Description
message IEvaluationJob

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

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

EvaluationJob

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EvaluationJob

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

toJSON()

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

Converts this EvaluationJob to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.datalabeling.v1beta1.EvaluationJob

EvaluationJob
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 EvaluationJob 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