/*
* 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.proto
package com.google.cloud.datalabeling.v1beta1;
public interface EvaluationOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.datalabeling.v1beta1.Evaluation)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. Resource name of an evaluation. The name has the following
* format:
* "projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id</var>}'
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. Resource name of an evaluation. The name has the following
* format:
* "projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id</var>}'
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. Options used in the evaluation job that created this
* evaluation.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;
*
* @return Whether the config field is set.
*/
boolean hasConfig();
/**
*
*
*
* Output only. Options used in the evaluation job that created this
* evaluation.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;
*
* @return The config.
*/
com.google.cloud.datalabeling.v1beta1.EvaluationConfig getConfig();
/**
*
*
*
* Output only. Options used in the evaluation job that created this
* evaluation.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;
*/
com.google.cloud.datalabeling.v1beta1.EvaluationConfigOrBuilder getConfigOrBuilder();
/**
*
*
*
* Output only. Timestamp for when the evaluation job that created this
* evaluation ran.
*
*
* .google.protobuf.Timestamp evaluation_job_run_time = 3;
*
* @return Whether the evaluationJobRunTime field is set.
*/
boolean hasEvaluationJobRunTime();
/**
*
*
*
* Output only. Timestamp for when the evaluation job that created this
* evaluation ran.
*
*
* .google.protobuf.Timestamp evaluation_job_run_time = 3;
*
* @return The evaluationJobRunTime.
*/
com.google.protobuf.Timestamp getEvaluationJobRunTime();
/**
*
*
*
* Output only. Timestamp for when the evaluation job that created this
* evaluation ran.
*
*
* .google.protobuf.Timestamp evaluation_job_run_time = 3;
*/
com.google.protobuf.TimestampOrBuilder getEvaluationJobRunTimeOrBuilder();
/**
*
*
*
* Output only. Timestamp for when this evaluation was created.
*
*
* .google.protobuf.Timestamp create_time = 4;
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Timestamp for when this evaluation was created.
*
*
* .google.protobuf.Timestamp create_time = 4;
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Timestamp for when this evaluation was created.
*
*
* .google.protobuf.Timestamp create_time = 4;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Metrics comparing predictions to ground truth labels.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;
*
* @return Whether the evaluationMetrics field is set.
*/
boolean hasEvaluationMetrics();
/**
*
*
*
* Output only. Metrics comparing predictions to ground truth labels.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;
*
* @return The evaluationMetrics.
*/
com.google.cloud.datalabeling.v1beta1.EvaluationMetrics getEvaluationMetrics();
/**
*
*
*
* Output only. Metrics comparing predictions to ground truth labels.
*
*
* .google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;
*/
com.google.cloud.datalabeling.v1beta1.EvaluationMetricsOrBuilder getEvaluationMetricsOrBuilder();
/**
*
*
*
* Output only. Type of task that the model version being evaluated performs,
* as defined in the
* [evaluationJobConfig.inputConfig.annotationType][google.cloud.datalabeling.v1beta1.EvaluationJobConfig.input_config]
* field of the evaluation job that created this evaluation.
*
*
* .google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;
*
* @return The enum numeric value on the wire for annotationType.
*/
int getAnnotationTypeValue();
/**
*
*
*
* Output only. Type of task that the model version being evaluated performs,
* as defined in the
* [evaluationJobConfig.inputConfig.annotationType][google.cloud.datalabeling.v1beta1.EvaluationJobConfig.input_config]
* field of the evaluation job that created this evaluation.
*
*
* .google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;
*
* @return The annotationType.
*/
com.google.cloud.datalabeling.v1beta1.AnnotationType getAnnotationType();
/**
*
*
*
* Output only. The number of items in the ground truth dataset that were used
* for this evaluation. Only populated when the evaulation is for certain
* AnnotationTypes.
*
*
* int64 evaluated_item_count = 7;
*
* @return The evaluatedItemCount.
*/
long getEvaluatedItemCount();
}