Package software.amazon.awssdk.services.personalize.model

Class DefaultCategoricalHyperParameterRange

java.lang.Object

software.amazon.awssdk.services.personalize.model.DefaultCategoricalHyperParameterRange

All Implemented Interfaces:

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

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

Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefaultCategoricalHyperParameterRange.Builder

Method Summary

Modifier and Type	Method	Description
static DefaultCategoricalHyperParameterRange.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
Boolean	isTunable()	Whether the hyperparameter is tunable.
String	name()	The name of the hyperparameter.
List<SdkField<?>>	sdkFields()
static Class<? extends DefaultCategoricalHyperParameterRange.Builder>	serializableBuilderClass()
DefaultCategoricalHyperParameterRange.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	A list of the categories for the hyperparameter.

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.

Returns:

The name of the hyperparameter.

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

values

public final List<String> values()

A list of the categories for the hyperparameter.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

Returns:

A list of the categories for the hyperparameter.

isTunable

public final Boolean isTunable()

Whether the hyperparameter is tunable.

Returns:

Whether the hyperparameter is tunable.

toBuilder

public DefaultCategoricalHyperParameterRange.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultCategoricalHyperParameterRange.Builder,DefaultCategoricalHyperParameterRange>

builder

public static DefaultCategoricalHyperParameterRange.Builder builder()

serializableBuilderClass

public static Class<? extends DefaultCategoricalHyperParameterRange.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