Interface ListTrainingJobsForHyperParameterTuningJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,ListTrainingJobsForHyperParameterTuningJobRequest>, SageMakerRequest.Builder, SdkBuilder<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,ListTrainingJobsForHyperParameterTuningJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListTrainingJobsForHyperParameterTuningJobRequest

public static interface ListTrainingJobsForHyperParameterTuningJobRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,ListTrainingJobsForHyperParameterTuningJobRequest>

Method Summary

Modifier and Type	Method	Description
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	hyperParameterTuningJobName(String hyperParameterTuningJobName)	The name of the tuning job whose training jobs you want to list.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	maxResults(Integer maxResults)	The maximum number of training jobs to return.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	nextToken(String nextToken)	If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	sortBy(String sortBy)	The field to sort results by.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	sortBy(TrainingJobSortByOptions sortBy)	The field to sort results by.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	sortOrder(String sortOrder)	The sort order for results.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order for results.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	statusEquals(String statusEquals)	A filter that returns only training jobs with the specified status.
ListTrainingJobsForHyperParameterTuningJobRequest.Builder	statusEquals(TrainingJobStatus statusEquals)	A filter that returns only training jobs with the specified status.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

hyperParameterTuningJobName

ListTrainingJobsForHyperParameterTuningJobRequest.Builder hyperParameterTuningJobName(String hyperParameterTuningJobName)

The name of the tuning job whose training jobs you want to list.

Parameters:

hyperParameterTuningJobName - The name of the tuning job whose training jobs you want to list.

Returns:

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

nextToken

ListTrainingJobsForHyperParameterTuningJobRequest.Builder nextToken(String nextToken)

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Parameters:

nextToken - If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Returns:

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

maxResults

ListTrainingJobsForHyperParameterTuningJobRequest.Builder maxResults(Integer maxResults)

The maximum number of training jobs to return. The default value is 10.

Parameters:

maxResults - The maximum number of training jobs to return. The default value is 10.

Returns:

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

statusEquals

ListTrainingJobsForHyperParameterTuningJobRequest.Builder statusEquals(String statusEquals)

A filter that returns only training jobs with the specified status.

Parameters:

statusEquals - A filter that returns only training jobs with the specified status.

Returns:

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

See Also:

• TrainingJobStatus
• TrainingJobStatus

statusEquals

ListTrainingJobsForHyperParameterTuningJobRequest.Builder statusEquals(TrainingJobStatus statusEquals)

A filter that returns only training jobs with the specified status.

Parameters:

statusEquals - A filter that returns only training jobs with the specified status.

Returns:

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

See Also:

• TrainingJobStatus
• TrainingJobStatus

sortBy

ListTrainingJobsForHyperParameterTuningJobRequest.Builder sortBy(String sortBy)

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Parameters:

sortBy - The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Returns:

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

See Also:

• TrainingJobSortByOptions
• TrainingJobSortByOptions

sortBy

ListTrainingJobsForHyperParameterTuningJobRequest.Builder sortBy(TrainingJobSortByOptions sortBy)

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Parameters:

sortBy - The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Returns:

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

See Also:

• TrainingJobSortByOptions
• TrainingJobSortByOptions

sortOrder

ListTrainingJobsForHyperParameterTuningJobRequest.Builder sortOrder(String sortOrder)

The sort order for results. The default is Ascending.

Parameters:

sortOrder - The sort order for results. The default is Ascending.

Returns:

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

See Also:

• SortOrder
• SortOrder

sortOrder

ListTrainingJobsForHyperParameterTuningJobRequest.Builder sortOrder(SortOrder sortOrder)

The sort order for results. The default is Ascending.

Parameters:

sortOrder - The sort order for results. The default is Ascending.

Returns:

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

See Also:

• SortOrder
• SortOrder

overrideConfiguration

ListTrainingJobsForHyperParameterTuningJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ListTrainingJobsForHyperParameterTuningJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.