Package com.google.cloud.datalabeling.v1beta1

Class EvaluationJob

  • All Implemented Interfaces:
    EvaluationJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class EvaluationJob
extends com.google.protobuf.GeneratedMessageV3
implements EvaluationJobOrBuilder
     Defines an evaluation job that runs periodically to generate
 [Evaluations][google.cloud.datalabeling.v1beta1.Evaluation]. [Creating an evaluation
 job](/ml-engine/docs/continuous-evaluation/create-job) is the starting point
 for using continuous evaluation.
    Protobuf type google.cloud.datalabeling.v1beta1.EvaluationJob
    See Also:
    Serialized Form

    • Field Detail

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MODEL_VERSION_FIELD_NUMBER

        public static final int MODEL_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EVALUATION_JOB_CONFIG_FIELD_NUMBER

        public static final int EVALUATION_JOB_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANNOTATION_SPEC_SET_FIELD_NUMBER

        public static final int ANNOTATION_SPEC_SET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LABEL_MISSING_GROUND_TRUTH_FIELD_NUMBER

        public static final int LABEL_MISSING_GROUND_TRUTH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public 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;
        Specified by:
        getName in interface EvaluationJobOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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;
        Specified by:
        getNameBytes in interface EvaluationJobOrBuilder
        Returns:
        The bytes for name.

      • getDescription

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

      • getDescriptionBytes

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

      • getStateValue

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

      • getState

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

      • getSchedule

        public 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;
        Specified by:
        getSchedule in interface EvaluationJobOrBuilder
        Returns:
        The schedule.

      • getScheduleBytes

        public 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;
        Specified by:
        getScheduleBytes in interface EvaluationJobOrBuilder
        Returns:
        The bytes for schedule.

      • getModelVersion

        public 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;
        Specified by:
        getModelVersion in interface EvaluationJobOrBuilder
        Returns:
        The modelVersion.

      • getModelVersionBytes

        public 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;
        Specified by:
        getModelVersionBytes in interface EvaluationJobOrBuilder
        Returns:
        The bytes for modelVersion.

      • hasEvaluationJobConfig

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

      • getEvaluationJobConfig

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

      • getAnnotationSpecSet

        public 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;
        Specified by:
        getAnnotationSpecSet in interface EvaluationJobOrBuilder
        Returns:
        The annotationSpecSet.

      • getAnnotationSpecSetBytes

        public 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;
        Specified by:
        getAnnotationSpecSetBytes in interface EvaluationJobOrBuilder
        Returns:
        The bytes for annotationSpecSet.

      • getLabelMissingGroundTruth

        public 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;
        Specified by:
        getLabelMissingGroundTruth in interface EvaluationJobOrBuilder
        Returns:
        The labelMissingGroundTruth.

      • getAttemptsList

        public 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;
        Specified by:
        getAttemptsList in interface EvaluationJobOrBuilder

      • getAttemptsOrBuilderList

        public 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;
        Specified by:
        getAttemptsOrBuilderList in interface EvaluationJobOrBuilder

      • getAttemptsCount

        public 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;
        Specified by:
        getAttemptsCount in interface EvaluationJobOrBuilder

      • getAttempts

        public 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;
        Specified by:
        getAttempts in interface EvaluationJobOrBuilder

      • getAttemptsOrBuilder

        public 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;
        Specified by:
        getAttemptsOrBuilder in interface EvaluationJobOrBuilder

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp of when this evaluation job was created.
        .google.protobuf.Timestamp create_time = 10;
        Specified by:
        getCreateTimeOrBuilder in interface EvaluationJobOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static EvaluationJob parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EvaluationJob parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EvaluationJob parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EvaluationJob parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EvaluationJob parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EvaluationJob parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EvaluationJob parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public EvaluationJob.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public EvaluationJob.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected EvaluationJob.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static EvaluationJob getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<EvaluationJob> parser()

      • getParserForType

        public com.google.protobuf.Parser<EvaluationJob> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public EvaluationJob getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder