/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/datalabeling/v1beta1/evaluation_job.proto
package com.google.cloud.datalabeling.v1beta1;
public interface EvaluationJobOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.datalabeling.v1beta1.EvaluationJob)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The name.
*/
java.lang.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;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. Description of the job. The description can be up to 25,000
* characters long.
*
*
* string description = 2;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Required. Description of the job. The description can be up to 25,000
* characters long.
*
*
* string description = 2;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Output only. Describes the current state of the job.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationJob.State state = 3;
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. Describes the current state of the job.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationJob.State state = 3;
*
* @return The state.
*/
com.google.cloud.datalabeling.v1beta1.EvaluationJob.State getState();
/**
*
*
*
* 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](/scheduler/docs/configuring/cron-job-schedules) or in an
* [English-like
* format](/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;
*
* @return The schedule.
*/
java.lang.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](/scheduler/docs/configuring/cron-job-schedules) or in an
* [English-like
* format](/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;
*
* @return The bytes for schedule.
*/
com.google.protobuf.ByteString getScheduleBytes();
/**
*
*
*
* Required. The [AI Platform Prediction model
* version](/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;
*
* @return The modelVersion.
*/
java.lang.String getModelVersion();
/**
*
*
*
* Required. The [AI Platform Prediction model
* version](/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;
*
* @return The bytes for modelVersion.
*/
com.google.protobuf.ByteString getModelVersionBytes();
/**
*
*
*
* Required. Configuration details for the evaluation job.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationJobConfig evaluation_job_config = 6;
*
* @return Whether the evaluationJobConfig field is set.
*/
boolean hasEvaluationJobConfig();
/**
*
*
*
* Required. Configuration details for the evaluation job.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationJobConfig evaluation_job_config = 6;
*
* @return The evaluationJobConfig.
*/
com.google.cloud.datalabeling.v1beta1.EvaluationJobConfig getEvaluationJobConfig();
/**
*
*
*
* Required. Configuration details for the evaluation job.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationJobConfig evaluation_job_config = 6;
*/
com.google.cloud.datalabeling.v1beta1.EvaluationJobConfigOrBuilder
getEvaluationJobConfigOrBuilder();
/**
*
*
*
* Required. Name of the [AnnotationSpecSet][google.cloud.datalabeling.v1beta1.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;
*
* @return The annotationSpecSet.
*/
java.lang.String getAnnotationSpecSet();
/**
*
*
*
* Required. Name of the [AnnotationSpecSet][google.cloud.datalabeling.v1beta1.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;
*
* @return The bytes for annotationSpecSet.
*/
com.google.protobuf.ByteString getAnnotationSpecSetBytes();
/**
*
*
*
* 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;
*
* @return The labelMissingGroundTruth.
*/
boolean getLabelMissingGroundTruth();
/**
*
*
*
* 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;
*/
java.util.List 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;
*/
com.google.cloud.datalabeling.v1beta1.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;
*/
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;
*/
java.util.List
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;
*/
com.google.cloud.datalabeling.v1beta1.AttemptOrBuilder getAttemptsOrBuilder(int index);
/**
*
*
*
* Output only. Timestamp of when this evaluation job was created.
*
*
* .google.protobuf.Timestamp create_time = 10;
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Timestamp of when this evaluation job was created.
*
*
* .google.protobuf.Timestamp create_time = 10;
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Timestamp of when this evaluation job was created.
*
*
* .google.protobuf.Timestamp create_time = 10;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
}