Interface EvaluationJobOrBuilder (0.162.0) 

public interface EvaluationJobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnnotationSpecSet()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 10;

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract 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 abstract 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 abstract 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 abstract EvaluationJobConfigOrBuilder getEvaluationJobConfigOrBuilder()

Required. Configuration details for the evaluation job.

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

Returns
Type Description
EvaluationJobConfigOrBuilder

getLabelMissingGroundTruth()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getSchedule()

public abstract 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 abstract 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.

getState()

public abstract 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 abstract 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 abstract 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 abstract 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.