Package com.google.cloud.datalabeling.v1beta1

Interface EvaluationJobOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    EvaluationJob, EvaluationJob.Builder
    public interface EvaluationJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        com.google.protobuf.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:
        The bytes for name.

      • getDescription

        String getDescription()
         Required. Description of the job. The description can be up to 25,000
 characters long.
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Required. Description of the job. The description can be up to 25,000
 characters long.
        string description = 2;
        Returns:
        The bytes for description.

      • getStateValue

        int getStateValue()
         Output only. Describes the current state of the job.
        .google.cloud.datalabeling.v1beta1.EvaluationJob.State state = 3;
        Returns:
        The enum numeric value on the wire for state.

      • getState

        EvaluationJob.State getState()
         Output only. Describes the current state of the job.
        .google.cloud.datalabeling.v1beta1.EvaluationJob.State state = 3;
        Returns:
        The state.

      • getSchedule

        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;
        Returns:
        The schedule.

      • getScheduleBytes

        com.google.protobuf.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](/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;
        Returns:
        The bytes for schedule.

      • getModelVersion

        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;
        Returns:
        The modelVersion.

      • getModelVersionBytes

        com.google.protobuf.ByteString getModelVersionBytes()
         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;
        Returns:
        The bytes for modelVersion.

      • hasEvaluationJobConfig

        boolean hasEvaluationJobConfig()
         Required. Configuration details for the evaluation job.
        .google.cloud.datalabeling.v1beta1.EvaluationJobConfig evaluation_job_config = 6;
        Returns:
        Whether the evaluationJobConfig field is set.

      • getEvaluationJobConfig

        EvaluationJobConfig getEvaluationJobConfig()
         Required. Configuration details for the evaluation job.
        .google.cloud.datalabeling.v1beta1.EvaluationJobConfig evaluation_job_config = 6;
        Returns:
        The evaluationJobConfig.

      • getEvaluationJobConfigOrBuilder

        EvaluationJobConfigOrBuilder getEvaluationJobConfigOrBuilder()
         Required. Configuration details for the evaluation job.
        .google.cloud.datalabeling.v1beta1.EvaluationJobConfig evaluation_job_config = 6;

      • getAnnotationSpecSet

        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;
        Returns:
        The annotationSpecSet.

      • getAnnotationSpecSetBytes

        com.google.protobuf.ByteString getAnnotationSpecSetBytes()
         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;
        Returns:
        The bytes for annotationSpecSet.

      • getLabelMissingGroundTruth

        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:
        The labelMissingGroundTruth.

      • getAttemptsList

        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;

      • getAttempts

        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;

      • getAttemptsCount

        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;

      • getAttemptsOrBuilderList

        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;

      • getAttemptsOrBuilder

        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;

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Timestamp of when this evaluation job was created.
        .google.protobuf.Timestamp create_time = 10;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp of when this evaluation job was created.
        .google.protobuf.Timestamp create_time = 10;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp of when this evaluation job was created.
        .google.protobuf.Timestamp create_time = 10;