ListTrainingJobsRequest (AWS SDK for Java

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

All Implemented Interfaces:: ToCopyableBuilder<ListTrainingJobsRequest.Builder,ListTrainingJobsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListTrainingJobsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListTrainingJobsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListTrainingJobsRequest.Builder`	`builder()`
`Instant`	`creationTimeAfter()` A filter that only training jobs created after the specified time (timestamp).
`Instant`	`creationTimeBefore()` A filter that returns only training jobs created before the specified time (timestamp).
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`Instant`	`lastModifiedTimeAfter()` A filter that returns only training jobs modified after the specified time (timestamp).
`Instant`	`lastModifiedTimeBefore()` A filter that returns only training jobs modified before the specified time (timestamp).
`Integer`	`maxResults()` The maximum number of training jobs to return in the response.
`String`	`nameContains()` A string in the training job name.
`String`	`nextToken()` If the result of the previous `ListTrainingJobs` request was truncated, the response includes a `NextToken`.
`static Class<? extends ListTrainingJobsRequest.Builder>`	`serializableBuilderClass()`
`SortBy`	`sortBy()` The field to sort results by.
`String`	`sortByAsString()` The field to sort results by.
`SortOrder`	`sortOrder()` The sort order for results.
`String`	`sortOrderAsString()` The sort order for results.
`TrainingJobStatus`	`statusEquals()` A filter that retrieves only training jobs with a specific status.
`String`	`statusEqualsAsString()` A filter that retrieves only training jobs with a specific status.
`ListTrainingJobsRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

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

- Method Detail
  - nextToken
```
public String nextToken()
```
    If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
    
    Returns:
    
    If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
  - maxResults
```
public Integer maxResults()
```
    The maximum number of training jobs to return in the response.
    
    Returns:
    
    The maximum number of training jobs to return in the response.
  - creationTimeAfter
```
public Instant creationTimeAfter()
```
    A filter that only training jobs created after the specified time (timestamp).
    
    Returns:
    
    A filter that only training jobs created after the specified time (timestamp).
  - creationTimeBefore
```
public Instant creationTimeBefore()
```
    A filter that returns only training jobs created before the specified time (timestamp).
    
    Returns:
    
    A filter that returns only training jobs created before the specified time (timestamp).
  - lastModifiedTimeAfter
```
public Instant lastModifiedTimeAfter()
```
    A filter that returns only training jobs modified after the specified time (timestamp).
    
    Returns:
    
    A filter that returns only training jobs modified after the specified time (timestamp).
  - lastModifiedTimeBefore
```
public Instant lastModifiedTimeBefore()
```
    A filter that returns only training jobs modified before the specified time (timestamp).
    
    Returns:
    
    A filter that returns only training jobs modified before the specified time (timestamp).
  - nameContains
```
public String nameContains()
```
    A string in the training job name. This filter returns only models whose name contains the specified string.
    
    Returns:
    
    A string in the training job name. This filter returns only models whose name contains the specified string.
  - statusEquals
```
public TrainingJobStatus statusEquals()
```
    A filter that retrieves only training jobs with a specific status.
    
    If the service returns an enum value that is not available in the current SDK version, statusEquals will return TrainingJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusEqualsAsString().
    
    Returns:
    
    A filter that retrieves only training jobs with a specific status.
    
    See Also:
    
    TrainingJobStatus
  - statusEqualsAsString
```
public String statusEqualsAsString()
```
    A filter that retrieves only training jobs with a specific status.
    
    If the service returns an enum value that is not available in the current SDK version, statusEquals will return TrainingJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusEqualsAsString().
    
    Returns:
    
    A filter that retrieves only training jobs with a specific status.
    
    See Also:
    
    TrainingJobStatus
  - sortBy
```
public SortBy sortBy()
```
    The field to sort results by. The default is CreationTime.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return SortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    The field to sort results by. The default is CreationTime.
    
    See Also:
    
    SortBy
  - sortByAsString
```
public String sortByAsString()
```
    The field to sort results by. The default is CreationTime.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return SortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    The field to sort results by. The default is CreationTime.
    
    See Also:
    
    SortBy
  - sortOrder
```
public SortOrder sortOrder()
```
    The sort order for results. The default is Ascending.
    
    If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().
    
    Returns:
    
    The sort order for results. The default is Ascending.
    
    See Also:
    
    SortOrder
  - sortOrderAsString
```
public String sortOrderAsString()
```
    The sort order for results. The default is Ascending.
    
    If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().
    
    Returns:
    
    The sort order for results. The default is Ascending.
    
    See Also:
    
    SortOrder
  - toBuilder
```
public ListTrainingJobsRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListTrainingJobsRequest.Builder,ListTrainingJobsRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListTrainingJobsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListTrainingJobsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class ListTrainingJobsRequest

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

creationTimeAfter

creationTimeBefore

lastModifiedTimeAfter

lastModifiedTimeBefore

nameContains

statusEquals

statusEqualsAsString

sortBy

sortByAsString

sortOrder

sortOrderAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField