Interface ListTrainingJobsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListTrainingJobsRequest.Builder,ListTrainingJobsRequest>
,SageMakerRequest.Builder
,SdkBuilder<ListTrainingJobsRequest.Builder,ListTrainingJobsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- ListTrainingJobsRequest
public static interface ListTrainingJobsRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<ListTrainingJobsRequest.Builder,ListTrainingJobsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListTrainingJobsRequest.Builder
creationTimeAfter(Instant creationTimeAfter)
A filter that returns only training jobs created after the specified time (timestamp).ListTrainingJobsRequest.Builder
creationTimeBefore(Instant creationTimeBefore)
A filter that returns only training jobs created before the specified time (timestamp).ListTrainingJobsRequest.Builder
lastModifiedTimeAfter(Instant lastModifiedTimeAfter)
A filter that returns only training jobs modified after the specified time (timestamp).ListTrainingJobsRequest.Builder
lastModifiedTimeBefore(Instant lastModifiedTimeBefore)
A filter that returns only training jobs modified before the specified time (timestamp).ListTrainingJobsRequest.Builder
maxResults(Integer maxResults)
The maximum number of training jobs to return in the response.ListTrainingJobsRequest.Builder
nameContains(String nameContains)
A string in the training job name.ListTrainingJobsRequest.Builder
nextToken(String nextToken)
If the result of the previousListTrainingJobs
request was truncated, the response includes aNextToken
.ListTrainingJobsRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListTrainingJobsRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListTrainingJobsRequest.Builder
sortBy(String sortBy)
The field to sort results by.ListTrainingJobsRequest.Builder
sortBy(SortBy sortBy)
The field to sort results by.ListTrainingJobsRequest.Builder
sortOrder(String sortOrder)
The sort order for results.ListTrainingJobsRequest.Builder
sortOrder(SortOrder sortOrder)
The sort order for results.ListTrainingJobsRequest.Builder
statusEquals(String statusEquals)
A filter that retrieves only training jobs with a specific status.ListTrainingJobsRequest.Builder
statusEquals(TrainingJobStatus statusEquals)
A filter that retrieves only training jobs with a specific status.ListTrainingJobsRequest.Builder
trainingPlanArnEquals(String trainingPlanArnEquals)
The Amazon Resource Name (ARN); of the training plan to filter training jobs by.ListTrainingJobsRequest.Builder
warmPoolStatusEquals(String warmPoolStatusEquals)
A filter that retrieves only training jobs with a specific warm pool status.ListTrainingJobsRequest.Builder
warmPoolStatusEquals(WarmPoolResourceStatus warmPoolStatusEquals)
A filter that retrieves only training jobs with a specific warm pool 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 Detail
-
nextToken
ListTrainingJobsRequest.Builder nextToken(String nextToken)
If the result of the previous
ListTrainingJobs
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 previousListTrainingJobs
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
ListTrainingJobsRequest.Builder maxResults(Integer maxResults)
The maximum number of training jobs to return in the response.
- Parameters:
maxResults
- The maximum number of training jobs to return in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTimeAfter
ListTrainingJobsRequest.Builder creationTimeAfter(Instant creationTimeAfter)
A filter that returns only training jobs created after the specified time (timestamp).
- Parameters:
creationTimeAfter
- A filter that returns only training jobs created after the specified time (timestamp).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTimeBefore
ListTrainingJobsRequest.Builder creationTimeBefore(Instant creationTimeBefore)
A filter that returns only training jobs created before the specified time (timestamp).
- Parameters:
creationTimeBefore
- A filter that returns only training jobs created before the specified time (timestamp).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastModifiedTimeAfter
ListTrainingJobsRequest.Builder lastModifiedTimeAfter(Instant lastModifiedTimeAfter)
A filter that returns only training jobs modified after the specified time (timestamp).
- Parameters:
lastModifiedTimeAfter
- A filter that returns only training jobs modified after the specified time (timestamp).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastModifiedTimeBefore
ListTrainingJobsRequest.Builder lastModifiedTimeBefore(Instant lastModifiedTimeBefore)
A filter that returns only training jobs modified before the specified time (timestamp).
- Parameters:
lastModifiedTimeBefore
- A filter that returns only training jobs modified before the specified time (timestamp).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nameContains
ListTrainingJobsRequest.Builder nameContains(String nameContains)
A string in the training job name. This filter returns only training jobs whose name contains the specified string.
- Parameters:
nameContains
- A string in the training job name. This filter returns only training jobs whose name contains the specified string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusEquals
ListTrainingJobsRequest.Builder statusEquals(String statusEquals)
A filter that retrieves only training jobs with a specific status.
- Parameters:
statusEquals
- A filter that retrieves only training jobs with a specific status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TrainingJobStatus
,TrainingJobStatus
-
statusEquals
ListTrainingJobsRequest.Builder statusEquals(TrainingJobStatus statusEquals)
A filter that retrieves only training jobs with a specific status.
- Parameters:
statusEquals
- A filter that retrieves only training jobs with a specific status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TrainingJobStatus
,TrainingJobStatus
-
sortBy
ListTrainingJobsRequest.Builder sortBy(String sortBy)
The field to sort results by. The default is
CreationTime
.
-
sortBy
ListTrainingJobsRequest.Builder sortBy(SortBy sortBy)
The field to sort results by. The default is
CreationTime
.
-
sortOrder
ListTrainingJobsRequest.Builder sortOrder(String sortOrder)
The sort order for results. The default is
Ascending
.
-
sortOrder
ListTrainingJobsRequest.Builder sortOrder(SortOrder sortOrder)
The sort order for results. The default is
Ascending
.
-
warmPoolStatusEquals
ListTrainingJobsRequest.Builder warmPoolStatusEquals(String warmPoolStatusEquals)
A filter that retrieves only training jobs with a specific warm pool status.
- Parameters:
warmPoolStatusEquals
- A filter that retrieves only training jobs with a specific warm pool status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WarmPoolResourceStatus
,WarmPoolResourceStatus
-
warmPoolStatusEquals
ListTrainingJobsRequest.Builder warmPoolStatusEquals(WarmPoolResourceStatus warmPoolStatusEquals)
A filter that retrieves only training jobs with a specific warm pool status.
- Parameters:
warmPoolStatusEquals
- A filter that retrieves only training jobs with a specific warm pool status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WarmPoolResourceStatus
,WarmPoolResourceStatus
-
trainingPlanArnEquals
ListTrainingJobsRequest.Builder trainingPlanArnEquals(String trainingPlanArnEquals)
The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see
CreateTrainingPlan
.- Parameters:
trainingPlanArnEquals
- The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, seeCreateTrainingPlan
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListTrainingJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
ListTrainingJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-