java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
    - - software.amazon.awssdk.services.sagemaker.model.ListTrainingPlansRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListTrainingPlansRequest.Builder,ListTrainingPlansRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListTrainingPlansRequest
extends SageMakerRequest
implements ToCopyableBuilder<ListTrainingPlansRequest.Builder,ListTrainingPlansRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListTrainingPlansRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListTrainingPlansRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<TrainingPlanFilter>`	`filters()`	Additional filters to apply to the list of training plans.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of results to return in the response.
`String`	`nextToken()`	A token to continue pagination if more results are available.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListTrainingPlansRequest.Builder>`	`serializableBuilderClass()`
`TrainingPlanSortBy`	`sortBy()`	The training plan field to sort the results by (e.g., StartTime, Status).
`String`	`sortByAsString()`	The training plan field to sort the results by (e.g., StartTime, Status).
`TrainingPlanSortOrder`	`sortOrder()`	The order to sort the results (Ascending or Descending).
`String`	`sortOrderAsString()`	The order to sort the results (Ascending or Descending).
`Instant`	`startTimeAfter()`	Filter to list only training plans with an actual start time after this date.
`Instant`	`startTimeBefore()`	Filter to list only training plans with an actual start time before this date.
`ListTrainingPlansRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - nextToken
```
public final String nextToken()
```
    A token to continue pagination if more results are available.
    
    Returns:
    
    A token to continue pagination if more results are available.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return in the response.
    
    Returns:
    
    The maximum number of results to return in the response.
  - startTimeAfter
```
public final Instant startTimeAfter()
```
    Filter to list only training plans with an actual start time after this date.
    
    Returns:
    
    Filter to list only training plans with an actual start time after this date.
  - startTimeBefore
```
public final Instant startTimeBefore()
```
    Filter to list only training plans with an actual start time before this date.
    
    Returns:
    
    Filter to list only training plans with an actual start time before this date.
  - sortBy
```
public final TrainingPlanSortBy sortBy()
```
    The training plan field to sort the results by (e.g., StartTime, Status).
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return TrainingPlanSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    The training plan field to sort the results by (e.g., StartTime, Status).
    
    See Also:
    
    TrainingPlanSortBy
  - sortByAsString
```
public final String sortByAsString()
```
    The training plan field to sort the results by (e.g., StartTime, Status).
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return TrainingPlanSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    The training plan field to sort the results by (e.g., StartTime, Status).
    
    See Also:
    
    TrainingPlanSortBy
  - sortOrder
```
public final TrainingPlanSortOrder sortOrder()
```
    The order to sort the results (Ascending or Descending).
    
    If the service returns an enum value that is not available in the current SDK version, sortOrder will return TrainingPlanSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().
    
    Returns:
    
    The order to sort the results (Ascending or Descending).
    
    See Also:
    
    TrainingPlanSortOrder
  - sortOrderAsString
```
public final String sortOrderAsString()
```
    The order to sort the results (Ascending or Descending).
    
    If the service returns an enum value that is not available in the current SDK version, sortOrder will return TrainingPlanSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().
    
    Returns:
    
    The order to sort the results (Ascending or Descending).
    
    See Also:
    
    TrainingPlanSortOrder
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filters
```
public final List<TrainingPlanFilter> filters()
```
    Additional filters to apply to the list of training plans.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
    
    Returns:
    
    Additional filters to apply to the list of training plans.
  - toBuilder
```
public ListTrainingPlansRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListTrainingPlansRequest.Builder,ListTrainingPlansRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static ListTrainingPlansRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListTrainingPlansRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ListTrainingPlansRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

nextToken

maxResults

startTimeAfter

startTimeBefore

sortBy

sortByAsString

sortOrder

sortOrderAsString

hasFilters

filters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField