# Interface EvaluationJobOrBuilder (0.213.0)

0.213.0 (latest) 0.211.0 0.208.0 0.207.0 0.205.0 0.203.0 0.202.0 0.201.0 0.200.0 0.198.0 0.196.0 0.195.0 0.194.0 0.193.0 0.192.0 0.190.0 0.188.0 0.187.0 0.184.0 0.183.0 0.182.0 0.180.0 0.179.0 0.178.0 0.177.0 0.176.0 0.175.0 0.174.0 0.173.0 0.172.0 0.171.0 0.169.0 0.168.0 0.167.0 0.166.0 0.165.0 0.164.0 0.163.0 0.162.0 0.161.0 0.160.0 0.159.0 0.157.0 0.156.0 0.155.0 0.154.0 0.153.0 0.152.0 0.151.0 0.150.0 0.149.0 0.148.0 0.147.0 0.144.0 0.143.0 0.142.0 0.141.0 0.140.0 0.139.0 0.138.0 0.137.0 0.136.0 0.135.0 0.134.0 0.133.0 0.132.0 0.131.0 0.129.0 0.128.0 0.127.0 0.126.0 0.125.0 0.124.0 0.123.7 0.122.11

    public interface EvaluationJobOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datalabeling/latest/com.google.cloud.datalabeling.v1beta1.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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-datalabeling/latest/com.google.cloud.datalabeling.v1beta1.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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datalabeling/latest/com.google.cloud.datalabeling.v1beta1.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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datalabeling/latest/com.google.cloud.datalabeling.v1beta1.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datalabeling/latest/com.google.cloud.datalabeling.v1beta1.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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The labelMissingGroundTruth. |

### getModelVersion()

    public abstract String getModelVersion()

Required. The [AI Platform Prediction model
version](https://docs.cloud.google.com/ml-engine/docs/prediction-overview) 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The modelVersion. |

### getModelVersionBytes()

    public abstract ByteString getModelVersionBytes()

Required. The [AI Platform Prediction model
version](https://docs.cloud.google.com/ml-engine/docs/prediction-overview) 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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](https://docs.cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or in an
[English-like
format](https://docs.cloud.google.com/appengine/docs/standard/python/config/cronref#schedule_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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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](https://docs.cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or in an
[English-like
format](https://docs.cloud.google.com/appengine/docs/standard/python/config/cronref#schedule_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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datalabeling/latest/com.google.cloud.datalabeling.v1beta1.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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the evaluationJobConfig field is set. |