Class HyperparameterTuningJob.Builder (3.43.0) 

public static final class HyperparameterTuningJob.Builder extends GeneratedMessageV3.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HyperparameterTuningJob.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllTrials(Iterable<? extends Trial> values)

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];

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1.Trial>
Returns
Type Description
HyperparameterTuningJob.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HyperparameterTuningJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

addTrials(Trial value)

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];

Parameter
Name Description
value Trial
Returns
Type Description
HyperparameterTuningJob.Builder

addTrials(Trial.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Trial.Builder
Returns
Type Description
HyperparameterTuningJob.Builder

addTrials(int index, Trial value)

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];

Parameters
Name Description
index int
value Trial
Returns
Type Description
HyperparameterTuningJob.Builder

addTrials(int index, Trial.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Trial.Builder
Returns
Type Description
HyperparameterTuningJob.Builder

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];

Returns
Type Description
Trial.Builder

addTrialsBuilder(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
Trial.Builder

build()

public HyperparameterTuningJob build()
Returns
Type Description
HyperparameterTuningJob

buildPartial()

public HyperparameterTuningJob buildPartial()
Returns
Type Description
HyperparameterTuningJob

clear()

public HyperparameterTuningJob.Builder clear()
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

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];

Returns
Type Description
HyperparameterTuningJob.Builder

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
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

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;

Returns
Type Description
HyperparameterTuningJob.Builder

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];

Returns
Type Description
HyperparameterTuningJob.Builder

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];

Returns
Type Description
HyperparameterTuningJob.Builder

clearField(Descriptors.FieldDescriptor field)

public HyperparameterTuningJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

clearLabels()

public HyperparameterTuningJob.Builder clearLabels()
Returns
Type Description
HyperparameterTuningJob.Builder

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
Type Description
HyperparameterTuningJob.Builder

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
Type Description
HyperparameterTuningJob.Builder

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
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public HyperparameterTuningJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

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
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

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];

Returns
Type Description
HyperparameterTuningJob.Builder

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
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

clearStudySpec()

public HyperparameterTuningJob.Builder clearStudySpec()

Required. Study configuration of the HyperparameterTuningJob.

.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
HyperparameterTuningJob.Builder

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];

Returns
Type Description
HyperparameterTuningJob.Builder

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];

Returns
Type Description
HyperparameterTuningJob.Builder

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];

Returns
Type Description
HyperparameterTuningJob.Builder

clone()

public HyperparameterTuningJob.Builder clone()
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

containsLabels(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when the HyperparameterTuningJob was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time when the HyperparameterTuningJob was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when the HyperparameterTuningJob was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public HyperparameterTuningJob getDefaultInstanceForType()
Returns
Type Description
HyperparameterTuningJob

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public 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];

Returns
Type Description
ByteString

The bytes for displayName.

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;

Returns
Type Description
EncryptionSpec

The encryptionSpec.

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;

Returns
Type Description
EncryptionSpec.Builder

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;

Returns
Type Description
EncryptionSpecOrBuilder

getEndTime()

public 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];

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public 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];

Returns
Type Description
Builder

getEndTimeOrBuilder()

public 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];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
com.google.rpc.Status

The error.

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];

Returns
Type Description
com.google.rpc.Status.Builder

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];

Returns
Type Description
com.google.rpc.StatusOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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;

Returns
Type Description
int

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;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
String

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;

Returns
Type Description
int

The maxFailedTrialCount.

getMaxTrialCount()

public int getMaxTrialCount()

Required. The desired total number of Trials.

int32 max_trial_count = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The maxTrialCount.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Output only. Resource name of the HyperparameterTuningJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the HyperparameterTuningJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParallelTrialCount()

public int getParallelTrialCount()

Required. The desired number of Trials to run in parallel.

int32 parallel_trial_count = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The parallelTrialCount.

getStartTime()

public 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];

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public 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];

Returns
Type Description
Builder

getStartTimeOrBuilder()

public 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];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
JobState

The state.

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];

Returns
Type Description
int

The enum numeric value on the wire for state.

getStudySpec()

public StudySpec getStudySpec()

Required. Study configuration of the HyperparameterTuningJob.

.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StudySpec

The studySpec.

getStudySpecBuilder()

public StudySpec.Builder getStudySpecBuilder()

Required. Study configuration of the HyperparameterTuningJob.

.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StudySpec.Builder

getStudySpecOrBuilder()

public StudySpecOrBuilder getStudySpecOrBuilder()

Required. Study configuration of the HyperparameterTuningJob.

.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StudySpecOrBuilder

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];

Returns
Type Description
CustomJobSpec

The trialJobSpec.

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];

Returns
Type Description
CustomJobSpec.Builder

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];

Returns
Type Description
CustomJobSpecOrBuilder

getTrials(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
Trial

getTrialsBuilder(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
Trial.Builder

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];

Returns
Type Description
List<Builder>

getTrialsCount()

public int getTrialsCount()

Output only. Trials of the HyperparameterTuningJob.

repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

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];

Returns
Type Description
List<Trial>

getTrialsOrBuilder(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
TrialOrBuilder

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];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.TrialOrBuilder>

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when the HyperparameterTuningJob was most recently updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public 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];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when the HyperparameterTuningJob was most recently updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when the HyperparameterTuningJob was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

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;

Returns
Type Description
boolean

Whether the encryptionSpec field is set.

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];

Returns
Type Description
boolean

Whether the endTime field is set.

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];

Returns
Type Description
boolean

Whether the error field is set.

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];

Returns
Type Description
boolean

Whether the startTime field is set.

hasStudySpec()

public boolean hasStudySpec()

Required. Study configuration of the HyperparameterTuningJob.

.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the studySpec field is set.

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];

Returns
Type Description
boolean

Whether the trialJobSpec field is set.

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];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public HyperparameterTuningJob.Builder mergeCreateTime(Timestamp value)

Output only. Time when the HyperparameterTuningJob was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
HyperparameterTuningJob.Builder

mergeEncryptionSpec(EncryptionSpec value)

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;

Parameter
Name Description
value EncryptionSpec
Returns
Type Description
HyperparameterTuningJob.Builder

mergeEndTime(Timestamp value)

public HyperparameterTuningJob.Builder mergeEndTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
HyperparameterTuningJob.Builder

mergeError(Status value)

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];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
HyperparameterTuningJob.Builder

mergeFrom(HyperparameterTuningJob other)

public HyperparameterTuningJob.Builder mergeFrom(HyperparameterTuningJob other)
Parameter
Name Description
other HyperparameterTuningJob
Returns
Type Description
HyperparameterTuningJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HyperparameterTuningJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HyperparameterTuningJob.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

mergeStartTime(Timestamp value)

public HyperparameterTuningJob.Builder mergeStartTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
HyperparameterTuningJob.Builder

mergeStudySpec(StudySpec value)

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];

Parameter
Name Description
value StudySpec
Returns
Type Description
HyperparameterTuningJob.Builder

mergeTrialJobSpec(CustomJobSpec value)

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];

Parameter
Name Description
value CustomJobSpec
Returns
Type Description
HyperparameterTuningJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HyperparameterTuningJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

mergeUpdateTime(Timestamp value)

public HyperparameterTuningJob.Builder mergeUpdateTime(Timestamp value)

Output only. Time when the HyperparameterTuningJob was most recently updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
HyperparameterTuningJob.Builder

putAllLabels(Map<String,String> values)

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;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
HyperparameterTuningJob.Builder

putLabels(String key, String value)

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;

Parameters
Name Description
key String
value String
Returns
Type Description
HyperparameterTuningJob.Builder

removeLabels(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
HyperparameterTuningJob.Builder

removeTrials(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
HyperparameterTuningJob.Builder

setCreateTime(Timestamp value)

public HyperparameterTuningJob.Builder setCreateTime(Timestamp value)

Output only. Time when the HyperparameterTuningJob was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
HyperparameterTuningJob.Builder

setCreateTime(Timestamp.Builder builderForValue)

public HyperparameterTuningJob.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when the HyperparameterTuningJob was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
HyperparameterTuningJob.Builder

setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public HyperparameterTuningJob.Builder setDisplayNameBytes(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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

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;

Parameter
Name Description
value EncryptionSpec
Returns
Type Description
HyperparameterTuningJob.Builder

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

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;

Parameter
Name Description
builderForValue EncryptionSpec.Builder
Returns
Type Description
HyperparameterTuningJob.Builder

setEndTime(Timestamp value)

public HyperparameterTuningJob.Builder setEndTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
HyperparameterTuningJob.Builder

setEndTime(Timestamp.Builder builderForValue)

public HyperparameterTuningJob.Builder setEndTime(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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
HyperparameterTuningJob.Builder

setError(Status value)

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];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
HyperparameterTuningJob.Builder

setError(Status.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
HyperparameterTuningJob.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public HyperparameterTuningJob.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

setMaxFailedTrialCount(int value)

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;

Parameter
Name Description
value int

The maxFailedTrialCount to set.
Returns
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

setMaxTrialCount(int value)

public HyperparameterTuningJob.Builder setMaxTrialCount(int value)

Required. The desired total number of Trials.

int32 max_trial_count = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The maxTrialCount to set.
Returns
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

setName(String value)

public HyperparameterTuningJob.Builder setName(String value)

Output only. Resource name of the HyperparameterTuningJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

setNameBytes(ByteString value)

public HyperparameterTuningJob.Builder setNameBytes(ByteString value)

Output only. Resource name of the HyperparameterTuningJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

setParallelTrialCount(int value)

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];

Parameter
Name Description
value int

The parallelTrialCount to set.
Returns
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HyperparameterTuningJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

setStartTime(Timestamp value)

public HyperparameterTuningJob.Builder setStartTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
HyperparameterTuningJob.Builder

setStartTime(Timestamp.Builder builderForValue)

public HyperparameterTuningJob.Builder setStartTime(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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
HyperparameterTuningJob.Builder

setState(JobState value)

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];

Parameter
Name Description
value JobState

The state to set.
Returns
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

setStateValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
HyperparameterTuningJob.Builder

This builder for chaining.

setStudySpec(StudySpec value)

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];

Parameter
Name Description
value StudySpec
Returns
Type Description
HyperparameterTuningJob.Builder

setStudySpec(StudySpec.Builder builderForValue)

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];

Parameter
Name Description
builderForValue StudySpec.Builder
Returns
Type Description
HyperparameterTuningJob.Builder

setTrialJobSpec(CustomJobSpec value)

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];

Parameter
Name Description
value CustomJobSpec
Returns
Type Description
HyperparameterTuningJob.Builder

setTrialJobSpec(CustomJobSpec.Builder builderForValue)

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];

Parameter
Name Description
builderForValue CustomJobSpec.Builder
Returns
Type Description
HyperparameterTuningJob.Builder

setTrials(int index, Trial value)

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];

Parameters
Name Description
index int
value Trial
Returns
Type Description
HyperparameterTuningJob.Builder

setTrials(int index, Trial.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Trial.Builder
Returns
Type Description
HyperparameterTuningJob.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final HyperparameterTuningJob.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HyperparameterTuningJob.Builder
Overrides

setUpdateTime(Timestamp value)

public HyperparameterTuningJob.Builder setUpdateTime(Timestamp value)

Output only. Time when the HyperparameterTuningJob was most recently updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
HyperparameterTuningJob.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public HyperparameterTuningJob.Builder setUpdateTime(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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
HyperparameterTuningJob.Builder