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

Interface ListCandidatesForAutoMlJobRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListCandidatesForAutoMlJobRequest

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

Method Summary

Modifier and Type	Method	Description
ListCandidatesForAutoMlJobRequest.Builder	autoMLJobName(String autoMLJobName)	List the candidates created for the job by providing the job's name.
ListCandidatesForAutoMlJobRequest.Builder	candidateNameEquals(String candidateNameEquals)	List the candidates for the job and filter by candidate name.
ListCandidatesForAutoMlJobRequest.Builder	maxResults(Integer maxResults)	List the job's candidates up to a specified limit.
ListCandidatesForAutoMlJobRequest.Builder	nextToken(String nextToken)	If the previous response was truncated, you receive this token.
ListCandidatesForAutoMlJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListCandidatesForAutoMlJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListCandidatesForAutoMlJobRequest.Builder	sortBy(String sortBy)	The parameter by which to sort the results.
ListCandidatesForAutoMlJobRequest.Builder	sortBy(CandidateSortBy sortBy)	The parameter by which to sort the results.
ListCandidatesForAutoMlJobRequest.Builder	sortOrder(String sortOrder)	The sort order for the results.
ListCandidatesForAutoMlJobRequest.Builder	sortOrder(AutoMLSortOrder sortOrder)	The sort order for the results.
ListCandidatesForAutoMlJobRequest.Builder	statusEquals(String statusEquals)	List the candidates for the job and filter by status.
ListCandidatesForAutoMlJobRequest.Builder	statusEquals(CandidateStatus statusEquals)	List the candidates for the job and filter by 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

autoMLJobName

ListCandidatesForAutoMlJobRequest.Builder autoMLJobName(String autoMLJobName)

List the candidates created for the job by providing the job's name.

Parameters:

autoMLJobName - List the candidates created for the job by providing the job's name.

Returns:

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

statusEquals

ListCandidatesForAutoMlJobRequest.Builder statusEquals(String statusEquals)

List the candidates for the job and filter by status.

Parameters:

statusEquals - List the candidates for the job and filter by status.

Returns:

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

See Also:

• CandidateStatus
• CandidateStatus

statusEquals

ListCandidatesForAutoMlJobRequest.Builder statusEquals(CandidateStatus statusEquals)

List the candidates for the job and filter by status.

Parameters:

statusEquals - List the candidates for the job and filter by status.

Returns:

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

See Also:

• CandidateStatus
• CandidateStatus

candidateNameEquals

ListCandidatesForAutoMlJobRequest.Builder candidateNameEquals(String candidateNameEquals)

List the candidates for the job and filter by candidate name.

Parameters:

candidateNameEquals - List the candidates for the job and filter by candidate name.

Returns:

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

sortOrder

ListCandidatesForAutoMlJobRequest.Builder sortOrder(String sortOrder)

The sort order for the results. The default is Ascending.

Parameters:

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

Returns:

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

See Also:

• AutoMLSortOrder
• AutoMLSortOrder

sortOrder

ListCandidatesForAutoMlJobRequest.Builder sortOrder(AutoMLSortOrder sortOrder)

The sort order for the results. The default is Ascending.

Parameters:

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

Returns:

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

See Also:

• AutoMLSortOrder
• AutoMLSortOrder

sortBy

ListCandidatesForAutoMlJobRequest.Builder sortBy(String sortBy)

The parameter by which to sort the results. The default is Descending.

Parameters:

sortBy - The parameter by which to sort the results. The default is Descending.

Returns:

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

See Also:

• CandidateSortBy
• CandidateSortBy

sortBy

ListCandidatesForAutoMlJobRequest.Builder sortBy(CandidateSortBy sortBy)

The parameter by which to sort the results. The default is Descending.

Parameters:

sortBy - The parameter by which to sort the results. The default is Descending.

Returns:

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

See Also:

• CandidateSortBy
• CandidateSortBy

maxResults

ListCandidatesForAutoMlJobRequest.Builder maxResults(Integer maxResults)

List the job's candidates up to a specified limit.

Parameters:

maxResults - List the job's candidates up to a specified limit.

Returns:

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

nextToken

ListCandidatesForAutoMlJobRequest.Builder nextToken(String nextToken)

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Parameters:

nextToken - If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Returns:

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

overrideConfiguration

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

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