software.amazon.awssdk.services.personalize.model

Class Algorithm

java.lang.Object

software.amazon.awssdk.services.personalize.model.Algorithm

All Implemented Interfaces:

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

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

Describes a custom algorithm.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Algorithm.Builder

Method Summary

Modifier and Type	Method and Description
String	algorithmArn() The Amazon Resource Name (ARN) of the algorithm.
AlgorithmImage	algorithmImage() The URI of the Docker container for the algorithm image.
static Algorithm.Builder	builder()
Instant	creationDateTime() The date and time (in Unix time) that the algorithm was created.
DefaultHyperParameterRanges	defaultHyperParameterRanges() Specifies the default hyperparameters, their ranges, and whether they are tunable.
Map<String,String>	defaultHyperParameters() Specifies the default hyperparameters.
Map<String,String>	defaultResourceConfig() Specifies the default maximum number of training jobs and parallel training jobs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedDateTime() The date and time (in Unix time) that the algorithm was last updated.
String	name() The name of the algorithm.
String	roleArn() The Amazon Resource Name (ARN) of the role.
List<SdkField<?>>	sdkFields()
static Class<? extends Algorithm.Builder>	serializableBuilderClass()
Algorithm.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	trainingInputMode() The training input mode.

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 String name()

The name of the algorithm.

Returns:

The name of the algorithm.

algorithmArn

public String algorithmArn()

The Amazon Resource Name (ARN) of the algorithm.

Returns:

The Amazon Resource Name (ARN) of the algorithm.

algorithmImage

public AlgorithmImage algorithmImage()

The URI of the Docker container for the algorithm image.

Returns:

The URI of the Docker container for the algorithm image.

defaultHyperParameters

public Map<String,String> defaultHyperParameters()

Specifies the default hyperparameters.

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

Returns:

Specifies the default hyperparameters.

defaultHyperParameterRanges

public DefaultHyperParameterRanges defaultHyperParameterRanges()

Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

Returns:

Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

defaultResourceConfig

public Map<String,String> defaultResourceConfig()

Specifies the default maximum number of training jobs and parallel training jobs.

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

Returns:

Specifies the default maximum number of training jobs and parallel training jobs.

trainingInputMode

public String trainingInputMode()

The training input mode.

Returns:

The training input mode.

roleArn

public String roleArn()

The Amazon Resource Name (ARN) of the role.

Returns:

The Amazon Resource Name (ARN) of the role.

creationDateTime

public Instant creationDateTime()

The date and time (in Unix time) that the algorithm was created.

Returns:

The date and time (in Unix time) that the algorithm was created.

lastUpdatedDateTime

public Instant lastUpdatedDateTime()

The date and time (in Unix time) that the algorithm was last updated.

Returns:

The date and time (in Unix time) that the algorithm was last updated.

toBuilder

public Algorithm.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Algorithm.Builder,Algorithm>

builder

public static Algorithm.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo