Class StudySpec (3.20.0)

Version 3.20.0

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public final class StudySpec extends GeneratedMessageV3 implements StudySpecOrBuilder

Represents specification of a Study.

Protobuf type google.cloud.aiplatform.v1.StudySpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StudySpec

Implements

StudySpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALGORITHM_FIELD_NUMBER

public static final int ALGORITHM_FIELD_NUMBER

Field Value
Type	Description
int

CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

public static final int CONVEX_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER

public static final int DECAY_CURVE_STOPPING_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER

public static final int MEASUREMENT_SELECTION_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

public static final int MEDIAN_AUTOMATED_STOPPING_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER

Field Value
Type	Description
int

OBSERVATION_NOISE_FIELD_NUMBER

public static final int OBSERVATION_NOISE_FIELD_NUMBER

Field Value
Type	Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static StudySpec getDefaultInstance()

Returns
Type	Description
StudySpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static StudySpec.Builder newBuilder()

Returns
Type	Description
StudySpec.Builder

newBuilder(StudySpec prototype)

public static StudySpec.Builder newBuilder(StudySpec prototype)

Parameter
Name	Description
prototype	StudySpec

Returns
Type	Description
StudySpec.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
StudySpec

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StudySpec

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static StudySpec parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
StudySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StudySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
StudySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StudySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
StudySpec

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StudySpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static StudySpec parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
StudySpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StudySpec

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static StudySpec parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
StudySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StudySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<StudySpec> parser()

Returns
Type	Description
Parser<StudySpec>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAlgorithm()

public StudySpec.Algorithm getAlgorithm()

The search algorithm specified for the Study.

.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;

Returns
Type	Description
StudySpec.Algorithm	The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

The search algorithm specified for the Study.

.google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;

Returns
Type	Description
int	The enum numeric value on the wire for algorithm.

getAutomatedStoppingSpecCase()

public StudySpec.AutomatedStoppingSpecCase getAutomatedStoppingSpecCase()

Returns
Type	Description
StudySpec.AutomatedStoppingSpecCase

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;

Returns
Type	Description
StudySpec.ConvexAutomatedStoppingSpec	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;

Returns
Type	Description
StudySpec.ConvexAutomatedStoppingSpecOrBuilder

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;

Returns
Type	Description
StudySpec.DecayCurveAutomatedStoppingSpec	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;

Returns
Type	Description
StudySpec.DecayCurveAutomatedStoppingSpecOrBuilder

getDefaultInstanceForType()

public StudySpec getDefaultInstanceForType()

Returns
Type	Description
StudySpec

getMeasurementSelectionType()

public StudySpec.MeasurementSelectionType getMeasurementSelectionType()

Describe which measurement selection type will be used

.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;

Returns
Type	Description
StudySpec.MeasurementSelectionType	The measurementSelectionType.

getMeasurementSelectionTypeValue()

public int getMeasurementSelectionTypeValue()

Describe which measurement selection type will be used

.google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType measurement_selection_type = 7;

Returns
Type	Description
int	The enum numeric value on the wire for measurementSelectionType.

getMedianAutomatedStoppingSpec()

public StudySpec.MedianAutomatedStoppingSpec getMedianAutomatedStoppingSpec()

The automated early stopping spec using median rule.

.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Returns
Type	Description
StudySpec.MedianAutomatedStoppingSpec	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;

Returns
Type	Description
StudySpec.MedianAutomatedStoppingSpecOrBuilder

getMetrics(int index)

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

Parameter
Name	Description
index	int

Returns
Type	Description
StudySpec.MetricSpec

getMetricsCount()

public int getMetricsCount()

Required. Metric specs for the Study.

repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

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

Returns
Type	Description
List<MetricSpec>

getMetricsOrBuilder(int index)

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

Parameter
Name	Description
index	int

Returns
Type	Description
StudySpec.MetricSpecOrBuilder

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

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.StudySpec.MetricSpecOrBuilder>

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;

Returns
Type	Description
StudySpec.ObservationNoise	The observationNoise.

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;

Returns
Type	Description
int	The enum numeric value on the wire for observationNoise.

getParameters(int index)

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

Parameter
Name	Description
index	int

Returns
Type	Description
StudySpec.ParameterSpec

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

Returns
Type	Description
int

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

Returns
Type	Description
List<ParameterSpec>

getParametersOrBuilder(int index)

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

Parameter
Name	Description
index	int

Returns
Type	Description
StudySpec.ParameterSpecOrBuilder

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

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.StudySpec.ParameterSpecOrBuilder>

getParserForType()

public Parser<StudySpec> getParserForType()

Returns
Type	Description
Parser<StudySpec>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasConvexAutomatedStoppingSpec()

public boolean hasConvexAutomatedStoppingSpec()

The automated early stopping spec using convex stopping rule.

.google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

Returns
Type	Description
boolean	Whether the convexAutomatedStoppingSpec field is set.

hasDecayCurveStoppingSpec()

public boolean hasDecayCurveStoppingSpec()

The automated early stopping spec using decay curve rule.

.google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

Returns
Type	Description
boolean	Whether the decayCurveStoppingSpec field is set.

hasMedianAutomatedStoppingSpec()

public boolean hasMedianAutomatedStoppingSpec()

The automated early stopping spec using median rule.

.google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Returns
Type	Description
boolean	Whether the medianAutomatedStoppingSpec field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public StudySpec.Builder newBuilderForType()

Returns
Type	Description
StudySpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
StudySpec.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public StudySpec.Builder toBuilder()

Returns
Type	Description
StudySpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException