com.amazonaws.services.personalize.model

Class DefaultCategoricalHyperParameterRange

java.lang.Object

com.amazonaws.services.personalize.model.DefaultCategoricalHyperParameterRange

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DefaultCategoricalHyperParameterRange
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultCategoricalHyperParameterRange()

Method Summary

Modifier and Type	Method and Description
DefaultCategoricalHyperParameterRange	clone()
boolean	equals(Object obj)
Boolean	getIsTunable() Whether the hyperparameter is tunable.
String	getName() The name of the hyperparameter.
List<String>	getValues() A list of the categories for the hyperparameter.
int	hashCode()
Boolean	isTunable() Whether the hyperparameter is tunable.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setIsTunable(Boolean isTunable) Whether the hyperparameter is tunable.
void	setName(String name) The name of the hyperparameter.
void	setValues(Collection<String> values) A list of the categories for the hyperparameter.
String	toString() Returns a string representation of this object.
DefaultCategoricalHyperParameterRange	withIsTunable(Boolean isTunable) Whether the hyperparameter is tunable.
DefaultCategoricalHyperParameterRange	withName(String name) The name of the hyperparameter.
DefaultCategoricalHyperParameterRange	withValues(Collection<String> values) A list of the categories for the hyperparameter.
DefaultCategoricalHyperParameterRange	withValues(String... values) A list of the categories for the hyperparameter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultCategoricalHyperParameterRange

public DefaultCategoricalHyperParameterRange()

Method Detail

setName

public void setName(String name)

The name of the hyperparameter.

Parameters:

name - The name of the hyperparameter.

getName

public String getName()

The name of the hyperparameter.

Returns:

The name of the hyperparameter.

withName

public DefaultCategoricalHyperParameterRange withName(String name)

The name of the hyperparameter.

Parameters:

name - The name of the hyperparameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

getValues

public List<String> getValues()

A list of the categories for the hyperparameter.

Returns:

A list of the categories for the hyperparameter.

setValues

public void setValues(Collection<String> values)

A list of the categories for the hyperparameter.

Parameters:

values - A list of the categories for the hyperparameter.

withValues

public DefaultCategoricalHyperParameterRange withValues(String... values)

A list of the categories for the hyperparameter.

NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.

Parameters:

values - A list of the categories for the hyperparameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

withValues

public DefaultCategoricalHyperParameterRange withValues(Collection<String> values)

A list of the categories for the hyperparameter.

Parameters:

values - A list of the categories for the hyperparameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIsTunable

public void setIsTunable(Boolean isTunable)

Whether the hyperparameter is tunable.

Parameters:

isTunable - Whether the hyperparameter is tunable.

getIsTunable

public Boolean getIsTunable()

Whether the hyperparameter is tunable.

Returns:

Whether the hyperparameter is tunable.

withIsTunable

public DefaultCategoricalHyperParameterRange withIsTunable(Boolean isTunable)

Whether the hyperparameter is tunable.

Parameters:

isTunable - Whether the hyperparameter is tunable.

Returns:

Returns a reference to this object so that method calls can be chained together.

isTunable

public Boolean isTunable()

Whether the hyperparameter is tunable.

Returns:

Whether the hyperparameter is tunable.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DefaultCategoricalHyperParameterRange clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.