StudySpec (proto-google-cloud-aiplatform-v1 3.63.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.aiplatform.v1.StudySpec

All Implemented Interfaces:

StudySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class StudySpec
extends com.google.protobuf.GeneratedMessageV3
implements StudySpecOrBuilder
```
```
 Represents specification of a Study.
 
```
Protobuf type google.cloud.aiplatform.v1.StudySpec
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StudySpec.Algorithm` The available search algorithms for the Study.
`static class`	`StudySpec.AutomatedStoppingSpecCase`
`static class`	`StudySpec.Builder` Represents specification of a Study.
`static class`	`StudySpec.ConvexAutomatedStoppingSpec` Configuration for ConvexAutomatedStoppingSpec.
`static interface`	`StudySpec.ConvexAutomatedStoppingSpecOrBuilder`
`static class`	`StudySpec.DecayCurveAutomatedStoppingSpec` The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial.
`static interface`	`StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder`
`static class`	`StudySpec.MeasurementSelectionType` This indicates which measurement to use if/when the service automatically selects the final measurement from previously reported intermediate measurements.
`static class`	`StudySpec.MedianAutomatedStoppingSpec` The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement.
`static interface`	`StudySpec.MedianAutomatedStoppingSpecOrBuilder`
`static class`	`StudySpec.MetricSpec` Represents a metric to optimize.
`static interface`	`StudySpec.MetricSpecOrBuilder`
`static class`	`StudySpec.ObservationNoise` Describes the noise level of the repeated observations.
`static class`	`StudySpec.ParameterSpec` Represents a single parameter to optimize.
`static interface`	`StudySpec.ParameterSpecOrBuilder`
`static class`	`StudySpec.StudyStoppingConfig` The configuration (stopping conditions) for automated stopping of a Study.
`static interface`	`StudySpec.StudyStoppingConfigOrBuilder`

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`	`ALGORITHM_FIELD_NUMBER`
`static int`	`CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER`
`static int`	`DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER`
`static int`	`MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER`
`static int`	`MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER`
`static int`	`METRICS_FIELD_NUMBER`
`static int`	`OBSERVATION_NOISE_FIELD_NUMBER`
`static int`	`PARAMETERS_FIELD_NUMBER`
`static int`	`STUDY_STOPPING_CONFIG_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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`StudySpec.Algorithm`	`getAlgorithm()` The search algorithm specified for the Study.
`int`	`getAlgorithmValue()` The search algorithm specified for the Study.
`StudySpec.AutomatedStoppingSpecCase`	`getAutomatedStoppingSpecCase()`
`StudySpec.ConvexAutomatedStoppingSpec`	`getConvexAutomatedStoppingSpec()` The automated early stopping spec using convex stopping rule.
`StudySpec.ConvexAutomatedStoppingSpecOrBuilder`	`getConvexAutomatedStoppingSpecOrBuilder()` The automated early stopping spec using convex stopping rule.
`StudySpec.DecayCurveAutomatedStoppingSpec`	`getDecayCurveStoppingSpec()` The automated early stopping spec using decay curve rule.
`StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder`	`getDecayCurveStoppingSpecOrBuilder()` The automated early stopping spec using decay curve rule.
`static StudySpec`	`getDefaultInstance()`
`StudySpec`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`StudySpec.MeasurementSelectionType`	`getMeasurementSelectionType()` Describe which measurement selection type will be used `.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;`
`int`	`getMeasurementSelectionTypeValue()` Describe which measurement selection type will be used `.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;`
`StudySpec.MedianAutomatedStoppingSpec`	`getMedianAutomatedStoppingSpec()` The automated early stopping spec using median rule.
`StudySpec.MedianAutomatedStoppingSpecOrBuilder`	`getMedianAutomatedStoppingSpecOrBuilder()` The automated early stopping spec using median rule.
`StudySpec.MetricSpec`	`getMetrics(int index)` Required.
`int`	`getMetricsCount()` Required.
`List<StudySpec.MetricSpec>`	`getMetricsList()` Required.
`StudySpec.MetricSpecOrBuilder`	`getMetricsOrBuilder(int index)` Required.
`List<? extends StudySpec.MetricSpecOrBuilder>`	`getMetricsOrBuilderList()` Required.
`StudySpec.ObservationNoise`	`getObservationNoise()` The observation noise level of the study.
`int`	`getObservationNoiseValue()` The observation noise level of the study.
`StudySpec.ParameterSpec`	`getParameters(int index)` Required.
`int`	`getParametersCount()` Required.
`List<StudySpec.ParameterSpec>`	`getParametersList()` Required.
`StudySpec.ParameterSpecOrBuilder`	`getParametersOrBuilder(int index)` Required.
`List<? extends StudySpec.ParameterSpecOrBuilder>`	`getParametersOrBuilderList()` Required.
`com.google.protobuf.Parser<StudySpec>`	`getParserForType()`
`int`	`getSerializedSize()`
`StudySpec.StudyStoppingConfig`	`getStudyStoppingConfig()` Conditions for automated stopping of a Study.
`StudySpec.StudyStoppingConfigOrBuilder`	`getStudyStoppingConfigOrBuilder()` Conditions for automated stopping of a Study.
`boolean`	`hasConvexAutomatedStoppingSpec()` The automated early stopping spec using convex stopping rule.
`boolean`	`hasDecayCurveStoppingSpec()` The automated early stopping spec using decay curve rule.
`int`	`hashCode()`
`boolean`	`hasMedianAutomatedStoppingSpec()` The automated early stopping spec using median rule.
`boolean`	`hasStudyStoppingConfig()` Conditions for automated stopping of a Study.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static StudySpec.Builder`	`newBuilder()`
`static StudySpec.Builder`	`newBuilder(StudySpec prototype)`
`StudySpec.Builder`	`newBuilderForType()`
`protected StudySpec.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static StudySpec`	`parseDelimitedFrom(InputStream input)`
`static StudySpec`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StudySpec`	`parseFrom(byte[] data)`
`static StudySpec`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StudySpec`	`parseFrom(ByteBuffer data)`
`static StudySpec`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StudySpec`	`parseFrom(com.google.protobuf.ByteString data)`
`static StudySpec`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StudySpec`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static StudySpec`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static StudySpec`	`parseFrom(InputStream input)`
`static StudySpec`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<StudySpec>`	`parser()`
`StudySpec.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, internalGetMapFieldReflection, 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
  - DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER
```
public static final int DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
```
public static final int MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
```
public static final int CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - METRICS_FIELD_NUMBER
```
public static final int METRICS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - PARAMETERS_FIELD_NUMBER
```
public static final int PARAMETERS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - ALGORITHM_FIELD_NUMBER
```
public static final int ALGORITHM_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - OBSERVATION_NOISE_FIELD_NUMBER
```
public static final int OBSERVATION_NOISE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER
```
public static final int MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - STUDY_STOPPING_CONFIG_FIELD_NUMBER
```
public static final int STUDY_STOPPING_CONFIG_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()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
  - getAutomatedStoppingSpecCase
```
public StudySpec.AutomatedStoppingSpecCase getAutomatedStoppingSpecCase()
```
    Specified by:
    
    getAutomatedStoppingSpecCase in interface StudySpecOrBuilder
  - hasDecayCurveStoppingSpec
```
public boolean hasDecayCurveStoppingSpec()
```
```
 The automated early stopping spec using decay curve rule.
 
```
    .google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
    Specified by:
    
    hasDecayCurveStoppingSpec in interface StudySpecOrBuilder
    
    Returns:
    
    Whether the decayCurveStoppingSpec field is set.
  - getDecayCurveStoppingSpec
```
public StudySpec.DecayCurveAutomatedStoppingSpec getDecayCurveStoppingSpec()
```
```
 The automated early stopping spec using decay curve rule.
 
```
    .google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
    Specified by:
    
    getDecayCurveStoppingSpec in interface StudySpecOrBuilder
    
    Returns:
    
    The decayCurveStoppingSpec.
  - getDecayCurveStoppingSpecOrBuilder
```
public StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder getDecayCurveStoppingSpecOrBuilder()
```
```
 The automated early stopping spec using decay curve rule.
 
```
    .google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;
    Specified by:
    
    getDecayCurveStoppingSpecOrBuilder in interface StudySpecOrBuilder
  - hasMedianAutomatedStoppingSpec
```
public boolean hasMedianAutomatedStoppingSpec()
```
```
 The automated early stopping spec using median rule.
 
```
    .google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
    Specified by:
    
    hasMedianAutomatedStoppingSpec in interface StudySpecOrBuilder
    
    Returns:
    
    Whether the medianAutomatedStoppingSpec field is set.
  - getMedianAutomatedStoppingSpec
```
public StudySpec.MedianAutomatedStoppingSpec getMedianAutomatedStoppingSpec()
```
```
 The automated early stopping spec using median rule.
 
```
    .google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
    Specified by:
    
    getMedianAutomatedStoppingSpec in interface StudySpecOrBuilder
    
    Returns:
    
    The medianAutomatedStoppingSpec.
  - getMedianAutomatedStoppingSpecOrBuilder
```
public StudySpec.MedianAutomatedStoppingSpecOrBuilder getMedianAutomatedStoppingSpecOrBuilder()
```
```
 The automated early stopping spec using median rule.
 
```
    .google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;
    Specified by:
    
    getMedianAutomatedStoppingSpecOrBuilder in interface StudySpecOrBuilder
  - hasConvexAutomatedStoppingSpec
```
public boolean hasConvexAutomatedStoppingSpec()
```
```
 The automated early stopping spec using convex stopping rule.
 
```
    .google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
    Specified by:
    
    hasConvexAutomatedStoppingSpec in interface StudySpecOrBuilder
    
    Returns:
    
    Whether the convexAutomatedStoppingSpec field is set.
  - getConvexAutomatedStoppingSpec
```
public StudySpec.ConvexAutomatedStoppingSpec getConvexAutomatedStoppingSpec()
```
```
 The automated early stopping spec using convex stopping rule.
 
```
    .google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
    Specified by:
    
    getConvexAutomatedStoppingSpec in interface StudySpecOrBuilder
    
    Returns:
    
    The convexAutomatedStoppingSpec.
  - getConvexAutomatedStoppingSpecOrBuilder
```
public StudySpec.ConvexAutomatedStoppingSpecOrBuilder getConvexAutomatedStoppingSpecOrBuilder()
```
```
 The automated early stopping spec using convex stopping rule.
 
```
    .google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;
    Specified by:
    
    getConvexAutomatedStoppingSpecOrBuilder in interface StudySpecOrBuilder
  - getMetricsList
```
public List<StudySpec.MetricSpec> getMetricsList()
```
```
 Required. Metric specs for the Study.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getMetricsList in interface StudySpecOrBuilder
  - getMetricsOrBuilderList
```
public List<? extends StudySpec.MetricSpecOrBuilder> getMetricsOrBuilderList()
```
```
 Required. Metric specs for the Study.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getMetricsOrBuilderList in interface StudySpecOrBuilder
  - getMetricsCount
```
public int getMetricsCount()
```
```
 Required. Metric specs for the Study.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getMetricsCount in interface StudySpecOrBuilder
  - getMetrics
```
public StudySpec.MetricSpec getMetrics(int index)
```
```
 Required. Metric specs for the Study.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getMetrics in interface StudySpecOrBuilder
  - getMetricsOrBuilder
```
public StudySpec.MetricSpecOrBuilder getMetricsOrBuilder(int index)
```
```
 Required. Metric specs for the Study.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getMetricsOrBuilder in interface StudySpecOrBuilder
  - getParametersList
```
public List<StudySpec.ParameterSpec> getParametersList()
```
```
 Required. The set of parameters to tune.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getParametersList in interface StudySpecOrBuilder
  - getParametersOrBuilderList
```
public List<? extends StudySpec.ParameterSpecOrBuilder> getParametersOrBuilderList()
```
```
 Required. The set of parameters to tune.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getParametersOrBuilderList in interface StudySpecOrBuilder
  - getParametersCount
```
public int getParametersCount()
```
```
 Required. The set of parameters to tune.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getParametersCount in interface StudySpecOrBuilder
  - getParameters
```
public StudySpec.ParameterSpec getParameters(int index)
```
```
 Required. The set of parameters to tune.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getParameters in interface StudySpecOrBuilder
  - getParametersOrBuilder
```
public StudySpec.ParameterSpecOrBuilder getParametersOrBuilder(int index)
```
```
 Required. The set of parameters to tune.
 
```
    repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getParametersOrBuilder in interface StudySpecOrBuilder
  - getAlgorithmValue
```
public int getAlgorithmValue()
```
```
 The search algorithm specified for the Study.
 
```
    .google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
    Specified by:
    
    getAlgorithmValue in interface StudySpecOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for algorithm.
  - getAlgorithm
```
public StudySpec.Algorithm getAlgorithm()
```
```
 The search algorithm specified for the Study.
 
```
    .google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;
    Specified by:
    
    getAlgorithm in interface StudySpecOrBuilder
    
    Returns:
    
    The algorithm.
  - getObservationNoiseValue
```
public int getObservationNoiseValue()
```
```
 The observation noise level of the study.
 Currently only supported by the Vertex AI Vizier service. Not supported by
 HyperparameterTuningJob or TrainingPipeline.
 
```
    .google.cloud.aiplatform.v1.StudySpec.ObservationNoise observation_noise = 6;
    Specified by:
    
    getObservationNoiseValue in interface StudySpecOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for observationNoise.
  - getObservationNoise
```
public StudySpec.ObservationNoise getObservationNoise()
```
```
 The observation noise level of the study.
 Currently only supported by the Vertex AI Vizier service. Not supported by
 HyperparameterTuningJob or TrainingPipeline.
 
```
    .google.cloud.aiplatform.v1.StudySpec.ObservationNoise observation_noise = 6;
    Specified by:
    
    getObservationNoise in interface StudySpecOrBuilder
    
    Returns:
    
    The observationNoise.
  - getMeasurementSelectionTypeValue
```
public int getMeasurementSelectionTypeValue()
```
```
 Describe which measurement selection type will be used
 
```
    .google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
    Specified by:
    
    getMeasurementSelectionTypeValue in interface StudySpecOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for measurementSelectionType.
  - getMeasurementSelectionType
```
public StudySpec.MeasurementSelectionType getMeasurementSelectionType()
```
```
 Describe which measurement selection type will be used
 
```
    .google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;
    Specified by:
    
    getMeasurementSelectionType in interface StudySpecOrBuilder
    
    Returns:
    
    The measurementSelectionType.
  - hasStudyStoppingConfig
```
public boolean hasStudyStoppingConfig()
```
```
 Conditions for automated stopping of a Study. Enable automated stopping by
 configuring at least one condition.
 
```
    optional .google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig study_stopping_config = 11;
    Specified by:
    
    hasStudyStoppingConfig in interface StudySpecOrBuilder
    
    Returns:
    
    Whether the studyStoppingConfig field is set.
  - getStudyStoppingConfig
```
public StudySpec.StudyStoppingConfig getStudyStoppingConfig()
```
```
 Conditions for automated stopping of a Study. Enable automated stopping by
 configuring at least one condition.
 
```
    optional .google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig study_stopping_config = 11;
    Specified by:
    
    getStudyStoppingConfig in interface StudySpecOrBuilder
    
    Returns:
    
    The studyStoppingConfig.
  - getStudyStoppingConfigOrBuilder
```
public StudySpec.StudyStoppingConfigOrBuilder getStudyStoppingConfigOrBuilder()
```
```
 Conditions for automated stopping of a Study. Enable automated stopping by
 configuring at least one condition.
 
```
    optional .google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig study_stopping_config = 11;
    Specified by:
    
    getStudyStoppingConfigOrBuilder in interface StudySpecOrBuilder
  - 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 StudySpec parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static StudySpec parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static StudySpec parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static StudySpec parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static StudySpec parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static StudySpec parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static StudySpec parseFrom(InputStream input)
                           throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static StudySpec parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static StudySpec parseDelimitedFrom(InputStream input)
                                    throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static StudySpec parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static StudySpec parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static StudySpec parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public StudySpec.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.MessageLite
  - newBuilder
```
public static StudySpec.Builder newBuilder()
```
  - newBuilder
```
public static StudySpec.Builder newBuilder(StudySpec prototype)
```
  - toBuilder
```
public StudySpec.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface com.google.protobuf.MessageLite
  - newBuilderForType
```
protected StudySpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    Specified by:
    
    newBuilderForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static StudySpec getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<StudySpec> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<StudySpec> 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 StudySpec getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class StudySpec

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER

MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

METRICS_FIELD_NUMBER

PARAMETERS_FIELD_NUMBER

ALGORITHM_FIELD_NUMBER

OBSERVATION_NOISE_FIELD_NUMBER

MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER

STUDY_STOPPING_CONFIG_FIELD_NUMBER

Method Detail

newInstance

getDescriptor

internalGetFieldAccessorTable

getAutomatedStoppingSpecCase

hasDecayCurveStoppingSpec

getDecayCurveStoppingSpec

getDecayCurveStoppingSpecOrBuilder

hasMedianAutomatedStoppingSpec

getMedianAutomatedStoppingSpec

getMedianAutomatedStoppingSpecOrBuilder

hasConvexAutomatedStoppingSpec

getConvexAutomatedStoppingSpec

getConvexAutomatedStoppingSpecOrBuilder

getMetricsList

getMetricsOrBuilderList

getMetricsCount

getMetrics

getMetricsOrBuilder

getParametersList

getParametersOrBuilderList

getParametersCount

getParameters

getParametersOrBuilder

getAlgorithmValue

getAlgorithm

getObservationNoiseValue

getObservationNoise

getMeasurementSelectionTypeValue

getMeasurementSelectionType

hasStudyStoppingConfig

getStudyStoppingConfig

getStudyStoppingConfigOrBuilder

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType