software.amazon.awssdk.services.personalize.model

Interface Algorithm.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Algorithm.Builder,Algorithm>, SdkBuilder<Algorithm.Builder,Algorithm>, SdkPojo

Enclosing class:

Algorithm

public static interface Algorithm.Builder
extends SdkPojo, CopyableBuilder<Algorithm.Builder,Algorithm>

Method Summary

Modifier and Type	Method and Description
Algorithm.Builder	algorithmArn(String algorithmArn) The Amazon Resource Name (ARN) of the algorithm.
Algorithm.Builder	algorithmImage(AlgorithmImage algorithmImage) The URI of the Docker container for the algorithm image.
default Algorithm.Builder	algorithmImage(Consumer<AlgorithmImage.Builder> algorithmImage) The URI of the Docker container for the algorithm image.
Algorithm.Builder	creationDateTime(Instant creationDateTime) The date and time (in Unix time) that the algorithm was created.
default Algorithm.Builder	defaultHyperParameterRanges(Consumer<DefaultHyperParameterRanges.Builder> defaultHyperParameterRanges) Specifies the default hyperparameters, their ranges, and whether they are tunable.
Algorithm.Builder	defaultHyperParameterRanges(DefaultHyperParameterRanges defaultHyperParameterRanges) Specifies the default hyperparameters, their ranges, and whether they are tunable.
Algorithm.Builder	defaultHyperParameters(Map<String,String> defaultHyperParameters) Specifies the default hyperparameters.
Algorithm.Builder	defaultResourceConfig(Map<String,String> defaultResourceConfig) Specifies the default maximum number of training jobs and parallel training jobs.
Algorithm.Builder	lastUpdatedDateTime(Instant lastUpdatedDateTime) The date and time (in Unix time) that the algorithm was last updated.
Algorithm.Builder	name(String name) The name of the algorithm.
Algorithm.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of the role.
Algorithm.Builder	trainingInputMode(String trainingInputMode) The training input mode.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

Algorithm.Builder name(String name)

The name of the algorithm.

Parameters:

name - The name of the algorithm.

Returns:

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

algorithmArn

Algorithm.Builder algorithmArn(String algorithmArn)

The Amazon Resource Name (ARN) of the algorithm.

Parameters:

algorithmArn - The Amazon Resource Name (ARN) of the algorithm.

Returns:

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

algorithmImage

Algorithm.Builder algorithmImage(AlgorithmImage algorithmImage)

The URI of the Docker container for the algorithm image.

Parameters:

algorithmImage - The URI of the Docker container for the algorithm image.

Returns:

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

algorithmImage

default Algorithm.Builder algorithmImage(Consumer<AlgorithmImage.Builder> algorithmImage)

The URI of the Docker container for the algorithm image.

This is a convenience method that creates an instance of the AlgorithmImage.Builder avoiding the need to create one manually via AlgorithmImage.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to algorithmImage(AlgorithmImage).

Parameters:

algorithmImage - a consumer that will call methods on AlgorithmImage.Builder

Returns:

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

See Also:

algorithmImage(AlgorithmImage)

defaultHyperParameters

Algorithm.Builder defaultHyperParameters(Map<String,String> defaultHyperParameters)

Specifies the default hyperparameters.

Parameters:

defaultHyperParameters - Specifies the default hyperparameters.

Returns:

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

defaultHyperParameterRanges

Algorithm.Builder defaultHyperParameterRanges(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).

Parameters:

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:

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

defaultHyperParameterRanges

default Algorithm.Builder defaultHyperParameterRanges(Consumer<DefaultHyperParameterRanges.Builder> defaultHyperParameterRanges)

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

This is a convenience method that creates an instance of the DefaultHyperParameterRanges.Builder avoiding the need to create one manually via DefaultHyperParameterRanges.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultHyperParameterRanges(DefaultHyperParameterRanges).

Parameters:

defaultHyperParameterRanges - a consumer that will call methods on DefaultHyperParameterRanges.Builder

Returns:

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

See Also:

defaultHyperParameterRanges(DefaultHyperParameterRanges)

defaultResourceConfig

Algorithm.Builder defaultResourceConfig(Map<String,String> defaultResourceConfig)

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

Parameters:

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

Returns:

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

trainingInputMode

Algorithm.Builder trainingInputMode(String trainingInputMode)

The training input mode.

Parameters:

trainingInputMode - The training input mode.

Returns:

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

roleArn

Algorithm.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the role.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the role.

Returns:

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

creationDateTime

Algorithm.Builder creationDateTime(Instant creationDateTime)

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

Parameters:

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

Returns:

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

lastUpdatedDateTime

Algorithm.Builder lastUpdatedDateTime(Instant lastUpdatedDateTime)

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

Parameters:

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

Returns:

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