Package software.amazon.awssdk.services.sagemaker.model

Interface HyperParameterTuningJobSearchEntity.Builder

All Superinterfaces:

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

Enclosing class:

HyperParameterTuningJobSearchEntity

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

Method Summary

Modifier and Type	Method	Description
default HyperParameterTuningJobSearchEntity.Builder	bestTrainingJob(Consumer<HyperParameterTrainingJobSummary.Builder> bestTrainingJob)	Sets the value of the BestTrainingJob property for this object.
HyperParameterTuningJobSearchEntity.Builder	bestTrainingJob(HyperParameterTrainingJobSummary bestTrainingJob)	Sets the value of the BestTrainingJob property for this object.
default HyperParameterTuningJobSearchEntity.Builder	consumedResources(Consumer<HyperParameterTuningJobConsumedResources.Builder> consumedResources)	The total amount of resources consumed by a hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	consumedResources(HyperParameterTuningJobConsumedResources consumedResources)	The total amount of resources consumed by a hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	creationTime(Instant creationTime)	The time that a hyperparameter tuning job was created.
HyperParameterTuningJobSearchEntity.Builder	failureReason(String failureReason)	The error that was created when a hyperparameter tuning job failed.
HyperParameterTuningJobSearchEntity.Builder	hyperParameterTuningEndTime(Instant hyperParameterTuningEndTime)	The time that a hyperparameter tuning job ended.
HyperParameterTuningJobSearchEntity.Builder	hyperParameterTuningJobArn(String hyperParameterTuningJobArn)	The Amazon Resource Name (ARN) of a hyperparameter tuning job.
default HyperParameterTuningJobSearchEntity.Builder	hyperParameterTuningJobConfig(Consumer<HyperParameterTuningJobConfig.Builder> hyperParameterTuningJobConfig)	Sets the value of the HyperParameterTuningJobConfig property for this object.
HyperParameterTuningJobSearchEntity.Builder	hyperParameterTuningJobConfig(HyperParameterTuningJobConfig hyperParameterTuningJobConfig)	Sets the value of the HyperParameterTuningJobConfig property for this object.
HyperParameterTuningJobSearchEntity.Builder	hyperParameterTuningJobName(String hyperParameterTuningJobName)	The name of a hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	hyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)	The status of a hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	hyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus)	The status of a hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	lastModifiedTime(Instant lastModifiedTime)	The time that a hyperparameter tuning job was last modified.
default HyperParameterTuningJobSearchEntity.Builder	objectiveStatusCounters(Consumer<ObjectiveStatusCounters.Builder> objectiveStatusCounters)	Sets the value of the ObjectiveStatusCounters property for this object.
HyperParameterTuningJobSearchEntity.Builder	objectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)	Sets the value of the ObjectiveStatusCounters property for this object.
default HyperParameterTuningJobSearchEntity.Builder	overallBestTrainingJob(Consumer<HyperParameterTrainingJobSummary.Builder> overallBestTrainingJob)	Sets the value of the OverallBestTrainingJob property for this object.
HyperParameterTuningJobSearchEntity.Builder	overallBestTrainingJob(HyperParameterTrainingJobSummary overallBestTrainingJob)	Sets the value of the OverallBestTrainingJob property for this object.
HyperParameterTuningJobSearchEntity.Builder	tags(Collection<Tag> tags)	The tags associated with a hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	tags(Consumer<Tag.Builder>... tags)	The tags associated with a hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	tags(Tag... tags)	The tags associated with a hyperparameter tuning job.
default HyperParameterTuningJobSearchEntity.Builder	trainingJobDefinition(Consumer<HyperParameterTrainingJobDefinition.Builder> trainingJobDefinition)	Sets the value of the TrainingJobDefinition property for this object.
HyperParameterTuningJobSearchEntity.Builder	trainingJobDefinition(HyperParameterTrainingJobDefinition trainingJobDefinition)	Sets the value of the TrainingJobDefinition property for this object.
HyperParameterTuningJobSearchEntity.Builder	trainingJobDefinitions(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions)	The job definitions included in a hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	trainingJobDefinitions(Consumer<HyperParameterTrainingJobDefinition.Builder>... trainingJobDefinitions)	The job definitions included in a hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	trainingJobDefinitions(HyperParameterTrainingJobDefinition... trainingJobDefinitions)	The job definitions included in a hyperparameter tuning job.
default HyperParameterTuningJobSearchEntity.Builder	trainingJobStatusCounters(Consumer<TrainingJobStatusCounters.Builder> trainingJobStatusCounters)	Sets the value of the TrainingJobStatusCounters property for this object.
HyperParameterTuningJobSearchEntity.Builder	trainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)	Sets the value of the TrainingJobStatusCounters property for this object.
default HyperParameterTuningJobSearchEntity.Builder	tuningJobCompletionDetails(Consumer<HyperParameterTuningJobCompletionDetails.Builder> tuningJobCompletionDetails)	Information about either a current or completed hyperparameter tuning job.
HyperParameterTuningJobSearchEntity.Builder	tuningJobCompletionDetails(HyperParameterTuningJobCompletionDetails tuningJobCompletionDetails)	Information about either a current or completed hyperparameter tuning job.
default HyperParameterTuningJobSearchEntity.Builder	warmStartConfig(Consumer<HyperParameterTuningJobWarmStartConfig.Builder> warmStartConfig)	Sets the value of the WarmStartConfig property for this object.
HyperParameterTuningJobSearchEntity.Builder	warmStartConfig(HyperParameterTuningJobWarmStartConfig warmStartConfig)	Sets the value of the WarmStartConfig property for this object.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

hyperParameterTuningJobName

HyperParameterTuningJobSearchEntity.Builder hyperParameterTuningJobName(String hyperParameterTuningJobName)

The name of a hyperparameter tuning job.

Parameters:

hyperParameterTuningJobName - The name of a hyperparameter tuning job.

Returns:

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

hyperParameterTuningJobArn

HyperParameterTuningJobSearchEntity.Builder hyperParameterTuningJobArn(String hyperParameterTuningJobArn)

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

Parameters:

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

Returns:

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

hyperParameterTuningJobConfig

HyperParameterTuningJobSearchEntity.Builder hyperParameterTuningJobConfig(HyperParameterTuningJobConfig hyperParameterTuningJobConfig)

Sets the value of the HyperParameterTuningJobConfig property for this object.

Parameters:

hyperParameterTuningJobConfig - The new value for the HyperParameterTuningJobConfig property for this object.

Returns:

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

hyperParameterTuningJobConfig

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

Sets the value of the HyperParameterTuningJobConfig property for this object. 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

HyperParameterTuningJobSearchEntity.Builder trainingJobDefinition(HyperParameterTrainingJobDefinition trainingJobDefinition)

Sets the value of the TrainingJobDefinition property for this object.

Parameters:

trainingJobDefinition - The new value for the TrainingJobDefinition property for this object.

Returns:

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

trainingJobDefinition

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

Sets the value of the TrainingJobDefinition property for this object. 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

HyperParameterTuningJobSearchEntity.Builder trainingJobDefinitions(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions)

The job definitions included in a hyperparameter tuning job.

Parameters:

trainingJobDefinitions - The job definitions included in a hyperparameter tuning job.

Returns:

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

trainingJobDefinitions

HyperParameterTuningJobSearchEntity.Builder trainingJobDefinitions(HyperParameterTrainingJobDefinition... trainingJobDefinitions)

The job definitions included in a hyperparameter tuning job.

Parameters:

trainingJobDefinitions - The job definitions included in a hyperparameter tuning job.

Returns:

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

trainingJobDefinitions

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

The job definitions included in a hyperparameter tuning job.

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 #trainingJobDefinitions(List).

Parameters:

trainingJobDefinitions - 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:

#trainingJobDefinitions(java.util.Collection)

hyperParameterTuningJobStatus

HyperParameterTuningJobSearchEntity.Builder hyperParameterTuningJobStatus(String hyperParameterTuningJobStatus)

The status of a hyperparameter tuning job.

Parameters:

hyperParameterTuningJobStatus - The status of a hyperparameter tuning job.

Returns:

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

See Also:

HyperParameterTuningJobStatus, HyperParameterTuningJobStatus

hyperParameterTuningJobStatus

HyperParameterTuningJobSearchEntity.Builder hyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus)

The status of a hyperparameter tuning job.

Parameters:

hyperParameterTuningJobStatus - The status of a hyperparameter tuning job.

Returns:

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

See Also:

HyperParameterTuningJobStatus, HyperParameterTuningJobStatus

creationTime

HyperParameterTuningJobSearchEntity.Builder creationTime(Instant creationTime)

The time that a hyperparameter tuning job was created.

Parameters:

creationTime - The time that a hyperparameter tuning job was created.

Returns:

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

hyperParameterTuningEndTime

HyperParameterTuningJobSearchEntity.Builder hyperParameterTuningEndTime(Instant hyperParameterTuningEndTime)

The time that a hyperparameter tuning job ended.

Parameters:

hyperParameterTuningEndTime - The time that a hyperparameter tuning job ended.

Returns:

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

lastModifiedTime

HyperParameterTuningJobSearchEntity.Builder lastModifiedTime(Instant lastModifiedTime)

The time that a hyperparameter tuning job was last modified.

Parameters:

lastModifiedTime - The time that a hyperparameter tuning job was last modified.

Returns:

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

trainingJobStatusCounters

HyperParameterTuningJobSearchEntity.Builder trainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)

Sets the value of the TrainingJobStatusCounters property for this object.

Parameters:

trainingJobStatusCounters - The new value for the TrainingJobStatusCounters property for this object.

Returns:

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

trainingJobStatusCounters

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

Sets the value of the TrainingJobStatusCounters property for this object. 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

HyperParameterTuningJobSearchEntity.Builder objectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)

Sets the value of the ObjectiveStatusCounters property for this object.

Parameters:

objectiveStatusCounters - The new value for the ObjectiveStatusCounters property for this object.

Returns:

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

objectiveStatusCounters

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

Sets the value of the ObjectiveStatusCounters property for this object. 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

HyperParameterTuningJobSearchEntity.Builder bestTrainingJob(HyperParameterTrainingJobSummary bestTrainingJob)

Sets the value of the BestTrainingJob property for this object.

Parameters:

bestTrainingJob - The new value for the BestTrainingJob property for this object.

Returns:

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

bestTrainingJob

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

Sets the value of the BestTrainingJob property for this object. 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

HyperParameterTuningJobSearchEntity.Builder overallBestTrainingJob(HyperParameterTrainingJobSummary overallBestTrainingJob)

Sets the value of the OverallBestTrainingJob property for this object.

Parameters:

overallBestTrainingJob - The new value for the OverallBestTrainingJob property for this object.

Returns:

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

overallBestTrainingJob

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

Sets the value of the OverallBestTrainingJob property for this object. 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

HyperParameterTuningJobSearchEntity.Builder warmStartConfig(HyperParameterTuningJobWarmStartConfig warmStartConfig)

Sets the value of the WarmStartConfig property for this object.

Parameters:

warmStartConfig - The new value for the WarmStartConfig property for this object.

Returns:

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

warmStartConfig

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

Sets the value of the WarmStartConfig property for this object. 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

HyperParameterTuningJobSearchEntity.Builder failureReason(String failureReason)

The error that was created when a hyperparameter tuning job failed.

Parameters:

failureReason - The error that was created when a hyperparameter tuning job failed.

Returns:

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

tuningJobCompletionDetails

HyperParameterTuningJobSearchEntity.Builder tuningJobCompletionDetails(HyperParameterTuningJobCompletionDetails tuningJobCompletionDetails)

Information about either a current or completed hyperparameter tuning job.

Parameters:

tuningJobCompletionDetails - Information about either a current or completed hyperparameter tuning job.

Returns:

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

tuningJobCompletionDetails

default HyperParameterTuningJobSearchEntity.Builder tuningJobCompletionDetails(Consumer<HyperParameterTuningJobCompletionDetails.Builder> tuningJobCompletionDetails)

Information about either a current or completed hyperparameter tuning job.

This is a convenience method that creates an instance of the HyperParameterTuningJobCompletionDetails.Builder avoiding the need to create one manually via HyperParameterTuningJobCompletionDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tuningJobCompletionDetails(HyperParameterTuningJobCompletionDetails).

Parameters:

tuningJobCompletionDetails - a consumer that will call methods on HyperParameterTuningJobCompletionDetails.Builder

Returns:

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

See Also:

tuningJobCompletionDetails(HyperParameterTuningJobCompletionDetails)

consumedResources

HyperParameterTuningJobSearchEntity.Builder consumedResources(HyperParameterTuningJobConsumedResources consumedResources)

The total amount of resources consumed by a hyperparameter tuning job.

Parameters:

consumedResources - The total amount of resources consumed by a hyperparameter tuning job.

Returns:

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

consumedResources

default HyperParameterTuningJobSearchEntity.Builder consumedResources(Consumer<HyperParameterTuningJobConsumedResources.Builder> consumedResources)

The total amount of resources consumed by a hyperparameter tuning job.

This is a convenience method that creates an instance of the HyperParameterTuningJobConsumedResources.Builder avoiding the need to create one manually via HyperParameterTuningJobConsumedResources.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to consumedResources(HyperParameterTuningJobConsumedResources).

Parameters:

consumedResources - a consumer that will call methods on HyperParameterTuningJobConsumedResources.Builder

Returns:

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

See Also:

consumedResources(HyperParameterTuningJobConsumedResources)

tags

HyperParameterTuningJobSearchEntity.Builder tags(Collection<Tag> tags)

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

Parameters:

tags - The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

Returns:

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

tags

HyperParameterTuningJobSearchEntity.Builder tags(Tag... tags)

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

Parameters:

tags - The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

Returns:

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

tags

HyperParameterTuningJobSearchEntity.Builder tags(Consumer<Tag.Builder>... tags)

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)