com.google.cloud.aiplatform.v1beta1

Class HyperparameterTuningJob

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.HyperparameterTuningJob

All Implemented Interfaces:

HyperparameterTuningJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class HyperparameterTuningJob
extends com.google.protobuf.GeneratedMessageV3
implements HyperparameterTuningJobOrBuilder

 Represents a HyperparameterTuningJob. A HyperparameterTuningJob
 has a Study specification and multiple CustomJobs with identical
 CustomJob specification.
 

Protobuf type google.cloud.aiplatform.v1beta1.HyperparameterTuningJob

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HyperparameterTuningJob.Builder Represents a HyperparameterTuningJob.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE_TIME_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	ENCRYPTION_SPEC_FIELD_NUMBER
static int	END_TIME_FIELD_NUMBER
static int	ERROR_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	MAX_FAILED_TRIAL_COUNT_FIELD_NUMBER
static int	MAX_TRIAL_COUNT_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PARALLEL_TRIAL_COUNT_FIELD_NUMBER
static int	SATISFIES_PZI_FIELD_NUMBER
static int	SATISFIES_PZS_FIELD_NUMBER
static int	START_TIME_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	STUDY_SPEC_FIELD_NUMBER
static int	TRIAL_JOB_SPEC_FIELD_NUMBER
static int	TRIALS_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels with user-defined metadata to organize HyperparameterTuningJobs.
boolean	equals(Object obj)
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
static HyperparameterTuningJob	getDefaultInstance()
HyperparameterTuningJob	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<HyperparameterTuningJob>	getParserForType()
boolean	getSatisfiesPzi() Output only.
boolean	getSatisfiesPzs() Output only.
int	getSerializedSize()
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.
int	hashCode()
boolean	hasStartTime() Output only.
boolean	hasStudySpec() Required.
boolean	hasTrialJobSpec() Required.
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static HyperparameterTuningJob.Builder	newBuilder()
static HyperparameterTuningJob.Builder	newBuilder(HyperparameterTuningJob prototype)
HyperparameterTuningJob.Builder	newBuilderForType()
protected HyperparameterTuningJob.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static HyperparameterTuningJob	parseDelimitedFrom(InputStream input)
static HyperparameterTuningJob	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HyperparameterTuningJob	parseFrom(byte[] data)
static HyperparameterTuningJob	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HyperparameterTuningJob	parseFrom(ByteBuffer data)
static HyperparameterTuningJob	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HyperparameterTuningJob	parseFrom(com.google.protobuf.ByteString data)
static HyperparameterTuningJob	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HyperparameterTuningJob	parseFrom(com.google.protobuf.CodedInputStream input)
static HyperparameterTuningJob	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HyperparameterTuningJob	parseFrom(InputStream input)
static HyperparameterTuningJob	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<HyperparameterTuningJob>	parser()
HyperparameterTuningJob.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

STUDY_SPEC_FIELD_NUMBER

public static final int STUDY_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

MAX_TRIAL_COUNT_FIELD_NUMBER

public static final int MAX_TRIAL_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

PARALLEL_TRIAL_COUNT_FIELD_NUMBER

public static final int PARALLEL_TRIAL_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

MAX_FAILED_TRIAL_COUNT_FIELD_NUMBER

public static final int MAX_FAILED_TRIAL_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

TRIAL_JOB_SPEC_FIELD_NUMBER

public static final int TRIAL_JOB_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

TRIALS_FIELD_NUMBER

public static final int TRIALS_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

See Also:

Constant Field Values

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

ENCRYPTION_SPEC_FIELD_NUMBER

public static final int ENCRYPTION_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER

See Also:

Constant Field Values

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Output only. Resource name of the HyperparameterTuningJob.
 

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

Specified by:

getName in interface HyperparameterTuningJobOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only. Resource name of the HyperparameterTuningJob.
 

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

Specified by:

getNameBytes in interface HyperparameterTuningJobOrBuilder

Returns:

The bytes for name.

getDisplayName

public String getDisplayName()

 Required. The display name of the HyperparameterTuningJob.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayName in interface HyperparameterTuningJobOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Required. The display name of the HyperparameterTuningJob.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayNameBytes in interface HyperparameterTuningJobOrBuilder

Returns:

The bytes for displayName.

hasStudySpec

public boolean hasStudySpec()

 Required. Study configuration of the HyperparameterTuningJob.
 

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

Specified by:

hasStudySpec in interface HyperparameterTuningJobOrBuilder

Returns:

Whether the studySpec field is set.

getStudySpec

public StudySpec getStudySpec()

 Required. Study configuration of the HyperparameterTuningJob.
 

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

Specified by:

getStudySpec in interface HyperparameterTuningJobOrBuilder

Returns:

The studySpec.

getStudySpecOrBuilder

public StudySpecOrBuilder getStudySpecOrBuilder()

 Required. Study configuration of the HyperparameterTuningJob.
 

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

Specified by:

getStudySpecOrBuilder in interface HyperparameterTuningJobOrBuilder

getMaxTrialCount

public int getMaxTrialCount()

 Required. The desired total number of Trials.
 

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

Specified by:

getMaxTrialCount in interface HyperparameterTuningJobOrBuilder

Returns:

The maxTrialCount.

getParallelTrialCount

public int getParallelTrialCount()

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

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

Specified by:

getParallelTrialCount in interface HyperparameterTuningJobOrBuilder

Returns:

The parallelTrialCount.

getMaxFailedTrialCount

public int getMaxFailedTrialCount()

 The number of failed Trials that need to be seen before failing
 the HyperparameterTuningJob.

 If set to 0, Vertex AI decides how many Trials must fail
 before the whole job fails.
 

int32 max_failed_trial_count = 7;

Specified by:

getMaxFailedTrialCount in interface HyperparameterTuningJobOrBuilder

Returns:

The maxFailedTrialCount.

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.v1beta1.CustomJobSpec trial_job_spec = 8 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasTrialJobSpec in interface HyperparameterTuningJobOrBuilder

Returns:

Whether the trialJobSpec field is set.

getTrialJobSpec

public CustomJobSpec getTrialJobSpec()

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

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

Specified by:

getTrialJobSpec in interface HyperparameterTuningJobOrBuilder

Returns:

The trialJobSpec.

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.v1beta1.CustomJobSpec trial_job_spec = 8 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getTrialJobSpecOrBuilder in interface HyperparameterTuningJobOrBuilder

getTrialsList

public List<Trial> getTrialsList()

 Output only. Trials of the HyperparameterTuningJob.
 

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

Specified by:

getTrialsList in interface HyperparameterTuningJobOrBuilder

getTrialsOrBuilderList

public List<? extends TrialOrBuilder> getTrialsOrBuilderList()

 Output only. Trials of the HyperparameterTuningJob.
 

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

Specified by:

getTrialsOrBuilderList in interface HyperparameterTuningJobOrBuilder

getTrialsCount

public int getTrialsCount()

 Output only. Trials of the HyperparameterTuningJob.
 

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

Specified by:

getTrialsCount in interface HyperparameterTuningJobOrBuilder

getTrials

public Trial getTrials(int index)

 Output only. Trials of the HyperparameterTuningJob.
 

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

Specified by:

getTrials in interface HyperparameterTuningJobOrBuilder

getTrialsOrBuilder

public TrialOrBuilder getTrialsOrBuilder(int index)

 Output only. Trials of the HyperparameterTuningJob.
 

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

Specified by:

getTrialsOrBuilder in interface HyperparameterTuningJobOrBuilder

getStateValue

public int getStateValue()

 Output only. The detailed state of the job.
 

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

Specified by:

getStateValue in interface HyperparameterTuningJobOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public JobState getState()

 Output only. The detailed state of the job.
 

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

Specified by:

getState in interface HyperparameterTuningJobOrBuilder

Returns:

The state.

hasCreateTime

public boolean hasCreateTime()

 Output only. Time when the HyperparameterTuningJob was created.
 

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

Specified by:

hasCreateTime in interface HyperparameterTuningJobOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Time when the HyperparameterTuningJob was created.
 

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

Specified by:

getCreateTime in interface HyperparameterTuningJobOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Time when the HyperparameterTuningJob was created.
 

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

Specified by:

getCreateTimeOrBuilder in interface HyperparameterTuningJobOrBuilder

hasStartTime

public boolean hasStartTime()

 Output only. Time when the HyperparameterTuningJob for the first time
 entered the `JOB_STATE_RUNNING` state.
 

.google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasStartTime in interface HyperparameterTuningJobOrBuilder

Returns:

Whether the startTime field is set.

getStartTime

public com.google.protobuf.Timestamp getStartTime()

 Output only. Time when the HyperparameterTuningJob for the first time
 entered the `JOB_STATE_RUNNING` state.
 

.google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getStartTime in interface HyperparameterTuningJobOrBuilder

Returns:

The startTime.

getStartTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Output only. Time when the HyperparameterTuningJob for the first time
 entered the `JOB_STATE_RUNNING` state.
 

.google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getStartTimeOrBuilder in interface HyperparameterTuningJobOrBuilder

hasEndTime

public boolean hasEndTime()

 Output only. Time when the HyperparameterTuningJob entered any of the
 following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
 `JOB_STATE_CANCELLED`.
 

.google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasEndTime in interface HyperparameterTuningJobOrBuilder

Returns:

Whether the endTime field is set.

getEndTime

public com.google.protobuf.Timestamp getEndTime()

 Output only. Time when the HyperparameterTuningJob entered any of the
 following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
 `JOB_STATE_CANCELLED`.
 

.google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getEndTime in interface HyperparameterTuningJobOrBuilder

Returns:

The endTime.

getEndTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 Output only. Time when the HyperparameterTuningJob entered any of the
 following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
 `JOB_STATE_CANCELLED`.
 

.google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getEndTimeOrBuilder in interface HyperparameterTuningJobOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

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

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

Specified by:

hasUpdateTime in interface HyperparameterTuningJobOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

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

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

Specified by:

getUpdateTime in interface HyperparameterTuningJobOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Specified by:

getUpdateTimeOrBuilder in interface HyperparameterTuningJobOrBuilder

hasError

public boolean hasError()

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

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

Specified by:

hasError in interface HyperparameterTuningJobOrBuilder

Returns:

Whether the error field is set.

getError

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

Specified by:

getError in interface HyperparameterTuningJobOrBuilder

Returns:

The error.

getErrorOrBuilder

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

Specified by:

getErrorOrBuilder in interface HyperparameterTuningJobOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: HyperparameterTuningJobOrBuilder

 The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 16;

Specified by:

getLabelsCount in interface HyperparameterTuningJobOrBuilder

containsLabels

public boolean containsLabels(String key)

 The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 16;

Specified by:

containsLabels in interface HyperparameterTuningJobOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface HyperparameterTuningJobOrBuilder

getLabelsMap

public Map<String,String> getLabelsMap()

 The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 16;

Specified by:

getLabelsMap in interface HyperparameterTuningJobOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 String defaultValue)

 The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 16;

Specified by:

getLabelsOrDefault in interface HyperparameterTuningJobOrBuilder

getLabelsOrThrow

public String getLabelsOrThrow(String key)

 The labels with user-defined metadata to organize HyperparameterTuningJobs.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 16;

Specified by:

getLabelsOrThrow in interface HyperparameterTuningJobOrBuilder

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

Specified by:

hasEncryptionSpec in interface HyperparameterTuningJobOrBuilder

Returns:

Whether the encryptionSpec field is set.

getEncryptionSpec

public EncryptionSpec getEncryptionSpec()

 Customer-managed encryption key options for a HyperparameterTuningJob.
 If this is set, then all resources created by the HyperparameterTuningJob
 will be encrypted with the provided encryption key.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 17;

Specified by:

getEncryptionSpec in interface HyperparameterTuningJobOrBuilder

Returns:

The encryptionSpec.

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

Specified by:

getEncryptionSpecOrBuilder in interface HyperparameterTuningJobOrBuilder

getSatisfiesPzs

public boolean getSatisfiesPzs()

 Output only. Reserved for future use.
 

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

Specified by:

getSatisfiesPzs in interface HyperparameterTuningJobOrBuilder

Returns:

The satisfiesPzs.

getSatisfiesPzi

public boolean getSatisfiesPzi()

 Output only. Reserved for future use.
 

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

Specified by:

getSatisfiesPzi in interface HyperparameterTuningJobOrBuilder

Returns:

The satisfiesPzi.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static HyperparameterTuningJob parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HyperparameterTuningJob parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HyperparameterTuningJob parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HyperparameterTuningJob parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HyperparameterTuningJob parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HyperparameterTuningJob parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HyperparameterTuningJob parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static HyperparameterTuningJob parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static HyperparameterTuningJob parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static HyperparameterTuningJob parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static HyperparameterTuningJob parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static HyperparameterTuningJob parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public HyperparameterTuningJob.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static HyperparameterTuningJob.Builder newBuilder()

newBuilder

public static HyperparameterTuningJob.Builder newBuilder(HyperparameterTuningJob prototype)

toBuilder

public HyperparameterTuningJob.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected HyperparameterTuningJob.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static HyperparameterTuningJob getDefaultInstance()

parser

public static com.google.protobuf.Parser<HyperparameterTuningJob> parser()

getParserForType

public com.google.protobuf.Parser<HyperparameterTuningJob> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public HyperparameterTuningJob getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder