Class HyperparameterTuningJob.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
com.google.cloud.aiplatform.v1.HyperparameterTuningJob.Builder
All Implemented Interfaces:
HyperparameterTuningJobOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
HyperparameterTuningJob

public static final class HyperparameterTuningJob.Builder extends com.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder> 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
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
    • getDefaultInstanceForType

      public HyperparameterTuningJob getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

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

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

      public HyperparameterTuningJob.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HyperparameterTuningJob.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
    • mergeFrom

      public HyperparameterTuningJob.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HyperparameterTuningJob.Builder>
      Throws:
      IOException
    • 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.
    • setName

      public HyperparameterTuningJob.Builder setName(String value)
       Output only. Resource name of the HyperparameterTuningJob.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.
    • clearName

      public HyperparameterTuningJob.Builder clearName()
       Output only. Resource name of the HyperparameterTuningJob.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • setNameBytes

      public HyperparameterTuningJob.Builder setNameBytes(com.google.protobuf.ByteString value)
       Output only. Resource name of the HyperparameterTuningJob.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.
    • 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.
    • setDisplayName

      public HyperparameterTuningJob.Builder setDisplayName(String value)
       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];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.
    • clearDisplayName

      public HyperparameterTuningJob.Builder clearDisplayName()
       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];
      Returns:
      This builder for chaining.
    • setDisplayNameBytes

      public HyperparameterTuningJob.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.
    • 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.
    • setStudySpec

      public HyperparameterTuningJob.Builder setStudySpec(StudySpec value)
       Required. Study configuration of the HyperparameterTuningJob.
       
      .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
    • setStudySpec

      public HyperparameterTuningJob.Builder setStudySpec(StudySpec.Builder builderForValue)
       Required. Study configuration of the HyperparameterTuningJob.
       
      .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
    • mergeStudySpec

      public HyperparameterTuningJob.Builder mergeStudySpec(StudySpec value)
       Required. Study configuration of the HyperparameterTuningJob.
       
      .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
    • clearStudySpec

      public HyperparameterTuningJob.Builder clearStudySpec()
       Required. Study configuration of the HyperparameterTuningJob.
       
      .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
    • getStudySpecBuilder

      public StudySpec.Builder getStudySpecBuilder()
       Required. Study configuration of the HyperparameterTuningJob.
       
      .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
    • getStudySpecOrBuilder

      public StudySpecOrBuilder getStudySpecOrBuilder()
       Required. Study configuration of the HyperparameterTuningJob.
       
      .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getStudySpecOrBuilder in interface HyperparameterTuningJobOrBuilder
    • 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.
    • setMaxTrialCount

      public HyperparameterTuningJob.Builder setMaxTrialCount(int value)
       Required. The desired total number of Trials.
       
      int32 max_trial_count = 5 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The maxTrialCount to set.
      Returns:
      This builder for chaining.
    • clearMaxTrialCount

      public HyperparameterTuningJob.Builder clearMaxTrialCount()
       Required. The desired total number of Trials.
       
      int32 max_trial_count = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • 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.
    • setParallelTrialCount

      public HyperparameterTuningJob.Builder setParallelTrialCount(int value)
       Required. The desired number of Trials to run in parallel.
       
      int32 parallel_trial_count = 6 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The parallelTrialCount to set.
      Returns:
      This builder for chaining.
    • clearParallelTrialCount

      public HyperparameterTuningJob.Builder clearParallelTrialCount()
       Required. The desired number of Trials to run in parallel.
       
      int32 parallel_trial_count = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • 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.
    • setMaxFailedTrialCount

      public HyperparameterTuningJob.Builder setMaxFailedTrialCount(int value)
       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;
      Parameters:
      value - The maxFailedTrialCount to set.
      Returns:
      This builder for chaining.
    • clearMaxFailedTrialCount

      public HyperparameterTuningJob.Builder clearMaxFailedTrialCount()
       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;
      Returns:
      This builder for chaining.
    • 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.
    • setTrialJobSpec

      public HyperparameterTuningJob.Builder setTrialJobSpec(CustomJobSpec value)
       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];
    • setTrialJobSpec

      public HyperparameterTuningJob.Builder setTrialJobSpec(CustomJobSpec.Builder builderForValue)
       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];
    • mergeTrialJobSpec

      public HyperparameterTuningJob.Builder mergeTrialJobSpec(CustomJobSpec value)
       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];
    • clearTrialJobSpec

      public HyperparameterTuningJob.Builder clearTrialJobSpec()
       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];
    • getTrialJobSpecBuilder

      public CustomJobSpec.Builder getTrialJobSpecBuilder()
       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];
    • getTrialJobSpecOrBuilder

      public CustomJobSpecOrBuilder getTrialJobSpecOrBuilder()
       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:
      getTrialJobSpecOrBuilder in interface HyperparameterTuningJobOrBuilder
    • 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
    • setTrials

      public HyperparameterTuningJob.Builder setTrials(int index, Trial value)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • setTrials

      public HyperparameterTuningJob.Builder setTrials(int index, Trial.Builder builderForValue)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • addTrials

      public HyperparameterTuningJob.Builder addTrials(Trial value)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • addTrials

      public HyperparameterTuningJob.Builder addTrials(int index, Trial value)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • addTrials

      public HyperparameterTuningJob.Builder addTrials(Trial.Builder builderForValue)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • addTrials

      public HyperparameterTuningJob.Builder addTrials(int index, Trial.Builder builderForValue)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • addAllTrials

      public HyperparameterTuningJob.Builder addAllTrials(Iterable<? extends Trial> values)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • clearTrials

      public HyperparameterTuningJob.Builder clearTrials()
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • removeTrials

      public HyperparameterTuningJob.Builder removeTrials(int index)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getTrialsBuilder

      public Trial.Builder getTrialsBuilder(int index)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getTrialsOrBuilder

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

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

      public Trial.Builder addTrialsBuilder()
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • addTrialsBuilder

      public Trial.Builder addTrialsBuilder(int index)
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getTrialsBuilderList

      public List<Trial.Builder> getTrialsBuilderList()
       Output only. Trials of the HyperparameterTuningJob.
       
      repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • 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.
    • setStateValue

      public HyperparameterTuningJob.Builder setStateValue(int value)
       Output only. The detailed state of the job.
       
      .google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.
    • 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.
    • setState

      public HyperparameterTuningJob.Builder setState(JobState value)
       Output only. The detailed state of the job.
       
      .google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.
    • clearState

      public HyperparameterTuningJob.Builder clearState()
       Output only. The detailed state of the job.
       
      .google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • 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.
    • setCreateTime

      public HyperparameterTuningJob.Builder setCreateTime(com.google.protobuf.Timestamp value)
       Output only. Time when the HyperparameterTuningJob was created.
       
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • setCreateTime

      public HyperparameterTuningJob.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Time when the HyperparameterTuningJob was created.
       
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • mergeCreateTime

      public HyperparameterTuningJob.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. Time when the HyperparameterTuningJob was created.
       
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • clearCreateTime

      public HyperparameterTuningJob.Builder clearCreateTime()
       Output only. Time when the HyperparameterTuningJob was created.
       
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
       Output only. Time when the HyperparameterTuningJob was created.
       
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • 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.
    • setStartTime

      public HyperparameterTuningJob.Builder setStartTime(com.google.protobuf.Timestamp value)
       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];
    • setStartTime

      public HyperparameterTuningJob.Builder setStartTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];
    • mergeStartTime

      public HyperparameterTuningJob.Builder mergeStartTime(com.google.protobuf.Timestamp value)
       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];
    • clearStartTime

      public HyperparameterTuningJob.Builder clearStartTime()
       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];
    • getStartTimeBuilder

      public com.google.protobuf.Timestamp.Builder getStartTimeBuilder()
       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];
    • 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.
    • setEndTime

      public HyperparameterTuningJob.Builder setEndTime(com.google.protobuf.Timestamp value)
       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];
    • setEndTime

      public HyperparameterTuningJob.Builder setEndTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];
    • mergeEndTime

      public HyperparameterTuningJob.Builder mergeEndTime(com.google.protobuf.Timestamp value)
       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];
    • clearEndTime

      public HyperparameterTuningJob.Builder clearEndTime()
       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];
    • getEndTimeBuilder

      public com.google.protobuf.Timestamp.Builder getEndTimeBuilder()
       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];
    • 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.
    • setUpdateTime

      public HyperparameterTuningJob.Builder setUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Time when the HyperparameterTuningJob was most recently
       updated.
       
      .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • setUpdateTime

      public HyperparameterTuningJob.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Time when the HyperparameterTuningJob was most recently
       updated.
       
      .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • mergeUpdateTime

      public HyperparameterTuningJob.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Time when the HyperparameterTuningJob was most recently
       updated.
       
      .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • clearUpdateTime

      public HyperparameterTuningJob.Builder clearUpdateTime()
       Output only. Time when the HyperparameterTuningJob was most recently
       updated.
       
      .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getUpdateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
       Output only. Time when the HyperparameterTuningJob was most recently
       updated.
       
      .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • 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 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.
    • setError

      public HyperparameterTuningJob.Builder setError(Status value)
       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];
    • setError

      public HyperparameterTuningJob.Builder setError(Status.Builder builderForValue)
       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];
    • mergeError

      public HyperparameterTuningJob.Builder mergeError(Status value)
       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];
    • clearError

      public HyperparameterTuningJob.Builder clearError()
       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];
    • getErrorBuilder

      public Status.Builder getErrorBuilder()
       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];
    • getErrorOrBuilder

      public 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
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels 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
    • clearLabels

      public HyperparameterTuningJob.Builder clearLabels()
    • removeLabels

      public HyperparameterTuningJob.Builder removeLabels(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;
    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.
    • putLabels

      public HyperparameterTuningJob.Builder putLabels(String key, String value)
       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;
    • putAllLabels

      public HyperparameterTuningJob.Builder putAllLabels(Map<String,String> values)
       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;
    • 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.
    • setEncryptionSpec

      public HyperparameterTuningJob.Builder setEncryptionSpec(EncryptionSpec value)
       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;
    • setEncryptionSpec

      public HyperparameterTuningJob.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)
       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;
    • mergeEncryptionSpec

      public HyperparameterTuningJob.Builder mergeEncryptionSpec(EncryptionSpec value)
       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;
    • clearEncryptionSpec

      public HyperparameterTuningJob.Builder clearEncryptionSpec()
       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;
    • getEncryptionSpecBuilder

      public EncryptionSpec.Builder getEncryptionSpecBuilder()
       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;
    • 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
    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. Reserved for future use.
       
      bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface HyperparameterTuningJobOrBuilder
      Returns:
      The satisfiesPzs.
    • setSatisfiesPzs

      public HyperparameterTuningJob.Builder setSatisfiesPzs(boolean value)
       Output only. Reserved for future use.
       
      bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The satisfiesPzs to set.
      Returns:
      This builder for chaining.
    • clearSatisfiesPzs

      public HyperparameterTuningJob.Builder clearSatisfiesPzs()
       Output only. Reserved for future use.
       
      bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. Reserved for future use.
       
      bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface HyperparameterTuningJobOrBuilder
      Returns:
      The satisfiesPzi.
    • setSatisfiesPzi

      public HyperparameterTuningJob.Builder setSatisfiesPzi(boolean value)
       Output only. Reserved for future use.
       
      bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The satisfiesPzi to set.
      Returns:
      This builder for chaining.
    • clearSatisfiesPzi

      public HyperparameterTuningJob.Builder clearSatisfiesPzi()
       Output only. Reserved for future use.
       
      bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.