Class EvaluationJob (0.171.0)

public final class EvaluationJob extends GeneratedMessageV3 implements EvaluationJobOrBuilder

Defines an evaluation job that runs periodically to generate Evaluations. Creating an evaluation job is the starting point for using continuous evaluation.

Protobuf type google.cloud.datalabeling.v1beta1.EvaluationJob

Static Fields

ANNOTATION_SPEC_SET_FIELD_NUMBER

public static final int ANNOTATION_SPEC_SET_FIELD_NUMBER
Field Value
Type Description
int

ATTEMPTS_FIELD_NUMBER

public static final int ATTEMPTS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_JOB_CONFIG_FIELD_NUMBER

public static final int EVALUATION_JOB_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

LABEL_MISSING_GROUND_TRUTH_FIELD_NUMBER

public static final int LABEL_MISSING_GROUND_TRUTH_FIELD_NUMBER
Field Value
Type Description
int

MODEL_VERSION_FIELD_NUMBER

public static final int MODEL_VERSION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EvaluationJob getDefaultInstance()
Returns
Type Description
EvaluationJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static EvaluationJob.Builder newBuilder()
Returns
Type Description
EvaluationJob.Builder

newBuilder(EvaluationJob prototype)

public static EvaluationJob.Builder newBuilder(EvaluationJob prototype)
Parameter
Name Description
prototype EvaluationJob
Returns
Type Description
EvaluationJob.Builder

parseDelimitedFrom(InputStream input)

public static EvaluationJob parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EvaluationJob
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationJob
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EvaluationJob parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EvaluationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EvaluationJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EvaluationJob parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EvaluationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EvaluationJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EvaluationJob parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EvaluationJob
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationJob
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EvaluationJob parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EvaluationJob
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationJob
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EvaluationJob parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EvaluationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EvaluationJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationJob
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EvaluationJob> parser()
Returns
Type Description
Parser<EvaluationJob>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotationSpecSet()

public String getAnnotationSpecSet()

Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format:

"projects/<var>{project_id}</var>/annotationSpecSets/<var>{annotation_spec_set_id}</var>"

string annotation_spec_set = 7;

Returns
Type Description
String

The annotationSpecSet.

getAnnotationSpecSetBytes()

public ByteString getAnnotationSpecSetBytes()

Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format:

"projects/<var>{project_id}</var>/annotationSpecSets/<var>{annotation_spec_set_id}</var>"

string annotation_spec_set = 7;

Returns
Type Description
ByteString

The bytes for annotationSpecSet.

getAttempts(int index)

public Attempt getAttempts(int index)

Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.

repeated .google.cloud.datalabeling.v1beta1.Attempt attempts = 9;

Parameter
Name Description
index int
Returns
Type Description
Attempt

getAttemptsCount()

public int getAttemptsCount()

Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.

repeated .google.cloud.datalabeling.v1beta1.Attempt attempts = 9;

Returns
Type Description
int

getAttemptsList()

public List<Attempt> getAttemptsList()

Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.

repeated .google.cloud.datalabeling.v1beta1.Attempt attempts = 9;

Returns
Type Description
List<Attempt>

getAttemptsOrBuilder(int index)

public AttemptOrBuilder getAttemptsOrBuilder(int index)

Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.

repeated .google.cloud.datalabeling.v1beta1.Attempt attempts = 9;

Parameter
Name Description
index int
Returns
Type Description
AttemptOrBuilder

getAttemptsOrBuilderList()

public List<? extends AttemptOrBuilder> getAttemptsOrBuilderList()

Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.

repeated .google.cloud.datalabeling.v1beta1.Attempt attempts = 9;

Returns
Type Description
List<? extends com.google.cloud.datalabeling.v1beta1.AttemptOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp of when this evaluation job was created.

.google.protobuf.Timestamp create_time = 10;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp of when this evaluation job was created.

.google.protobuf.Timestamp create_time = 10;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public EvaluationJob getDefaultInstanceForType()
Returns
Type Description
EvaluationJob

getDescription()

public String getDescription()

Required. Description of the job. The description can be up to 25,000 characters long.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Required. Description of the job. The description can be up to 25,000 characters long.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getEvaluationJobConfig()

public EvaluationJobConfig getEvaluationJobConfig()

Required. Configuration details for the evaluation job.

.google.cloud.datalabeling.v1beta1.EvaluationJobConfig evaluation_job_config = 6;

Returns
Type Description
EvaluationJobConfig

The evaluationJobConfig.

getEvaluationJobConfigOrBuilder()

public EvaluationJobConfigOrBuilder getEvaluationJobConfigOrBuilder()

Required. Configuration details for the evaluation job.

.google.cloud.datalabeling.v1beta1.EvaluationJobConfig evaluation_job_config = 6;

Returns
Type Description
EvaluationJobConfigOrBuilder

getLabelMissingGroundTruth()

public boolean getLabelMissingGroundTruth()

Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to true. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to false.

bool label_missing_ground_truth = 8;

Returns
Type Description
boolean

The labelMissingGroundTruth.

getModelVersion()

public String getModelVersion()

Required. The AI Platform Prediction model version to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format:

"projects/<var>{project_id}</var>/models/<var>{model_name}</var>/versions/<var>{version_name}</var>"

There can only be one evaluation job per model version.

string model_version = 5;

Returns
Type Description
String

The modelVersion.

getModelVersionBytes()

public ByteString getModelVersionBytes()

Required. The AI Platform Prediction model version to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format:

"projects/<var>{project_id}</var>/models/<var>{model_name}</var>/versions/<var>{version_name}</var>"

There can only be one evaluation job per model version.

string model_version = 5;

Returns
Type Description
ByteString

The bytes for modelVersion.

getName()

public String getName()

Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<EvaluationJob> getParserForType()
Returns
Type Description
Parser<EvaluationJob>
Overrides

getSchedule()

public String getSchedule()

Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days.

You can provide the schedule in crontab format or in an English-like format.

Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day.

string schedule = 4;

Returns
Type Description
String

The schedule.

getScheduleBytes()

public ByteString getScheduleBytes()

Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days.

You can provide the schedule in crontab format or in an English-like format.

Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day.

string schedule = 4;

Returns
Type Description
ByteString

The bytes for schedule.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public EvaluationJob.State getState()

Output only. Describes the current state of the job.

.google.cloud.datalabeling.v1beta1.EvaluationJob.State state = 3;

Returns
Type Description
EvaluationJob.State

The state.

getStateValue()

public int getStateValue()

Output only. Describes the current state of the job.

.google.cloud.datalabeling.v1beta1.EvaluationJob.State state = 3;

Returns
Type Description
int

The enum numeric value on the wire for state.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp of when this evaluation job was created.

.google.protobuf.Timestamp create_time = 10;

Returns
Type Description
boolean

Whether the createTime field is set.

hasEvaluationJobConfig()

public boolean hasEvaluationJobConfig()

Required. Configuration details for the evaluation job.

.google.cloud.datalabeling.v1beta1.EvaluationJobConfig evaluation_job_config = 6;

Returns
Type Description
boolean

Whether the evaluationJobConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EvaluationJob.Builder newBuilderForType()
Returns
Type Description
EvaluationJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EvaluationJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EvaluationJob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public EvaluationJob.Builder toBuilder()
Returns
Type Description
EvaluationJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException