software.amazon.awssdk.services.sagemaker.model

Interface DescribeHyperParameterTuningJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeHyperParameterTuningJobResponse

public static interface DescribeHyperParameterTuningJobResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>

Method Summary

Modifier and Type	Method and Description
default DescribeHyperParameterTuningJobResponse.Builder	bestTrainingJob(Consumer<HyperParameterTrainingJobSummary.Builder> bestTrainingJob) A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
DescribeHyperParameterTuningJobResponse.Builder	bestTrainingJob(HyperParameterTrainingJobSummary bestTrainingJob) A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
DescribeHyperParameterTuningJobResponse.Builder	creationTime(Instant creationTime) The date and time that the tuning job started.
DescribeHyperParameterTuningJobResponse.Builder	failureReason(String failureReason) If the tuning job failed, the reason it failed.
DescribeHyperParameterTuningJobResponse.Builder	hyperParameterTuningEndTime(Instant hyperParameterTuningEndTime) The date and time that the tuning job ended.
DescribeHyperParameterTuningJobResponse.Builder	hyperParameterTuningJobArn(String hyperParameterTuningJobArn) The Amazon Resource Name (ARN) of the tuning job.
default DescribeHyperParameterTuningJobResponse.Builder	hyperParameterTuningJobConfig(Consumer<HyperParameterTuningJobConfig.Builder> hyperParameterTuningJobConfig) The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
DescribeHyperParameterTuningJobResponse.Builder	hyperParameterTuningJobConfig(HyperParameterTuningJobConfig hyperParameterTuningJobConfig) The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
DescribeHyperParameterTuningJobResponse.Builder	hyperParameterTuningJobName(String hyperParameterTuningJobName) The name of the tuning job.
DescribeHyperParameterTuningJobResponse.Builder	hyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus) The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
DescribeHyperParameterTuningJobResponse.Builder	hyperParameterTuningJobStatus(String hyperParameterTuningJobStatus) The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
DescribeHyperParameterTuningJobResponse.Builder	lastModifiedTime(Instant lastModifiedTime) The date and time that the status of the tuning job was modified.
default DescribeHyperParameterTuningJobResponse.Builder	objectiveStatusCounters(Consumer<ObjectiveStatusCounters.Builder> objectiveStatusCounters) The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
DescribeHyperParameterTuningJobResponse.Builder	objectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters) The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
default DescribeHyperParameterTuningJobResponse.Builder	overallBestTrainingJob(Consumer<HyperParameterTrainingJobSummary.Builder> overallBestTrainingJob) If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
DescribeHyperParameterTuningJobResponse.Builder	overallBestTrainingJob(HyperParameterTrainingJobSummary overallBestTrainingJob) If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
default DescribeHyperParameterTuningJobResponse.Builder	trainingJobDefinition(Consumer<HyperParameterTrainingJobDefinition.Builder> trainingJobDefinition) The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
DescribeHyperParameterTuningJobResponse.Builder	trainingJobDefinition(HyperParameterTrainingJobDefinition trainingJobDefinition) The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
DescribeHyperParameterTuningJobResponse.Builder	trainingJobDefinitions(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions) A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
DescribeHyperParameterTuningJobResponse.Builder	trainingJobDefinitions(Consumer<HyperParameterTrainingJobDefinition.Builder>... trainingJobDefinitions) A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
DescribeHyperParameterTuningJobResponse.Builder	trainingJobDefinitions(HyperParameterTrainingJobDefinition... trainingJobDefinitions) A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
default DescribeHyperParameterTuningJobResponse.Builder	trainingJobStatusCounters(Consumer<TrainingJobStatusCounters.Builder> trainingJobStatusCounters) The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
DescribeHyperParameterTuningJobResponse.Builder	trainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters) The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
default DescribeHyperParameterTuningJobResponse.Builder	warmStartConfig(Consumer<HyperParameterTuningJobWarmStartConfig.Builder> warmStartConfig) The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point.
DescribeHyperParameterTuningJobResponse.Builder	warmStartConfig(HyperParameterTuningJobWarmStartConfig warmStartConfig) The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

hyperParameterTuningJobName

DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobName(String hyperParameterTuningJobName)

The name of the tuning job.

Parameters:

hyperParameterTuningJobName - The name of the tuning job.

Returns:

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

hyperParameterTuningJobArn

DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobArn(String hyperParameterTuningJobArn)

The Amazon Resource Name (ARN) of the tuning job.

Parameters:

hyperParameterTuningJobArn - The Amazon Resource Name (ARN) of the tuning job.

Returns:

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

hyperParameterTuningJobConfig

DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobConfig(HyperParameterTuningJobConfig hyperParameterTuningJobConfig)

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

Parameters:

hyperParameterTuningJobConfig - The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

Returns:

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

hyperParameterTuningJobConfig

default DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobConfig(Consumer<HyperParameterTuningJobConfig.Builder> hyperParameterTuningJobConfig)

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

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

Parameters:

hyperParameterTuningJobConfig - a consumer that will call methods on HyperParameterTuningJobConfig.Builder

Returns:

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

See Also:

hyperParameterTuningJobConfig(HyperParameterTuningJobConfig)

trainingJobDefinition

DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinition(HyperParameterTrainingJobDefinition trainingJobDefinition)

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

Parameters:

trainingJobDefinition - The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

Returns:

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

trainingJobDefinition

default DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinition(Consumer<HyperParameterTrainingJobDefinition.Builder> trainingJobDefinition)

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

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

Parameters:

trainingJobDefinition - a consumer that will call methods on HyperParameterTrainingJobDefinition.Builder

Returns:

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

See Also:

trainingJobDefinition(HyperParameterTrainingJobDefinition)

trainingJobDefinitions

DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinitions(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions)

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

Parameters:

trainingJobDefinitions - A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

Returns:

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

trainingJobDefinitions

DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinitions(HyperParameterTrainingJobDefinition... trainingJobDefinitions)

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

Parameters:

trainingJobDefinitions - A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

Returns:

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

trainingJobDefinitions

DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinitions(Consumer<HyperParameterTrainingJobDefinition.Builder>... trainingJobDefinitions)

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

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

Parameters:

trainingJobDefinitions - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#trainingJobDefinitions(List)

hyperParameterTuningJobStatus

DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

Parameters:

hyperParameterTuningJobStatus - The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

Returns:

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

See Also:

HyperParameterTuningJobStatus, HyperParameterTuningJobStatus

hyperParameterTuningJobStatus

DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus)

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

Parameters:

hyperParameterTuningJobStatus - The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

Returns:

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

See Also:

HyperParameterTuningJobStatus, HyperParameterTuningJobStatus

creationTime

DescribeHyperParameterTuningJobResponse.Builder creationTime(Instant creationTime)

The date and time that the tuning job started.

Parameters:

creationTime - The date and time that the tuning job started.

Returns:

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

hyperParameterTuningEndTime

DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningEndTime(Instant hyperParameterTuningEndTime)

The date and time that the tuning job ended.

Parameters:

hyperParameterTuningEndTime - The date and time that the tuning job ended.

Returns:

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

lastModifiedTime

DescribeHyperParameterTuningJobResponse.Builder lastModifiedTime(Instant lastModifiedTime)

The date and time that the status of the tuning job was modified.

Parameters:

lastModifiedTime - The date and time that the status of the tuning job was modified.

Returns:

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

trainingJobStatusCounters

DescribeHyperParameterTuningJobResponse.Builder trainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

Parameters:

trainingJobStatusCounters - The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

Returns:

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

trainingJobStatusCounters

default DescribeHyperParameterTuningJobResponse.Builder trainingJobStatusCounters(Consumer<TrainingJobStatusCounters.Builder> trainingJobStatusCounters)

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

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

Parameters:

trainingJobStatusCounters - a consumer that will call methods on TrainingJobStatusCounters.Builder

Returns:

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

See Also:

trainingJobStatusCounters(TrainingJobStatusCounters)

objectiveStatusCounters

DescribeHyperParameterTuningJobResponse.Builder objectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

Parameters:

objectiveStatusCounters - The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

Returns:

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

objectiveStatusCounters

default DescribeHyperParameterTuningJobResponse.Builder objectiveStatusCounters(Consumer<ObjectiveStatusCounters.Builder> objectiveStatusCounters)

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

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

Parameters:

objectiveStatusCounters - a consumer that will call methods on ObjectiveStatusCounters.Builder

Returns:

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

See Also:

objectiveStatusCounters(ObjectiveStatusCounters)

bestTrainingJob

DescribeHyperParameterTuningJobResponse.Builder bestTrainingJob(HyperParameterTrainingJobSummary bestTrainingJob)

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

Parameters:

bestTrainingJob - A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

Returns:

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

bestTrainingJob

default DescribeHyperParameterTuningJobResponse.Builder bestTrainingJob(Consumer<HyperParameterTrainingJobSummary.Builder> bestTrainingJob)

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

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

Parameters:

bestTrainingJob - a consumer that will call methods on HyperParameterTrainingJobSummary.Builder

Returns:

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

See Also:

bestTrainingJob(HyperParameterTrainingJobSummary)

overallBestTrainingJob

DescribeHyperParameterTuningJobResponse.Builder overallBestTrainingJob(HyperParameterTrainingJobSummary overallBestTrainingJob)

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

Parameters:

overallBestTrainingJob - If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

Returns:

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

overallBestTrainingJob

default DescribeHyperParameterTuningJobResponse.Builder overallBestTrainingJob(Consumer<HyperParameterTrainingJobSummary.Builder> overallBestTrainingJob)

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

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

Parameters:

overallBestTrainingJob - a consumer that will call methods on HyperParameterTrainingJobSummary.Builder

Returns:

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

See Also:

overallBestTrainingJob(HyperParameterTrainingJobSummary)

warmStartConfig

DescribeHyperParameterTuningJobResponse.Builder warmStartConfig(HyperParameterTuningJobWarmStartConfig warmStartConfig)

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

Parameters:

warmStartConfig - The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

Returns:

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

warmStartConfig

default DescribeHyperParameterTuningJobResponse.Builder warmStartConfig(Consumer<HyperParameterTuningJobWarmStartConfig.Builder> warmStartConfig)

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

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

Parameters:

warmStartConfig - a consumer that will call methods on HyperParameterTuningJobWarmStartConfig.Builder

Returns:

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

See Also:

warmStartConfig(HyperParameterTuningJobWarmStartConfig)

failureReason

DescribeHyperParameterTuningJobResponse.Builder failureReason(String failureReason)

If the tuning job failed, the reason it failed.

Parameters:

failureReason - If the tuning job failed, the reason it failed.

Returns:

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