Interface ListTrainingJobsForHyperParameterTuningJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,
,ListTrainingJobsForHyperParameterTuningJobRequest> SageMakerRequest.Builder
,SdkBuilder<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,
,ListTrainingJobsForHyperParameterTuningJobRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListTrainingJobsForHyperParameterTuningJobRequest
-
Method Summary
Modifier and TypeMethodDescriptionhyperParameterTuningJobName
(String hyperParameterTuningJobName) The name of the tuning job whose training jobs you want to list.maxResults
(Integer maxResults) The maximum number of training jobs to return.If the result of the previousListTrainingJobsForHyperParameterTuningJob
request was truncated, the response includes aNextToken
.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The field to sort results by.sortBy
(TrainingJobSortByOptions sortBy) The field to sort results by.The sort order for results.The sort order for results.statusEquals
(String statusEquals) A filter that returns only training jobs with the specified status.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
If the result of the previous
ListTrainingJobsForHyperParameterTuningJob
request was truncated, the response includes aNextToken
. To retrieve the next set of training jobs, use the token in the next request.- Parameters:
nextToken
- If the result of the previousListTrainingJobsForHyperParameterTuningJob
request was truncated, the response includes aNextToken
. 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
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
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:
-
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:
-
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 isName
.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:
-
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 isName
.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:
-
sortOrder
The sort order for results. The default is
Ascending
.- Parameters:
sortOrder
- The sort order for results. The default isAscending
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortOrder
The sort order for results. The default is
Ascending
.- Parameters:
sortOrder
- The sort order for results. The default isAscending
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListTrainingJobsForHyperParameterTuningJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-