Interface ListHyperParameterTuningJobsRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListHyperParameterTuningJobsRequest

@Mutable
@NotThreadSafe
public static interface ListHyperParameterTuningJobsRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<ListHyperParameterTuningJobsRequest.Builder,ListHyperParameterTuningJobsRequest>

Method Summary

Modifier and Type	Method	Description
ListHyperParameterTuningJobsRequest.Builder	creationTimeAfter(Instant creationTimeAfter)	A filter that returns only tuning jobs that were created after the specified time.
ListHyperParameterTuningJobsRequest.Builder	creationTimeBefore(Instant creationTimeBefore)	A filter that returns only tuning jobs that were created before the specified time.
ListHyperParameterTuningJobsRequest.Builder	lastModifiedTimeAfter(Instant lastModifiedTimeAfter)	A filter that returns only tuning jobs that were modified after the specified time.
ListHyperParameterTuningJobsRequest.Builder	lastModifiedTimeBefore(Instant lastModifiedTimeBefore)	A filter that returns only tuning jobs that were modified before the specified time.
ListHyperParameterTuningJobsRequest.Builder	maxResults(Integer maxResults)	The maximum number of tuning jobs to return.
ListHyperParameterTuningJobsRequest.Builder	nameContains(String nameContains)	A string in the tuning job name.
ListHyperParameterTuningJobsRequest.Builder	nextToken(String nextToken)	If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken.
ListHyperParameterTuningJobsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListHyperParameterTuningJobsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListHyperParameterTuningJobsRequest.Builder	sortBy(String sortBy)	The field to sort results by.
ListHyperParameterTuningJobsRequest.Builder	sortBy(HyperParameterTuningJobSortByOptions sortBy)	The field to sort results by.
ListHyperParameterTuningJobsRequest.Builder	sortOrder(String sortOrder)	The sort order for results.
ListHyperParameterTuningJobsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order for results.
ListHyperParameterTuningJobsRequest.Builder	statusEquals(String statusEquals)	A filter that returns only tuning jobs with the specified status.
ListHyperParameterTuningJobsRequest.Builder	statusEquals(HyperParameterTuningJobStatus statusEquals)	A filter that returns only tuning 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, sdkFieldNameToField, sdkFields

Method Details

nextToken

ListHyperParameterTuningJobsRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

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

maxResults

ListHyperParameterTuningJobsRequest.Builder maxResults(Integer maxResults)

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

Parameters:

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

Returns:

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

sortBy

ListHyperParameterTuningJobsRequest.Builder sortBy(String sortBy)

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

Parameters:

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

Returns:

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

See Also:

• HyperParameterTuningJobSortByOptions
• HyperParameterTuningJobSortByOptions

sortBy

ListHyperParameterTuningJobsRequest.Builder sortBy(HyperParameterTuningJobSortByOptions sortBy)

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

Parameters:

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

Returns:

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

See Also:

• HyperParameterTuningJobSortByOptions
• HyperParameterTuningJobSortByOptions

sortOrder

ListHyperParameterTuningJobsRequest.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

ListHyperParameterTuningJobsRequest.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

nameContains

ListHyperParameterTuningJobsRequest.Builder nameContains(String nameContains)

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

Parameters:

nameContains - A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

Returns:

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

creationTimeAfter

ListHyperParameterTuningJobsRequest.Builder creationTimeAfter(Instant creationTimeAfter)

A filter that returns only tuning jobs that were created after the specified time.

Parameters:

creationTimeAfter - A filter that returns only tuning jobs that were created after the specified time.

Returns:

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

creationTimeBefore

ListHyperParameterTuningJobsRequest.Builder creationTimeBefore(Instant creationTimeBefore)

A filter that returns only tuning jobs that were created before the specified time.

Parameters:

creationTimeBefore - A filter that returns only tuning jobs that were created before the specified time.

Returns:

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

lastModifiedTimeAfter

ListHyperParameterTuningJobsRequest.Builder lastModifiedTimeAfter(Instant lastModifiedTimeAfter)

A filter that returns only tuning jobs that were modified after the specified time.

Parameters:

lastModifiedTimeAfter - A filter that returns only tuning jobs that were modified after the specified time.

Returns:

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

lastModifiedTimeBefore

ListHyperParameterTuningJobsRequest.Builder lastModifiedTimeBefore(Instant lastModifiedTimeBefore)

A filter that returns only tuning jobs that were modified before the specified time.

Parameters:

lastModifiedTimeBefore - A filter that returns only tuning jobs that were modified before the specified time.

Returns:

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

statusEquals

ListHyperParameterTuningJobsRequest.Builder statusEquals(String statusEquals)

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

Parameters:

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

Returns:

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

See Also:

• HyperParameterTuningJobStatus
• HyperParameterTuningJobStatus

statusEquals

ListHyperParameterTuningJobsRequest.Builder statusEquals(HyperParameterTuningJobStatus statusEquals)

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

Parameters:

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

Returns:

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

See Also:

• HyperParameterTuningJobStatus
• HyperParameterTuningJobStatus

overrideConfiguration

ListHyperParameterTuningJobsRequest.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

ListHyperParameterTuningJobsRequest.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.