Package com.google.cloud.aiplatform.v1
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 Summary
Modifier and TypeMethodDescriptionaddAllTrials(Iterable<? extends Trial> values) Output only.Output only.addTrials(int index, Trial.Builder builderForValue) Output only.Output only.addTrials(Trial.Builder builderForValue) Output only.Output only.addTrialsBuilder(int index) Output only.build()clear()Output only.Required.Customer-managed encryption key options for a HyperparameterTuningJob.Output only.Output only.The number of failed Trials that need to be seen before failing the HyperparameterTuningJob.Required.Output only.Required.Output only.Output only.Output only.Output only.Required.Required.Output only.Output only.booleancontainsLabels(String key) The labels with user-defined metadata to organize HyperparameterTuningJobs.com.google.protobuf.TimestampOutput only.com.google.protobuf.Timestamp.BuilderOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorRequired.com.google.protobuf.ByteStringRequired.Customer-managed encryption key options for a HyperparameterTuningJob.Customer-managed encryption key options for a HyperparameterTuningJob.Customer-managed encryption key options for a HyperparameterTuningJob.com.google.protobuf.TimestampOutput only.com.google.protobuf.Timestamp.BuilderOutput only.com.google.protobuf.TimestampOrBuilderOutput only.getError()Output only.Output only.Output only.Deprecated.intThe labels with user-defined metadata to organize HyperparameterTuningJobs.The labels with user-defined metadata to organize HyperparameterTuningJobs.getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize HyperparameterTuningJobs.getLabelsOrThrow(String key) The labels with user-defined metadata to organize HyperparameterTuningJobs.intThe number of failed Trials that need to be seen before failing the HyperparameterTuningJob.intRequired.Deprecated.getName()Output only.com.google.protobuf.ByteStringOutput only.intRequired.booleanOutput only.booleanOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.Timestamp.BuilderOutput only.com.google.protobuf.TimestampOrBuilderOutput only.getState()Output only.intOutput only.Required.Required.Required.Required.Required.Required.getTrials(int index) Output only.getTrialsBuilder(int index) Output only.Output only.intOutput only.Output only.getTrialsOrBuilder(int index) Output only.List<? extends TrialOrBuilder>Output only.com.google.protobuf.TimestampOutput only.com.google.protobuf.Timestamp.BuilderOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOutput only.booleanCustomer-managed encryption key options for a HyperparameterTuningJob.booleanOutput only.booleanhasError()Output only.booleanOutput only.booleanRequired.booleanRequired.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) protected com.google.protobuf.MapFieldReflectionAccessorinternalGetMutableMapFieldReflection(int number) final booleanmergeCreateTime(com.google.protobuf.Timestamp value) Output only.Customer-managed encryption key options for a HyperparameterTuningJob.mergeEndTime(com.google.protobuf.Timestamp value) Output only.mergeError(Status value) Output only.mergeFrom(HyperparameterTuningJob other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeStartTime(com.google.protobuf.Timestamp value) Output only.mergeStudySpec(StudySpec value) Required.mergeTrialJobSpec(CustomJobSpec value) Required.mergeUpdateTime(com.google.protobuf.Timestamp value) Output only.putAllLabels(Map<String, String> values) The labels with user-defined metadata to organize HyperparameterTuningJobs.The labels with user-defined metadata to organize HyperparameterTuningJobs.removeLabels(String key) The labels with user-defined metadata to organize HyperparameterTuningJobs.removeTrials(int index) Output only.setCreateTime(com.google.protobuf.Timestamp value) Output only.setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.setDisplayName(String value) Required.setDisplayNameBytes(com.google.protobuf.ByteString value) Required.setEncryptionSpec(EncryptionSpec value) Customer-managed encryption key options for a HyperparameterTuningJob.setEncryptionSpec(EncryptionSpec.Builder builderForValue) Customer-managed encryption key options for a HyperparameterTuningJob.setEndTime(com.google.protobuf.Timestamp value) Output only.setEndTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.Output only.setError(Status.Builder builderForValue) Output only.setMaxFailedTrialCount(int value) The number of failed Trials that need to be seen before failing the HyperparameterTuningJob.setMaxTrialCount(int value) Required.Output only.setNameBytes(com.google.protobuf.ByteString value) Output only.setParallelTrialCount(int value) Required.setSatisfiesPzi(boolean value) Output only.setSatisfiesPzs(boolean value) Output only.setStartTime(com.google.protobuf.Timestamp value) Output only.setStartTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.Output only.setStateValue(int value) Output only.setStudySpec(StudySpec value) Required.setStudySpec(StudySpec.Builder builderForValue) Required.setTrialJobSpec(CustomJobSpec value) Required.setTrialJobSpec(CustomJobSpec.Builder builderForValue) Required.Output only.setTrials(int index, Trial.Builder builderForValue) Output only.setUpdateTime(com.google.protobuf.Timestamp value) Output only.setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
-
internalGetMutableMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number) - Overrides:
internalGetMutableMapFieldReflectionin classcom.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<HyperparameterTuningJob.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<HyperparameterTuningJob.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<HyperparameterTuningJob.Builder>- Throws:
IOException
-
getName
Output only. Resource name of the HyperparameterTuningJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNamein interfaceHyperparameterTuningJobOrBuilder- 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:
getNameBytesin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The bytes for name.
-
setName
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
Output only. Resource name of the HyperparameterTuningJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
setNameBytes
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
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:
getDisplayNamein interfaceHyperparameterTuningJobOrBuilder- 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:
getDisplayNameBytesin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The bytes for displayName.
-
setDisplayName
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
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
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:
hasStudySpecin interfaceHyperparameterTuningJobOrBuilder- Returns:
- Whether the studySpec field is set.
-
getStudySpec
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getStudySpecin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The studySpec.
-
setStudySpec
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED]; -
setStudySpec
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED]; -
mergeStudySpec
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED]; -
clearStudySpec
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED]; -
getStudySpecBuilder
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED]; -
getStudySpecOrBuilder
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getStudySpecOrBuilderin interfaceHyperparameterTuningJobOrBuilder
-
getMaxTrialCount
public int getMaxTrialCount()Required. The desired total number of Trials.
int32 max_trial_count = 5 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getMaxTrialCountin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The maxTrialCount.
-
setMaxTrialCount
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
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:
getParallelTrialCountin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The parallelTrialCount.
-
setParallelTrialCount
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
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:
getMaxFailedTrialCountin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The maxFailedTrialCount.
-
setMaxFailedTrialCount
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
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:
hasTrialJobSpecin interfaceHyperparameterTuningJobOrBuilder- Returns:
- Whether the trialJobSpec field is set.
-
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:
getTrialJobSpecin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The trialJobSpec.
-
setTrialJobSpec
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
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
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
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
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
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:
getTrialJobSpecOrBuilderin interfaceHyperparameterTuningJobOrBuilder
-
getTrialsList
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTrialsListin interfaceHyperparameterTuningJobOrBuilder
-
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:
getTrialsCountin interfaceHyperparameterTuningJobOrBuilder
-
getTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTrialsin interfaceHyperparameterTuningJobOrBuilder
-
setTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
setTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
addTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
addTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
addTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
addTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
addAllTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
clearTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
removeTrials
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getTrialsBuilder
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getTrialsOrBuilder
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTrialsOrBuilderin interfaceHyperparameterTuningJobOrBuilder
-
getTrialsOrBuilderList
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTrialsOrBuilderListin interfaceHyperparameterTuningJobOrBuilder
-
addTrialsBuilder
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
addTrialsBuilder
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
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:
getStateValuein interfaceHyperparameterTuningJobOrBuilder- Returns:
- The enum numeric value on the wire for state.
-
setStateValue
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
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein interfaceHyperparameterTuningJobOrBuilder- Returns:
- The state.
-
setState
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
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:
hasCreateTimein interfaceHyperparameterTuningJobOrBuilder- 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:
getCreateTimein interfaceHyperparameterTuningJobOrBuilder- Returns:
- The createTime.
-
setCreateTime
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
Output only. Time when the HyperparameterTuningJob was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
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:
getCreateTimeOrBuilderin interfaceHyperparameterTuningJobOrBuilder
-
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:
hasStartTimein interfaceHyperparameterTuningJobOrBuilder- 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:
getStartTimein interfaceHyperparameterTuningJobOrBuilder- Returns:
- The startTime.
-
setStartTime
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
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
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:
getStartTimeOrBuilderin interfaceHyperparameterTuningJobOrBuilder
-
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:
hasEndTimein interfaceHyperparameterTuningJobOrBuilder- 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:
getEndTimein interfaceHyperparameterTuningJobOrBuilder- Returns:
- The endTime.
-
setEndTime
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
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
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:
getEndTimeOrBuilderin interfaceHyperparameterTuningJobOrBuilder
-
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:
hasUpdateTimein interfaceHyperparameterTuningJobOrBuilder- 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:
getUpdateTimein interfaceHyperparameterTuningJobOrBuilder- Returns:
- The updateTime.
-
setUpdateTime
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
Output only. Time when the HyperparameterTuningJob was most recently updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
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:
getUpdateTimeOrBuilderin interfaceHyperparameterTuningJobOrBuilder
-
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:
hasErrorin interfaceHyperparameterTuningJobOrBuilder- Returns:
- Whether the error field is set.
-
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:
getErrorin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The error.
-
setError
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
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
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
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
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
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:
getErrorOrBuilderin interfaceHyperparameterTuningJobOrBuilder
-
getLabelsCount
public int getLabelsCount()Description copied from interface:HyperparameterTuningJobOrBuilderThe 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:
getLabelsCountin interfaceHyperparameterTuningJobOrBuilder
-
containsLabels
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:
containsLabelsin interfaceHyperparameterTuningJobOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceHyperparameterTuningJobOrBuilder
-
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:
getLabelsMapin interfaceHyperparameterTuningJobOrBuilder
-
getLabelsOrDefault
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:
getLabelsOrDefaultin interfaceHyperparameterTuningJobOrBuilder
-
getLabelsOrThrow
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:
getLabelsOrThrowin interfaceHyperparameterTuningJobOrBuilder
-
clearLabels
-
removeLabels
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.Use alternate mutation accessors instead. -
putLabels
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
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:
hasEncryptionSpecin interfaceHyperparameterTuningJobOrBuilder- Returns:
- Whether the encryptionSpec field is set.
-
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:
getEncryptionSpecin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The encryptionSpec.
-
setEncryptionSpec
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
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
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
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
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
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:
getEncryptionSpecOrBuilderin interfaceHyperparameterTuningJobOrBuilder
-
getSatisfiesPzs
public boolean getSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSatisfiesPzsin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The satisfiesPzs.
-
setSatisfiesPzs
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
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:
getSatisfiesPziin interfaceHyperparameterTuningJobOrBuilder- Returns:
- The satisfiesPzi.
-
setSatisfiesPzi
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
Output only. Reserved for future use.
bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-