software.amazon.awssdk.services.forecast.model

Class IntegerParameterRange

java.lang.Object

software.amazon.awssdk.services.forecast.model.IntegerParameterRange

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IntegerParameterRange.Builder,IntegerParameterRange>

@Generated(value="software.amazon.awssdk:codegen")
public final class IntegerParameterRange
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IntegerParameterRange.Builder,IntegerParameterRange>

Specifies an integer hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IntegerParameterRange.Builder

Method Summary

Modifier and Type	Method and Description
static IntegerParameterRange.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxValue() The maximum tunable value of the hyperparameter.
Integer	minValue() The minimum tunable value of the hyperparameter.
String	name() The name of the hyperparameter to tune.
ScalingType	scalingType() The scale that hyperparameter tuning uses to search the hyperparameter range.
String	scalingTypeAsString() The scale that hyperparameter tuning uses to search the hyperparameter range.
List<SdkField<?>>	sdkFields()
static Class<? extends IntegerParameterRange.Builder>	serializableBuilderClass()
IntegerParameterRange.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the hyperparameter to tune.

Returns:

The name of the hyperparameter to tune.

maxValue

public final Integer maxValue()

The maximum tunable value of the hyperparameter.

Returns:

The maximum tunable value of the hyperparameter.

minValue

public final Integer minValue()

The minimum tunable value of the hyperparameter.

Returns:

The minimum tunable value of the hyperparameter.

scalingType

public final ScalingType scalingType()

The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

Auto

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have values greater than 0.

ReverseLogarithmic

Not supported for IntegerParameterRange.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

If the service returns an enum value that is not available in the current SDK version, scalingType will return ScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingTypeAsString().

Returns:

The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

Auto

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have values greater than 0.

ReverseLogarithmic

Not supported for IntegerParameterRange.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

See Also:

ScalingType

scalingTypeAsString

public final String scalingTypeAsString()

The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

Auto

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have values greater than 0.

ReverseLogarithmic

Not supported for IntegerParameterRange.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

If the service returns an enum value that is not available in the current SDK version, scalingType will return ScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingTypeAsString().

Returns:

The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

Auto

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have values greater than 0.

ReverseLogarithmic

Not supported for IntegerParameterRange.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

See Also:

ScalingType

toBuilder

public IntegerParameterRange.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IntegerParameterRange.Builder,IntegerParameterRange>

builder

public static IntegerParameterRange.Builder builder()

serializableBuilderClass

public static Class<? extends IntegerParameterRange.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo