Package com.google.cloud.aiplatform.v1

Class HyperparameterTuningJob

  • All Implemented Interfaces:
    HyperparameterTuningJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class HyperparameterTuningJob
extends com.google.protobuf.GeneratedMessageV3
implements HyperparameterTuningJobOrBuilder
     Represents a HyperparameterTuningJob. A HyperparameterTuningJob
 has a Study specification and multiple CustomJobs with identical
 CustomJob specification.
    Protobuf type google.cloud.aiplatform.v1.HyperparameterTuningJob
    See Also:
    Serialized Form

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. Resource name of the HyperparameterTuningJob.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface HyperparameterTuningJobOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Resource name of the HyperparameterTuningJob.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface HyperparameterTuningJobOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. The display name of the HyperparameterTuningJob.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface HyperparameterTuningJobOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The display name of the HyperparameterTuningJob.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface HyperparameterTuningJobOrBuilder
        Returns:
        The bytes for displayName.

      • hasStudySpec

        public boolean hasStudySpec()
         Required. Study configuration of the HyperparameterTuningJob.
        .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasStudySpec in interface HyperparameterTuningJobOrBuilder
        Returns:
        Whether the studySpec field is set.

      • getStudySpec

        public StudySpec getStudySpec()
         Required. Study configuration of the HyperparameterTuningJob.
        .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStudySpec in interface HyperparameterTuningJobOrBuilder
        Returns:
        The studySpec.

      • getMaxTrialCount

        public int getMaxTrialCount()
         Required. The desired total number of Trials.
        int32 max_trial_count = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMaxTrialCount in interface HyperparameterTuningJobOrBuilder
        Returns:
        The maxTrialCount.

      • getParallelTrialCount

        public int getParallelTrialCount()
         Required. The desired number of Trials to run in parallel.
        int32 parallel_trial_count = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getParallelTrialCount in interface HyperparameterTuningJobOrBuilder
        Returns:
        The parallelTrialCount.

      • getMaxFailedTrialCount

        public int getMaxFailedTrialCount()
         The number of failed Trials that need to be seen before failing
 the HyperparameterTuningJob.

 If set to 0, Vertex AI decides how many Trials must fail
 before the whole job fails.
        int32 max_failed_trial_count = 7;
        Specified by:
        getMaxFailedTrialCount in interface HyperparameterTuningJobOrBuilder
        Returns:
        The maxFailedTrialCount.

      • hasTrialJobSpec

        public boolean hasTrialJobSpec()
         Required. The spec of a trial job. The same spec applies to the CustomJobs
 created in all the trials.
        .google.cloud.aiplatform.v1.CustomJobSpec trial_job_spec = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasTrialJobSpec in interface HyperparameterTuningJobOrBuilder
        Returns:
        Whether the trialJobSpec field is set.

      • getTrialJobSpec

        public CustomJobSpec getTrialJobSpec()
         Required. The spec of a trial job. The same spec applies to the CustomJobs
 created in all the trials.
        .google.cloud.aiplatform.v1.CustomJobSpec trial_job_spec = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTrialJobSpec in interface HyperparameterTuningJobOrBuilder
        Returns:
        The trialJobSpec.

      • getTrialsList

        public List<Trial> getTrialsList()
         Output only. Trials of the HyperparameterTuningJob.
        repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrialsList in interface HyperparameterTuningJobOrBuilder

      • getTrialsCount

        public int getTrialsCount()
         Output only. Trials of the HyperparameterTuningJob.
        repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrialsCount in interface HyperparameterTuningJobOrBuilder

      • getTrials

        public Trial getTrials​(int index)
         Output only. Trials of the HyperparameterTuningJob.
        repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrials in interface HyperparameterTuningJobOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The detailed state of the job.
        .google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface HyperparameterTuningJobOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public JobState getState()
         Output only. The detailed state of the job.
        .google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface HyperparameterTuningJobOrBuilder
        Returns:
        The state.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Time when the HyperparameterTuningJob was created.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface HyperparameterTuningJobOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Time when the HyperparameterTuningJob was created.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface HyperparameterTuningJobOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Time when the HyperparameterTuningJob was created.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface HyperparameterTuningJobOrBuilder

      • hasStartTime

        public boolean hasStartTime()
         Output only. Time when the HyperparameterTuningJob for the first time
 entered the `JOB_STATE_RUNNING` state.
        .google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartTime in interface HyperparameterTuningJobOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. Time when the HyperparameterTuningJob for the first time
 entered the `JOB_STATE_RUNNING` state.
        .google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface HyperparameterTuningJobOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. Time when the HyperparameterTuningJob for the first time
 entered the `JOB_STATE_RUNNING` state.
        .google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface HyperparameterTuningJobOrBuilder

      • hasEndTime

        public boolean hasEndTime()
         Output only. Time when the HyperparameterTuningJob entered any of the
 following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
 `JOB_STATE_CANCELLED`.
        .google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEndTime in interface HyperparameterTuningJobOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         Output only. Time when the HyperparameterTuningJob entered any of the
 following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
 `JOB_STATE_CANCELLED`.
        .google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTime in interface HyperparameterTuningJobOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Output only. Time when the HyperparameterTuningJob entered any of the
 following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
 `JOB_STATE_CANCELLED`.
        .google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTimeOrBuilder in interface HyperparameterTuningJobOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Time when the HyperparameterTuningJob was most recently
 updated.
        .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface HyperparameterTuningJobOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Time when the HyperparameterTuningJob was most recently
 updated.
        .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface HyperparameterTuningJobOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Time when the HyperparameterTuningJob was most recently
 updated.
        .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface HyperparameterTuningJobOrBuilder

      • hasError

        public boolean hasError()
         Output only. Only populated when job's state is JOB_STATE_FAILED or
 JOB_STATE_CANCELLED.
        .google.rpc.Status error = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasError in interface HyperparameterTuningJobOrBuilder
        Returns:
        Whether the error field is set.

      • getError

        public com.google.rpc.Status getError()
         Output only. Only populated when job's state is JOB_STATE_FAILED or
 JOB_STATE_CANCELLED.
        .google.rpc.Status error = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getError in interface HyperparameterTuningJobOrBuilder
        Returns:
        The error.

      • getErrorOrBuilder

        public com.google.rpc.StatusOrBuilder getErrorOrBuilder()
         Output only. Only populated when job's state is JOB_STATE_FAILED or
 JOB_STATE_CANCELLED.
        .google.rpc.Status error = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getErrorOrBuilder in interface HyperparameterTuningJobOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: HyperparameterTuningJobOrBuilder
         The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 16;
        Specified by:
        getLabelsCount in interface HyperparameterTuningJobOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 16;
        Specified by:
        containsLabels in interface HyperparameterTuningJobOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 16;
        Specified by:
        getLabelsMap in interface HyperparameterTuningJobOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 16;
        Specified by:
        getLabelsOrDefault in interface HyperparameterTuningJobOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 16;
        Specified by:
        getLabelsOrThrow in interface HyperparameterTuningJobOrBuilder

      • hasEncryptionSpec

        public boolean hasEncryptionSpec()
         Customer-managed encryption key options for a HyperparameterTuningJob.
 If this is set, then all resources created by the HyperparameterTuningJob
 will be encrypted with the provided encryption key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 17;
        Specified by:
        hasEncryptionSpec in interface HyperparameterTuningJobOrBuilder
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        public EncryptionSpec getEncryptionSpec()
         Customer-managed encryption key options for a HyperparameterTuningJob.
 If this is set, then all resources created by the HyperparameterTuningJob
 will be encrypted with the provided encryption key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 17;
        Specified by:
        getEncryptionSpec in interface HyperparameterTuningJobOrBuilder
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
         Customer-managed encryption key options for a HyperparameterTuningJob.
 If this is set, then all resources created by the HyperparameterTuningJob
 will be encrypted with the provided encryption key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 17;
        Specified by:
        getEncryptionSpecOrBuilder in interface HyperparameterTuningJobOrBuilder

      • 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 HyperparameterTuningJob parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<HyperparameterTuningJob> 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 HyperparameterTuningJob getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder