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)
boolean	hasDefaultHyperParameters() For responses, this returns true if the service returned a value for the DefaultHyperParameters property.
boolean	hasDefaultResourceConfig() For responses, this returns true if the service returned a value for the DefaultResourceConfig property.
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 final String name()

The name of the algorithm.

Returns:

The name of the algorithm.

algorithmArn

public final String algorithmArn()

The Amazon Resource Name (ARN) of the algorithm.

Returns:

The Amazon Resource Name (ARN) of the algorithm.

algorithmImage

public final AlgorithmImage algorithmImage()

The URI of the Docker container for the algorithm image.

Returns:

The URI of the Docker container for the algorithm image.

hasDefaultHyperParameters

public final boolean hasDefaultHyperParameters()

For responses, this returns true if the service returned a value for the DefaultHyperParameters 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.

defaultHyperParameters

public final Map<String,String> defaultHyperParameters()

Specifies the default hyperparameters.

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 hasDefaultHyperParameters() method.

Returns:

Specifies the default hyperparameters.

defaultHyperParameterRanges

public final 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).

hasDefaultResourceConfig

public final boolean hasDefaultResourceConfig()

For responses, this returns true if the service returned a value for the DefaultResourceConfig 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.

defaultResourceConfig

public final 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.

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 hasDefaultResourceConfig() method.

Returns:

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

trainingInputMode

public final String trainingInputMode()

The training input mode.

Returns:

The training input mode.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the role.

Returns:

The Amazon Resource Name (ARN) of the role.

creationDateTime

public final 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 final 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 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