public final class HyperparameterTuningJob extends GeneratedMessageV3 implements HyperparameterTuningJobOrBuilder
Represents a HyperparameterTuningJob. A HyperparameterTuningJob
has a Study specification and multiple CustomJobs with identical
CustomJob specification.
Protobuf type google.cloud.aiplatform.v1.HyperparameterTuningJob
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Field Value
public static final int END_TIME_FIELD_NUMBER
Field Value
public static final int ERROR_FIELD_NUMBER
Field Value
public static final int LABELS_FIELD_NUMBER
Field Value
public static final int MAX_FAILED_TRIAL_COUNT_FIELD_NUMBER
Field Value
public static final int MAX_TRIAL_COUNT_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int PARALLEL_TRIAL_COUNT_FIELD_NUMBER
Field Value
public static final int START_TIME_FIELD_NUMBER
Field Value
public static final int STATE_FIELD_NUMBER
Field Value
public static final int STUDY_SPEC_FIELD_NUMBER
Field Value
public static final int TRIALS_FIELD_NUMBER
Field Value
public static final int TRIAL_JOB_SPEC_FIELD_NUMBER
Field Value
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
public static HyperparameterTuningJob getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static HyperparameterTuningJob.Builder newBuilder()
Returns
public static HyperparameterTuningJob.Builder newBuilder(HyperparameterTuningJob prototype)
Parameter
Returns
public static HyperparameterTuningJob parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static HyperparameterTuningJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static HyperparameterTuningJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<HyperparameterTuningJob> parser()
Returns
Methods
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;
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Timestamp getCreateTime()
Output only. Time when the HyperparameterTuningJob was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time when the HyperparameterTuningJob was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public HyperparameterTuningJob getDefaultInstanceForType()
Returns
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];
| Type | Description |
| String | The displayName.
|
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];
| Type | Description |
| ByteString | The bytes for displayName.
|
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;
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;
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];
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];
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];
| Type | Description |
| com.google.rpc.Status | The error.
|
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];
| Type | Description |
| com.google.rpc.StatusOrBuilder | |
public Map<String,String> getLabels()
Returns
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;
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;
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;
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;
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;
| Type | Description |
| int | The maxFailedTrialCount.
|
public int getMaxTrialCount()
Required. The desired total number of Trials.
int32 max_trial_count = 5 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| int | The maxTrialCount.
|
Output only. Resource name of the HyperparameterTuningJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Output only. Resource name of the HyperparameterTuningJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getParallelTrialCount()
Required. The desired number of Trials to run in parallel.
int32 parallel_trial_count = 6 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| int | The parallelTrialCount.
|
public Parser<HyperparameterTuningJob> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
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];
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];
public JobState getState()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getStateValue()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
public StudySpec getStudySpec()
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
public StudySpecOrBuilder getStudySpecOrBuilder()
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
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];
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];
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];
public int getTrialsCount()
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<Trial> getTrialsList()
Output only. Trials of the HyperparameterTuningJob.
repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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];
| Type | Description |
| List<? extends com.google.cloud.aiplatform.v1.TrialOrBuilder> | |
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
public boolean hasCreateTime()
Output only. Time when the HyperparameterTuningJob was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
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;
| Type | Description |
| boolean | Whether the encryptionSpec field is set.
|
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];
| Type | Description |
| boolean | Whether the endTime field is set.
|
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];
| Type | Description |
| boolean | Whether the error field is set.
|
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];
| Type | Description |
| boolean | Whether the startTime field is set.
|
public boolean hasStudySpec()
Required. Study configuration of the HyperparameterTuningJob.
.google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the studySpec field is set.
|
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];
| Type | Description |
| boolean | Whether the trialJobSpec field is set.
|
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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public HyperparameterTuningJob.Builder newBuilderForType()
Returns
protected HyperparameterTuningJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public HyperparameterTuningJob.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
