com.google.cloud.aiplatform.v1

Class StudySpec.StudyStoppingConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

com.google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig.Builder

All Implemented Interfaces:

StudySpec.StudyStoppingConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

StudySpec.StudyStoppingConfig

public static final class StudySpec.StudyStoppingConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>
implements StudySpec.StudyStoppingConfigOrBuilder

 The configuration (stopping conditions) for automated stopping of a Study.
 Conditions include trial budgets, time budgets, and convergence detection.
 

Protobuf type google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig

Method Summary

Modifier and Type	Method and Description
StudySpec.StudyStoppingConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StudySpec.StudyStoppingConfig	build()
StudySpec.StudyStoppingConfig	buildPartial()
StudySpec.StudyStoppingConfig.Builder	clear()
StudySpec.StudyStoppingConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
StudySpec.StudyStoppingConfig.Builder	clearMaxDurationNoProgress() If the objective value has not improved for this much time, stop the study.
StudySpec.StudyStoppingConfig.Builder	clearMaximumRuntimeConstraint() If the specified time or duration has passed, stop the study.
StudySpec.StudyStoppingConfig.Builder	clearMaxNumTrials() If there are more than this many trials, stop the study.
StudySpec.StudyStoppingConfig.Builder	clearMaxNumTrialsNoProgress() If the objective value has not improved for this many consecutive trials, stop the study.
StudySpec.StudyStoppingConfig.Builder	clearMinimumRuntimeConstraint() Each "stopping rule" in this proto specifies an "if" condition.
StudySpec.StudyStoppingConfig.Builder	clearMinNumTrials() If there are fewer than this many COMPLETED trials, do not stop the study.
StudySpec.StudyStoppingConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
StudySpec.StudyStoppingConfig.Builder	clearShouldStopAsap() If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.
StudySpec.StudyStoppingConfig.Builder	clone()
StudySpec.StudyStoppingConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.Duration	getMaxDurationNoProgress() If the objective value has not improved for this much time, stop the study.
com.google.protobuf.Duration.Builder	getMaxDurationNoProgressBuilder() If the objective value has not improved for this much time, stop the study.
com.google.protobuf.DurationOrBuilder	getMaxDurationNoProgressOrBuilder() If the objective value has not improved for this much time, stop the study.
StudyTimeConstraint	getMaximumRuntimeConstraint() If the specified time or duration has passed, stop the study.
StudyTimeConstraint.Builder	getMaximumRuntimeConstraintBuilder() If the specified time or duration has passed, stop the study.
StudyTimeConstraintOrBuilder	getMaximumRuntimeConstraintOrBuilder() If the specified time or duration has passed, stop the study.
com.google.protobuf.Int32Value	getMaxNumTrials() If there are more than this many trials, stop the study.
com.google.protobuf.Int32Value.Builder	getMaxNumTrialsBuilder() If there are more than this many trials, stop the study.
com.google.protobuf.Int32Value	getMaxNumTrialsNoProgress() If the objective value has not improved for this many consecutive trials, stop the study.
com.google.protobuf.Int32Value.Builder	getMaxNumTrialsNoProgressBuilder() If the objective value has not improved for this many consecutive trials, stop the study.
com.google.protobuf.Int32ValueOrBuilder	getMaxNumTrialsNoProgressOrBuilder() If the objective value has not improved for this many consecutive trials, stop the study.
com.google.protobuf.Int32ValueOrBuilder	getMaxNumTrialsOrBuilder() If there are more than this many trials, stop the study.
StudyTimeConstraint	getMinimumRuntimeConstraint() Each "stopping rule" in this proto specifies an "if" condition.
StudyTimeConstraint.Builder	getMinimumRuntimeConstraintBuilder() Each "stopping rule" in this proto specifies an "if" condition.
StudyTimeConstraintOrBuilder	getMinimumRuntimeConstraintOrBuilder() Each "stopping rule" in this proto specifies an "if" condition.
com.google.protobuf.Int32Value	getMinNumTrials() If there are fewer than this many COMPLETED trials, do not stop the study.
com.google.protobuf.Int32Value.Builder	getMinNumTrialsBuilder() If there are fewer than this many COMPLETED trials, do not stop the study.
com.google.protobuf.Int32ValueOrBuilder	getMinNumTrialsOrBuilder() If there are fewer than this many COMPLETED trials, do not stop the study.
com.google.protobuf.BoolValue	getShouldStopAsap() If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.
com.google.protobuf.BoolValue.Builder	getShouldStopAsapBuilder() If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.
com.google.protobuf.BoolValueOrBuilder	getShouldStopAsapOrBuilder() If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.
boolean	hasMaxDurationNoProgress() If the objective value has not improved for this much time, stop the study.
boolean	hasMaximumRuntimeConstraint() If the specified time or duration has passed, stop the study.
boolean	hasMaxNumTrials() If there are more than this many trials, stop the study.
boolean	hasMaxNumTrialsNoProgress() If the objective value has not improved for this many consecutive trials, stop the study.
boolean	hasMinimumRuntimeConstraint() Each "stopping rule" in this proto specifies an "if" condition.
boolean	hasMinNumTrials() If there are fewer than this many COMPLETED trials, do not stop the study.
boolean	hasShouldStopAsap() If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
StudySpec.StudyStoppingConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
StudySpec.StudyStoppingConfig.Builder	mergeFrom(com.google.protobuf.Message other)
StudySpec.StudyStoppingConfig.Builder	mergeFrom(StudySpec.StudyStoppingConfig other)
StudySpec.StudyStoppingConfig.Builder	mergeMaxDurationNoProgress(com.google.protobuf.Duration value) If the objective value has not improved for this much time, stop the study.
StudySpec.StudyStoppingConfig.Builder	mergeMaximumRuntimeConstraint(StudyTimeConstraint value) If the specified time or duration has passed, stop the study.
StudySpec.StudyStoppingConfig.Builder	mergeMaxNumTrials(com.google.protobuf.Int32Value value) If there are more than this many trials, stop the study.
StudySpec.StudyStoppingConfig.Builder	mergeMaxNumTrialsNoProgress(com.google.protobuf.Int32Value value) If the objective value has not improved for this many consecutive trials, stop the study.
StudySpec.StudyStoppingConfig.Builder	mergeMinimumRuntimeConstraint(StudyTimeConstraint value) Each "stopping rule" in this proto specifies an "if" condition.
StudySpec.StudyStoppingConfig.Builder	mergeMinNumTrials(com.google.protobuf.Int32Value value) If there are fewer than this many COMPLETED trials, do not stop the study.
StudySpec.StudyStoppingConfig.Builder	mergeShouldStopAsap(com.google.protobuf.BoolValue value) If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.
StudySpec.StudyStoppingConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
StudySpec.StudyStoppingConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StudySpec.StudyStoppingConfig.Builder	setMaxDurationNoProgress(com.google.protobuf.Duration.Builder builderForValue) If the objective value has not improved for this much time, stop the study.
StudySpec.StudyStoppingConfig.Builder	setMaxDurationNoProgress(com.google.protobuf.Duration value) If the objective value has not improved for this much time, stop the study.
StudySpec.StudyStoppingConfig.Builder	setMaximumRuntimeConstraint(StudyTimeConstraint.Builder builderForValue) If the specified time or duration has passed, stop the study.
StudySpec.StudyStoppingConfig.Builder	setMaximumRuntimeConstraint(StudyTimeConstraint value) If the specified time or duration has passed, stop the study.
StudySpec.StudyStoppingConfig.Builder	setMaxNumTrials(com.google.protobuf.Int32Value.Builder builderForValue) If there are more than this many trials, stop the study.
StudySpec.StudyStoppingConfig.Builder	setMaxNumTrials(com.google.protobuf.Int32Value value) If there are more than this many trials, stop the study.
StudySpec.StudyStoppingConfig.Builder	setMaxNumTrialsNoProgress(com.google.protobuf.Int32Value.Builder builderForValue) If the objective value has not improved for this many consecutive trials, stop the study.
StudySpec.StudyStoppingConfig.Builder	setMaxNumTrialsNoProgress(com.google.protobuf.Int32Value value) If the objective value has not improved for this many consecutive trials, stop the study.
StudySpec.StudyStoppingConfig.Builder	setMinimumRuntimeConstraint(StudyTimeConstraint.Builder builderForValue) Each "stopping rule" in this proto specifies an "if" condition.
StudySpec.StudyStoppingConfig.Builder	setMinimumRuntimeConstraint(StudyTimeConstraint value) Each "stopping rule" in this proto specifies an "if" condition.
StudySpec.StudyStoppingConfig.Builder	setMinNumTrials(com.google.protobuf.Int32Value.Builder builderForValue) If there are fewer than this many COMPLETED trials, do not stop the study.
StudySpec.StudyStoppingConfig.Builder	setMinNumTrials(com.google.protobuf.Int32Value value) If there are fewer than this many COMPLETED trials, do not stop the study.
StudySpec.StudyStoppingConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
StudySpec.StudyStoppingConfig.Builder	setShouldStopAsap(com.google.protobuf.BoolValue.Builder builderForValue) If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.
StudySpec.StudyStoppingConfig.Builder	setShouldStopAsap(com.google.protobuf.BoolValue value) If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.
StudySpec.StudyStoppingConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

clear

public StudySpec.StudyStoppingConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

getDefaultInstanceForType

public StudySpec.StudyStoppingConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public StudySpec.StudyStoppingConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public StudySpec.StudyStoppingConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public StudySpec.StudyStoppingConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

setField

public StudySpec.StudyStoppingConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

clearField

public StudySpec.StudyStoppingConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

clearOneof

public StudySpec.StudyStoppingConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

setRepeatedField

public StudySpec.StudyStoppingConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              int index,
                                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

addRepeatedField

public StudySpec.StudyStoppingConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

mergeFrom

public StudySpec.StudyStoppingConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StudySpec.StudyStoppingConfig.Builder>

mergeFrom

public StudySpec.StudyStoppingConfig.Builder mergeFrom(StudySpec.StudyStoppingConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

mergeFrom

public StudySpec.StudyStoppingConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StudySpec.StudyStoppingConfig.Builder>

Throws:

IOException

hasShouldStopAsap

public boolean hasShouldStopAsap()

 If true, a Study enters STOPPING_ASAP whenever it would normally enters
 STOPPING state.

 The bottom line is: set to true if you want to interrupt on-going
 evaluations of Trials as soon as the study stopping condition is met.
 (Please see Study.State documentation for the source of truth).
 

.google.protobuf.BoolValue should_stop_asap = 1;

Specified by:

hasShouldStopAsap in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

Whether the shouldStopAsap field is set.

getShouldStopAsap

public com.google.protobuf.BoolValue getShouldStopAsap()

 If true, a Study enters STOPPING_ASAP whenever it would normally enters
 STOPPING state.

 The bottom line is: set to true if you want to interrupt on-going
 evaluations of Trials as soon as the study stopping condition is met.
 (Please see Study.State documentation for the source of truth).
 

.google.protobuf.BoolValue should_stop_asap = 1;

Specified by:

getShouldStopAsap in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

The shouldStopAsap.

setShouldStopAsap

public StudySpec.StudyStoppingConfig.Builder setShouldStopAsap(com.google.protobuf.BoolValue value)

 If true, a Study enters STOPPING_ASAP whenever it would normally enters
 STOPPING state.

 The bottom line is: set to true if you want to interrupt on-going
 evaluations of Trials as soon as the study stopping condition is met.
 (Please see Study.State documentation for the source of truth).
 

.google.protobuf.BoolValue should_stop_asap = 1;

setShouldStopAsap

public StudySpec.StudyStoppingConfig.Builder setShouldStopAsap(com.google.protobuf.BoolValue.Builder builderForValue)

 If true, a Study enters STOPPING_ASAP whenever it would normally enters
 STOPPING state.

 The bottom line is: set to true if you want to interrupt on-going
 evaluations of Trials as soon as the study stopping condition is met.
 (Please see Study.State documentation for the source of truth).
 

.google.protobuf.BoolValue should_stop_asap = 1;

mergeShouldStopAsap

public StudySpec.StudyStoppingConfig.Builder mergeShouldStopAsap(com.google.protobuf.BoolValue value)

 If true, a Study enters STOPPING_ASAP whenever it would normally enters
 STOPPING state.

 The bottom line is: set to true if you want to interrupt on-going
 evaluations of Trials as soon as the study stopping condition is met.
 (Please see Study.State documentation for the source of truth).
 

.google.protobuf.BoolValue should_stop_asap = 1;

clearShouldStopAsap

public StudySpec.StudyStoppingConfig.Builder clearShouldStopAsap()

 If true, a Study enters STOPPING_ASAP whenever it would normally enters
 STOPPING state.

 The bottom line is: set to true if you want to interrupt on-going
 evaluations of Trials as soon as the study stopping condition is met.
 (Please see Study.State documentation for the source of truth).
 

.google.protobuf.BoolValue should_stop_asap = 1;

getShouldStopAsapBuilder

public com.google.protobuf.BoolValue.Builder getShouldStopAsapBuilder()

 If true, a Study enters STOPPING_ASAP whenever it would normally enters
 STOPPING state.

 The bottom line is: set to true if you want to interrupt on-going
 evaluations of Trials as soon as the study stopping condition is met.
 (Please see Study.State documentation for the source of truth).
 

.google.protobuf.BoolValue should_stop_asap = 1;

getShouldStopAsapOrBuilder

public com.google.protobuf.BoolValueOrBuilder getShouldStopAsapOrBuilder()

 If true, a Study enters STOPPING_ASAP whenever it would normally enters
 STOPPING state.

 The bottom line is: set to true if you want to interrupt on-going
 evaluations of Trials as soon as the study stopping condition is met.
 (Please see Study.State documentation for the source of truth).
 

.google.protobuf.BoolValue should_stop_asap = 1;

Specified by:

getShouldStopAsapOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

hasMinimumRuntimeConstraint

public boolean hasMinimumRuntimeConstraint()

 Each "stopping rule" in this proto specifies an "if" condition. Before
 Vizier would generate a new suggestion, it first checks each specified
 stopping rule, from top to bottom in this list.
 Note that the first few rules (e.g. minimum_runtime_constraint,
 min_num_trials) will prevent other stopping rules from being evaluated
 until they are met. For example, setting `min_num_trials=5` and
 `always_stop_after= 1 hour` means that the Study will ONLY stop after it
 has 5 COMPLETED trials, even if more than an hour has passed since its
 creation. It follows the first applicable rule (whose "if" condition is
 satisfied) to make a stopping decision. If none of the specified rules
 are applicable, then Vizier decides that the study should not stop.
 If Vizier decides that the study should stop, the study enters
 STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
 IMPORTANT: The automatic study state transition happens precisely as
 described above; that is, deleting trials or updating StudyConfig NEVER
 automatically moves the study state back to ACTIVE. If you want to
 _resume_ a Study that was stopped, 1) change the stopping conditions if
 necessary, 2) activate the study, and then 3) ask for suggestions.
 If the specified time or duration has not passed, do not stop the
 study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;

Specified by:

hasMinimumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

Whether the minimumRuntimeConstraint field is set.

getMinimumRuntimeConstraint

public StudyTimeConstraint getMinimumRuntimeConstraint()

 Each "stopping rule" in this proto specifies an "if" condition. Before
 Vizier would generate a new suggestion, it first checks each specified
 stopping rule, from top to bottom in this list.
 Note that the first few rules (e.g. minimum_runtime_constraint,
 min_num_trials) will prevent other stopping rules from being evaluated
 until they are met. For example, setting `min_num_trials=5` and
 `always_stop_after= 1 hour` means that the Study will ONLY stop after it
 has 5 COMPLETED trials, even if more than an hour has passed since its
 creation. It follows the first applicable rule (whose "if" condition is
 satisfied) to make a stopping decision. If none of the specified rules
 are applicable, then Vizier decides that the study should not stop.
 If Vizier decides that the study should stop, the study enters
 STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
 IMPORTANT: The automatic study state transition happens precisely as
 described above; that is, deleting trials or updating StudyConfig NEVER
 automatically moves the study state back to ACTIVE. If you want to
 _resume_ a Study that was stopped, 1) change the stopping conditions if
 necessary, 2) activate the study, and then 3) ask for suggestions.
 If the specified time or duration has not passed, do not stop the
 study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;

Specified by:

getMinimumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

The minimumRuntimeConstraint.

setMinimumRuntimeConstraint

public StudySpec.StudyStoppingConfig.Builder setMinimumRuntimeConstraint(StudyTimeConstraint value)

 Each "stopping rule" in this proto specifies an "if" condition. Before
 Vizier would generate a new suggestion, it first checks each specified
 stopping rule, from top to bottom in this list.
 Note that the first few rules (e.g. minimum_runtime_constraint,
 min_num_trials) will prevent other stopping rules from being evaluated
 until they are met. For example, setting `min_num_trials=5` and
 `always_stop_after= 1 hour` means that the Study will ONLY stop after it
 has 5 COMPLETED trials, even if more than an hour has passed since its
 creation. It follows the first applicable rule (whose "if" condition is
 satisfied) to make a stopping decision. If none of the specified rules
 are applicable, then Vizier decides that the study should not stop.
 If Vizier decides that the study should stop, the study enters
 STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
 IMPORTANT: The automatic study state transition happens precisely as
 described above; that is, deleting trials or updating StudyConfig NEVER
 automatically moves the study state back to ACTIVE. If you want to
 _resume_ a Study that was stopped, 1) change the stopping conditions if
 necessary, 2) activate the study, and then 3) ask for suggestions.
 If the specified time or duration has not passed, do not stop the
 study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;

setMinimumRuntimeConstraint

public StudySpec.StudyStoppingConfig.Builder setMinimumRuntimeConstraint(StudyTimeConstraint.Builder builderForValue)

 Each "stopping rule" in this proto specifies an "if" condition. Before
 Vizier would generate a new suggestion, it first checks each specified
 stopping rule, from top to bottom in this list.
 Note that the first few rules (e.g. minimum_runtime_constraint,
 min_num_trials) will prevent other stopping rules from being evaluated
 until they are met. For example, setting `min_num_trials=5` and
 `always_stop_after= 1 hour` means that the Study will ONLY stop after it
 has 5 COMPLETED trials, even if more than an hour has passed since its
 creation. It follows the first applicable rule (whose "if" condition is
 satisfied) to make a stopping decision. If none of the specified rules
 are applicable, then Vizier decides that the study should not stop.
 If Vizier decides that the study should stop, the study enters
 STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
 IMPORTANT: The automatic study state transition happens precisely as
 described above; that is, deleting trials or updating StudyConfig NEVER
 automatically moves the study state back to ACTIVE. If you want to
 _resume_ a Study that was stopped, 1) change the stopping conditions if
 necessary, 2) activate the study, and then 3) ask for suggestions.
 If the specified time or duration has not passed, do not stop the
 study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;

mergeMinimumRuntimeConstraint

public StudySpec.StudyStoppingConfig.Builder mergeMinimumRuntimeConstraint(StudyTimeConstraint value)

 Each "stopping rule" in this proto specifies an "if" condition. Before
 Vizier would generate a new suggestion, it first checks each specified
 stopping rule, from top to bottom in this list.
 Note that the first few rules (e.g. minimum_runtime_constraint,
 min_num_trials) will prevent other stopping rules from being evaluated
 until they are met. For example, setting `min_num_trials=5` and
 `always_stop_after= 1 hour` means that the Study will ONLY stop after it
 has 5 COMPLETED trials, even if more than an hour has passed since its
 creation. It follows the first applicable rule (whose "if" condition is
 satisfied) to make a stopping decision. If none of the specified rules
 are applicable, then Vizier decides that the study should not stop.
 If Vizier decides that the study should stop, the study enters
 STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
 IMPORTANT: The automatic study state transition happens precisely as
 described above; that is, deleting trials or updating StudyConfig NEVER
 automatically moves the study state back to ACTIVE. If you want to
 _resume_ a Study that was stopped, 1) change the stopping conditions if
 necessary, 2) activate the study, and then 3) ask for suggestions.
 If the specified time or duration has not passed, do not stop the
 study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;

clearMinimumRuntimeConstraint

public StudySpec.StudyStoppingConfig.Builder clearMinimumRuntimeConstraint()

 Each "stopping rule" in this proto specifies an "if" condition. Before
 Vizier would generate a new suggestion, it first checks each specified
 stopping rule, from top to bottom in this list.
 Note that the first few rules (e.g. minimum_runtime_constraint,
 min_num_trials) will prevent other stopping rules from being evaluated
 until they are met. For example, setting `min_num_trials=5` and
 `always_stop_after= 1 hour` means that the Study will ONLY stop after it
 has 5 COMPLETED trials, even if more than an hour has passed since its
 creation. It follows the first applicable rule (whose "if" condition is
 satisfied) to make a stopping decision. If none of the specified rules
 are applicable, then Vizier decides that the study should not stop.
 If Vizier decides that the study should stop, the study enters
 STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
 IMPORTANT: The automatic study state transition happens precisely as
 described above; that is, deleting trials or updating StudyConfig NEVER
 automatically moves the study state back to ACTIVE. If you want to
 _resume_ a Study that was stopped, 1) change the stopping conditions if
 necessary, 2) activate the study, and then 3) ask for suggestions.
 If the specified time or duration has not passed, do not stop the
 study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;

getMinimumRuntimeConstraintBuilder

public StudyTimeConstraint.Builder getMinimumRuntimeConstraintBuilder()

 Each "stopping rule" in this proto specifies an "if" condition. Before
 Vizier would generate a new suggestion, it first checks each specified
 stopping rule, from top to bottom in this list.
 Note that the first few rules (e.g. minimum_runtime_constraint,
 min_num_trials) will prevent other stopping rules from being evaluated
 until they are met. For example, setting `min_num_trials=5` and
 `always_stop_after= 1 hour` means that the Study will ONLY stop after it
 has 5 COMPLETED trials, even if more than an hour has passed since its
 creation. It follows the first applicable rule (whose "if" condition is
 satisfied) to make a stopping decision. If none of the specified rules
 are applicable, then Vizier decides that the study should not stop.
 If Vizier decides that the study should stop, the study enters
 STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
 IMPORTANT: The automatic study state transition happens precisely as
 described above; that is, deleting trials or updating StudyConfig NEVER
 automatically moves the study state back to ACTIVE. If you want to
 _resume_ a Study that was stopped, 1) change the stopping conditions if
 necessary, 2) activate the study, and then 3) ask for suggestions.
 If the specified time or duration has not passed, do not stop the
 study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;

getMinimumRuntimeConstraintOrBuilder

public StudyTimeConstraintOrBuilder getMinimumRuntimeConstraintOrBuilder()

 Each "stopping rule" in this proto specifies an "if" condition. Before
 Vizier would generate a new suggestion, it first checks each specified
 stopping rule, from top to bottom in this list.
 Note that the first few rules (e.g. minimum_runtime_constraint,
 min_num_trials) will prevent other stopping rules from being evaluated
 until they are met. For example, setting `min_num_trials=5` and
 `always_stop_after= 1 hour` means that the Study will ONLY stop after it
 has 5 COMPLETED trials, even if more than an hour has passed since its
 creation. It follows the first applicable rule (whose "if" condition is
 satisfied) to make a stopping decision. If none of the specified rules
 are applicable, then Vizier decides that the study should not stop.
 If Vizier decides that the study should stop, the study enters
 STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
 IMPORTANT: The automatic study state transition happens precisely as
 described above; that is, deleting trials or updating StudyConfig NEVER
 automatically moves the study state back to ACTIVE. If you want to
 _resume_ a Study that was stopped, 1) change the stopping conditions if
 necessary, 2) activate the study, and then 3) ask for suggestions.
 If the specified time or duration has not passed, do not stop the
 study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint minimum_runtime_constraint = 2;

Specified by:

getMinimumRuntimeConstraintOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

hasMaximumRuntimeConstraint

public boolean hasMaximumRuntimeConstraint()

 If the specified time or duration has passed, stop the study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

Specified by:

hasMaximumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

Whether the maximumRuntimeConstraint field is set.

getMaximumRuntimeConstraint

public StudyTimeConstraint getMaximumRuntimeConstraint()

 If the specified time or duration has passed, stop the study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

Specified by:

getMaximumRuntimeConstraint in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

The maximumRuntimeConstraint.

setMaximumRuntimeConstraint

public StudySpec.StudyStoppingConfig.Builder setMaximumRuntimeConstraint(StudyTimeConstraint value)

 If the specified time or duration has passed, stop the study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

setMaximumRuntimeConstraint

public StudySpec.StudyStoppingConfig.Builder setMaximumRuntimeConstraint(StudyTimeConstraint.Builder builderForValue)

 If the specified time or duration has passed, stop the study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

mergeMaximumRuntimeConstraint

public StudySpec.StudyStoppingConfig.Builder mergeMaximumRuntimeConstraint(StudyTimeConstraint value)

 If the specified time or duration has passed, stop the study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

clearMaximumRuntimeConstraint

public StudySpec.StudyStoppingConfig.Builder clearMaximumRuntimeConstraint()

 If the specified time or duration has passed, stop the study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

getMaximumRuntimeConstraintBuilder

public StudyTimeConstraint.Builder getMaximumRuntimeConstraintBuilder()

 If the specified time or duration has passed, stop the study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

getMaximumRuntimeConstraintOrBuilder

public StudyTimeConstraintOrBuilder getMaximumRuntimeConstraintOrBuilder()

 If the specified time or duration has passed, stop the study.
 

.google.cloud.aiplatform.v1.StudyTimeConstraint maximum_runtime_constraint = 3;

Specified by:

getMaximumRuntimeConstraintOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

hasMinNumTrials

public boolean hasMinNumTrials()

 If there are fewer than this many COMPLETED trials, do not stop the
 study.
 

.google.protobuf.Int32Value min_num_trials = 4;

Specified by:

hasMinNumTrials in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

Whether the minNumTrials field is set.

getMinNumTrials

public com.google.protobuf.Int32Value getMinNumTrials()

 If there are fewer than this many COMPLETED trials, do not stop the
 study.
 

.google.protobuf.Int32Value min_num_trials = 4;

Specified by:

getMinNumTrials in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

The minNumTrials.

setMinNumTrials

public StudySpec.StudyStoppingConfig.Builder setMinNumTrials(com.google.protobuf.Int32Value value)

 If there are fewer than this many COMPLETED trials, do not stop the
 study.
 

.google.protobuf.Int32Value min_num_trials = 4;

setMinNumTrials

public StudySpec.StudyStoppingConfig.Builder setMinNumTrials(com.google.protobuf.Int32Value.Builder builderForValue)

 If there are fewer than this many COMPLETED trials, do not stop the
 study.
 

.google.protobuf.Int32Value min_num_trials = 4;

mergeMinNumTrials

public StudySpec.StudyStoppingConfig.Builder mergeMinNumTrials(com.google.protobuf.Int32Value value)

 If there are fewer than this many COMPLETED trials, do not stop the
 study.
 

.google.protobuf.Int32Value min_num_trials = 4;

clearMinNumTrials

public StudySpec.StudyStoppingConfig.Builder clearMinNumTrials()

 If there are fewer than this many COMPLETED trials, do not stop the
 study.
 

.google.protobuf.Int32Value min_num_trials = 4;

getMinNumTrialsBuilder

public com.google.protobuf.Int32Value.Builder getMinNumTrialsBuilder()

 If there are fewer than this many COMPLETED trials, do not stop the
 study.
 

.google.protobuf.Int32Value min_num_trials = 4;

getMinNumTrialsOrBuilder

public com.google.protobuf.Int32ValueOrBuilder getMinNumTrialsOrBuilder()

 If there are fewer than this many COMPLETED trials, do not stop the
 study.
 

.google.protobuf.Int32Value min_num_trials = 4;

Specified by:

getMinNumTrialsOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

hasMaxNumTrials

public boolean hasMaxNumTrials()

 If there are more than this many trials, stop the study.
 

.google.protobuf.Int32Value max_num_trials = 5;

Specified by:

hasMaxNumTrials in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

Whether the maxNumTrials field is set.

getMaxNumTrials

public com.google.protobuf.Int32Value getMaxNumTrials()

 If there are more than this many trials, stop the study.
 

.google.protobuf.Int32Value max_num_trials = 5;

Specified by:

getMaxNumTrials in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

The maxNumTrials.

setMaxNumTrials

public StudySpec.StudyStoppingConfig.Builder setMaxNumTrials(com.google.protobuf.Int32Value value)

 If there are more than this many trials, stop the study.
 

.google.protobuf.Int32Value max_num_trials = 5;

setMaxNumTrials

public StudySpec.StudyStoppingConfig.Builder setMaxNumTrials(com.google.protobuf.Int32Value.Builder builderForValue)

 If there are more than this many trials, stop the study.
 

.google.protobuf.Int32Value max_num_trials = 5;

mergeMaxNumTrials

public StudySpec.StudyStoppingConfig.Builder mergeMaxNumTrials(com.google.protobuf.Int32Value value)

 If there are more than this many trials, stop the study.
 

.google.protobuf.Int32Value max_num_trials = 5;

clearMaxNumTrials

public StudySpec.StudyStoppingConfig.Builder clearMaxNumTrials()

 If there are more than this many trials, stop the study.
 

.google.protobuf.Int32Value max_num_trials = 5;

getMaxNumTrialsBuilder

public com.google.protobuf.Int32Value.Builder getMaxNumTrialsBuilder()

 If there are more than this many trials, stop the study.
 

.google.protobuf.Int32Value max_num_trials = 5;

getMaxNumTrialsOrBuilder

public com.google.protobuf.Int32ValueOrBuilder getMaxNumTrialsOrBuilder()

 If there are more than this many trials, stop the study.
 

.google.protobuf.Int32Value max_num_trials = 5;

Specified by:

getMaxNumTrialsOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

hasMaxNumTrialsNoProgress

public boolean hasMaxNumTrialsNoProgress()

 If the objective value has not improved for this many consecutive
 trials, stop the study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Int32Value max_num_trials_no_progress = 6;

Specified by:

hasMaxNumTrialsNoProgress in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

Whether the maxNumTrialsNoProgress field is set.

getMaxNumTrialsNoProgress

public com.google.protobuf.Int32Value getMaxNumTrialsNoProgress()

 If the objective value has not improved for this many consecutive
 trials, stop the study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Int32Value max_num_trials_no_progress = 6;

Specified by:

getMaxNumTrialsNoProgress in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

The maxNumTrialsNoProgress.

setMaxNumTrialsNoProgress

public StudySpec.StudyStoppingConfig.Builder setMaxNumTrialsNoProgress(com.google.protobuf.Int32Value value)

 If the objective value has not improved for this many consecutive
 trials, stop the study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Int32Value max_num_trials_no_progress = 6;

setMaxNumTrialsNoProgress

public StudySpec.StudyStoppingConfig.Builder setMaxNumTrialsNoProgress(com.google.protobuf.Int32Value.Builder builderForValue)

 If the objective value has not improved for this many consecutive
 trials, stop the study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Int32Value max_num_trials_no_progress = 6;

mergeMaxNumTrialsNoProgress

public StudySpec.StudyStoppingConfig.Builder mergeMaxNumTrialsNoProgress(com.google.protobuf.Int32Value value)

 If the objective value has not improved for this many consecutive
 trials, stop the study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Int32Value max_num_trials_no_progress = 6;

clearMaxNumTrialsNoProgress

public StudySpec.StudyStoppingConfig.Builder clearMaxNumTrialsNoProgress()

 If the objective value has not improved for this many consecutive
 trials, stop the study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Int32Value max_num_trials_no_progress = 6;

getMaxNumTrialsNoProgressBuilder

public com.google.protobuf.Int32Value.Builder getMaxNumTrialsNoProgressBuilder()

 If the objective value has not improved for this many consecutive
 trials, stop the study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Int32Value max_num_trials_no_progress = 6;

getMaxNumTrialsNoProgressOrBuilder

public com.google.protobuf.Int32ValueOrBuilder getMaxNumTrialsNoProgressOrBuilder()

 If the objective value has not improved for this many consecutive
 trials, stop the study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Int32Value max_num_trials_no_progress = 6;

Specified by:

getMaxNumTrialsNoProgressOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

hasMaxDurationNoProgress

public boolean hasMaxDurationNoProgress()

 If the objective value has not improved for this much time, stop the
 study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Duration max_duration_no_progress = 7;

Specified by:

hasMaxDurationNoProgress in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

Whether the maxDurationNoProgress field is set.

getMaxDurationNoProgress

public com.google.protobuf.Duration getMaxDurationNoProgress()

 If the objective value has not improved for this much time, stop the
 study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Duration max_duration_no_progress = 7;

Specified by:

getMaxDurationNoProgress in interface StudySpec.StudyStoppingConfigOrBuilder

Returns:

The maxDurationNoProgress.

setMaxDurationNoProgress

public StudySpec.StudyStoppingConfig.Builder setMaxDurationNoProgress(com.google.protobuf.Duration value)

 If the objective value has not improved for this much time, stop the
 study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Duration max_duration_no_progress = 7;

setMaxDurationNoProgress

public StudySpec.StudyStoppingConfig.Builder setMaxDurationNoProgress(com.google.protobuf.Duration.Builder builderForValue)

 If the objective value has not improved for this much time, stop the
 study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Duration max_duration_no_progress = 7;

mergeMaxDurationNoProgress

public StudySpec.StudyStoppingConfig.Builder mergeMaxDurationNoProgress(com.google.protobuf.Duration value)

 If the objective value has not improved for this much time, stop the
 study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Duration max_duration_no_progress = 7;

clearMaxDurationNoProgress

public StudySpec.StudyStoppingConfig.Builder clearMaxDurationNoProgress()

 If the objective value has not improved for this much time, stop the
 study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Duration max_duration_no_progress = 7;

getMaxDurationNoProgressBuilder

public com.google.protobuf.Duration.Builder getMaxDurationNoProgressBuilder()

 If the objective value has not improved for this much time, stop the
 study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Duration max_duration_no_progress = 7;

getMaxDurationNoProgressOrBuilder

public com.google.protobuf.DurationOrBuilder getMaxDurationNoProgressOrBuilder()

 If the objective value has not improved for this much time, stop the
 study.

 WARNING: Effective only for single-objective studies.
 

.google.protobuf.Duration max_duration_no_progress = 7;

Specified by:

getMaxDurationNoProgressOrBuilder in interface StudySpec.StudyStoppingConfigOrBuilder

setUnknownFields

public final StudySpec.StudyStoppingConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>

mergeUnknownFields

public final StudySpec.StudyStoppingConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StudySpec.StudyStoppingConfig.Builder>