Interface ListTrainingPlansRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListTrainingPlansRequest

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

Method Summary

Modifier and Type	Method	Description
ListTrainingPlansRequest.Builder	filters(Collection<TrainingPlanFilter> filters)	Additional filters to apply to the list of training plans.
ListTrainingPlansRequest.Builder	filters(Consumer<TrainingPlanFilter.Builder>... filters)	Additional filters to apply to the list of training plans.
ListTrainingPlansRequest.Builder	filters(TrainingPlanFilter... filters)	Additional filters to apply to the list of training plans.
ListTrainingPlansRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in the response.
ListTrainingPlansRequest.Builder	nextToken(String nextToken)	A token to continue pagination if more results are available.
ListTrainingPlansRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListTrainingPlansRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListTrainingPlansRequest.Builder	sortBy(String sortBy)	The training plan field to sort the results by (e.g., StartTime, Status).
ListTrainingPlansRequest.Builder	sortBy(TrainingPlanSortBy sortBy)	The training plan field to sort the results by (e.g., StartTime, Status).
ListTrainingPlansRequest.Builder	sortOrder(String sortOrder)	The order to sort the results (Ascending or Descending).
ListTrainingPlansRequest.Builder	sortOrder(TrainingPlanSortOrder sortOrder)	The order to sort the results (Ascending or Descending).
ListTrainingPlansRequest.Builder	startTimeAfter(Instant startTimeAfter)	Filter to list only training plans with an actual start time after this date.
ListTrainingPlansRequest.Builder	startTimeBefore(Instant startTimeBefore)	Filter to list only training plans with an actual start time before this date.

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

ListTrainingPlansRequest.Builder nextToken(String nextToken)

A token to continue pagination if more results are available.

Parameters:

nextToken - A token to continue pagination if more results are available.

Returns:

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

maxResults

ListTrainingPlansRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in the response.

Parameters:

maxResults - The maximum number of results to return in the response.

Returns:

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

startTimeAfter

ListTrainingPlansRequest.Builder startTimeAfter(Instant startTimeAfter)

Filter to list only training plans with an actual start time after this date.

Parameters:

startTimeAfter - Filter to list only training plans with an actual start time after this date.

Returns:

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

startTimeBefore

ListTrainingPlansRequest.Builder startTimeBefore(Instant startTimeBefore)

Filter to list only training plans with an actual start time before this date.

Parameters:

startTimeBefore - Filter to list only training plans with an actual start time before this date.

Returns:

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

sortBy

ListTrainingPlansRequest.Builder sortBy(String sortBy)

The training plan field to sort the results by (e.g., StartTime, Status).

Parameters:

sortBy - The training plan field to sort the results by (e.g., StartTime, Status).

Returns:

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

See Also:

• TrainingPlanSortBy
• TrainingPlanSortBy

sortBy

ListTrainingPlansRequest.Builder sortBy(TrainingPlanSortBy sortBy)

The training plan field to sort the results by (e.g., StartTime, Status).

Parameters:

sortBy - The training plan field to sort the results by (e.g., StartTime, Status).

Returns:

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

See Also:

• TrainingPlanSortBy
• TrainingPlanSortBy

sortOrder

ListTrainingPlansRequest.Builder sortOrder(String sortOrder)

The order to sort the results (Ascending or Descending).

Parameters:

sortOrder - The order to sort the results (Ascending or Descending).

Returns:

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

See Also:

• TrainingPlanSortOrder
• TrainingPlanSortOrder

sortOrder

ListTrainingPlansRequest.Builder sortOrder(TrainingPlanSortOrder sortOrder)

The order to sort the results (Ascending or Descending).

Parameters:

sortOrder - The order to sort the results (Ascending or Descending).

Returns:

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

See Also:

• TrainingPlanSortOrder
• TrainingPlanSortOrder

filters

ListTrainingPlansRequest.Builder filters(Collection<TrainingPlanFilter> filters)

Additional filters to apply to the list of training plans.

Parameters:

filters - Additional filters to apply to the list of training plans.

Returns:

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

filters

ListTrainingPlansRequest.Builder filters(TrainingPlanFilter... filters)

Additional filters to apply to the list of training plans.

Parameters:

filters - Additional filters to apply to the list of training plans.

Returns:

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

filters

ListTrainingPlansRequest.Builder filters(Consumer<TrainingPlanFilter.Builder>... filters)

Additional filters to apply to the list of training plans.

This is a convenience method that creates an instance of the TrainingPlanFilter.Builder avoiding the need to create one manually via TrainingPlanFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<TrainingPlanFilter>).

Parameters:

filters - a consumer that will call methods on TrainingPlanFilter.Builder

Returns:

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

See Also:

• filters(java.util.Collection<TrainingPlanFilter>)

overrideConfiguration

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

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