com.google.cloud.aiplatform.v1beta1

Interface HyperparameterTuningJobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

HyperparameterTuningJob, HyperparameterTuningJob.Builder

public interface HyperparameterTuningJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels with user-defined metadata to organize HyperparameterTuningJobs.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
EncryptionSpec	getEncryptionSpec() Customer-managed encryption key options for a HyperparameterTuningJob.
EncryptionSpecOrBuilder	getEncryptionSpecOrBuilder() Customer-managed encryption key options for a HyperparameterTuningJob.
com.google.protobuf.Timestamp	getEndTime() Output only.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Output only.
com.google.rpc.Status	getError() Output only.
com.google.rpc.StatusOrBuilder	getErrorOrBuilder() Output only.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels with user-defined metadata to organize HyperparameterTuningJobs.
Map<String,String>	getLabelsMap() The labels with user-defined metadata to organize HyperparameterTuningJobs.
String	getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize HyperparameterTuningJobs.
String	getLabelsOrThrow(String key) The labels with user-defined metadata to organize HyperparameterTuningJobs.
int	getMaxFailedTrialCount() The number of failed Trials that need to be seen before failing the HyperparameterTuningJob.
int	getMaxTrialCount() Required.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
int	getParallelTrialCount() Required.
boolean	getSatisfiesPzi() Output only.
boolean	getSatisfiesPzs() Output only.
com.google.protobuf.Timestamp	getStartTime() Output only.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Output only.
JobState	getState() Output only.
int	getStateValue() Output only.
StudySpec	getStudySpec() Required.
StudySpecOrBuilder	getStudySpecOrBuilder() Required.
CustomJobSpec	getTrialJobSpec() Required.
CustomJobSpecOrBuilder	getTrialJobSpecOrBuilder() Required.
Trial	getTrials(int index) Output only.
int	getTrialsCount() Output only.
List<Trial>	getTrialsList() Output only.
TrialOrBuilder	getTrialsOrBuilder(int index) Output only.
List<? extends TrialOrBuilder>	getTrialsOrBuilderList() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasEncryptionSpec() Customer-managed encryption key options for a HyperparameterTuningJob.
boolean	hasEndTime() Output only.
boolean	hasError() Output only.
boolean	hasStartTime() Output only.
boolean	hasStudySpec() Required.
boolean	hasTrialJobSpec() Required.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. Resource name of the HyperparameterTuningJob.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Resource name of the HyperparameterTuningJob.
 

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

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

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

Returns:

The bytes for displayName.

hasStudySpec

boolean hasStudySpec()

 Required. Study configuration of the HyperparameterTuningJob.
 

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

Returns:

Whether the studySpec field is set.

getStudySpec

StudySpec getStudySpec()

 Required. Study configuration of the HyperparameterTuningJob.
 

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

Returns:

The studySpec.

getStudySpecOrBuilder

StudySpecOrBuilder getStudySpecOrBuilder()

 Required. Study configuration of the HyperparameterTuningJob.
 

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

getMaxTrialCount

int getMaxTrialCount()

 Required. The desired total number of Trials.
 

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

Returns:

The maxTrialCount.

getParallelTrialCount

int getParallelTrialCount()

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

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

Returns:

The parallelTrialCount.

getMaxFailedTrialCount

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:

The maxFailedTrialCount.

hasTrialJobSpec

boolean hasTrialJobSpec()

 Required. The spec of a trial job. The same spec applies to the CustomJobs
 created in all the trials.
 

.google.cloud.aiplatform.v1beta1.CustomJobSpec trial_job_spec = 8 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the trialJobSpec field is set.

getTrialJobSpec

CustomJobSpec getTrialJobSpec()

 Required. The spec of a trial job. The same spec applies to the CustomJobs
 created in all the trials.
 

.google.cloud.aiplatform.v1beta1.CustomJobSpec trial_job_spec = 8 [(.google.api.field_behavior) = REQUIRED];

Returns:

The trialJobSpec.

getTrialJobSpecOrBuilder

CustomJobSpecOrBuilder getTrialJobSpecOrBuilder()

 Required. The spec of a trial job. The same spec applies to the CustomJobs
 created in all the trials.
 

.google.cloud.aiplatform.v1beta1.CustomJobSpec trial_job_spec = 8 [(.google.api.field_behavior) = REQUIRED];

getTrialsList

List<Trial> getTrialsList()

 Output only. Trials of the HyperparameterTuningJob.
 

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

getTrials

Trial getTrials(int index)

 Output only. Trials of the HyperparameterTuningJob.
 

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

getTrialsCount

int getTrialsCount()

 Output only. Trials of the HyperparameterTuningJob.
 

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

getTrialsOrBuilderList

List<? extends TrialOrBuilder> getTrialsOrBuilderList()

 Output only. Trials of the HyperparameterTuningJob.
 

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

getTrialsOrBuilder

TrialOrBuilder getTrialsOrBuilder(int index)

 Output only. Trials of the HyperparameterTuningJob.
 

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

getStateValue

int getStateValue()

 Output only. The detailed state of the job.
 

.google.cloud.aiplatform.v1beta1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

JobState getState()

 Output only. The detailed state of the job.
 

.google.cloud.aiplatform.v1beta1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

hasCreateTime

boolean hasCreateTime()

 Output only. Time when the HyperparameterTuningJob was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

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

Returns:

The createTime.

getCreateTimeOrBuilder

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

hasStartTime

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:

Whether the startTime field is set.

getStartTime

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

Returns:

The startTime.

getStartTimeOrBuilder

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

hasEndTime

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:

Whether the endTime field is set.

getEndTime

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

Returns:

The endTime.

getEndTimeOrBuilder

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

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

hasError

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:

Whether the error field is set.

getError

com.google.rpc.Status getError()

 Output only. Only populated when job's state is JOB_STATE_FAILED or
 JOB_STATE_CANCELLED.
 

.google.rpc.Status error = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The error.

getErrorOrBuilder

com.google.rpc.StatusOrBuilder getErrorOrBuilder()

 Output only. Only populated when job's state is JOB_STATE_FAILED or
 JOB_STATE_CANCELLED.
 

.google.rpc.Status error = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

getLabelsCount

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;

containsLabels

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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;

getLabelsOrDefault

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;

getLabelsOrThrow

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;

hasEncryptionSpec

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.v1beta1.EncryptionSpec encryption_spec = 17;

Returns:

Whether the encryptionSpec field is set.

getEncryptionSpec

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.v1beta1.EncryptionSpec encryption_spec = 17;

Returns:

The encryptionSpec.

getEncryptionSpecOrBuilder

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.v1beta1.EncryptionSpec encryption_spec = 17;

getSatisfiesPzs

boolean getSatisfiesPzs()

 Output only. Reserved for future use.
 

bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The satisfiesPzs.

getSatisfiesPzi

boolean getSatisfiesPzi()

 Output only. Reserved for future use.
 

bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The satisfiesPzi.