ListModelsRequest (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.ListModelsRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListModelsRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListModelsRequest.Builder`	`builder()`
`Instant`	`creationTimeAfter()` A filter that returns only models created after the specified time (timestamp).
`Instant`	`creationTimeBefore()` A filter that returns only models 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()`
`Integer`	`maxResults()` The maximum number of models to return in the response.
`String`	`nameContains()` A string in the training job name.
`String`	`nextToken()` If the response to a previous `ListModels` request was truncated, the response includes a `NextToken`.
`static Class<? extends ListModelsRequest.Builder>`	`serializableBuilderClass()`
`ModelSortKey`	`sortBy()` Sorts the list of results.
`String`	`sortByAsString()` Sorts the list of results.
`OrderKey`	`sortOrder()` The sort order for results.
`String`	`sortOrderAsString()` The sort order for results.
`ListModelsRequest.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
  - sortBy
```
public ModelSortKey sortBy()
```
    Sorts the list of results. The default is CreationTime.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return ModelSortKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    Sorts the list of results. The default is CreationTime.
    
    See Also:
    
    ModelSortKey
  - sortByAsString
```
public String sortByAsString()
```
    Sorts the list of results. The default is CreationTime.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return ModelSortKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    Sorts the list of results. The default is CreationTime.
    
    See Also:
    
    ModelSortKey
  - sortOrder
```
public OrderKey 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 OrderKey.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:
    
    OrderKey
  - 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 OrderKey.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:
    
    OrderKey
  - nextToken
```
public String nextToken()
```
    If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.
    
    Returns:
    
    If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.
  - maxResults
```
public Integer maxResults()
```
    The maximum number of models to return in the response.
    
    Returns:
    
    The maximum number of models to return in the response.
  - nameContains
```
public String nameContains()
```
    A string in the training job name. This filter returns only models in the training job whose name contains the specified string.
    
    Returns:
    
    A string in the training job name. This filter returns only models in the training job whose name contains the specified string.
  - creationTimeBefore
```
public Instant creationTimeBefore()
```
    A filter that returns only models created before the specified time (timestamp).
    
    Returns:
    
    A filter that returns only models created before the specified time (timestamp).
  - creationTimeAfter
```
public Instant creationTimeAfter()
```
    A filter that returns only models created after the specified time (timestamp).
    
    Returns:
    
    A filter that returns only models created after the specified time (timestamp).
  - toBuilder
```
public ListModelsRequest.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<ListModelsRequest.Builder,ListModelsRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListModelsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListModelsRequest.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 ListModelsRequest

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

sortBy

sortByAsString

sortOrder

sortOrderAsString

nextToken

maxResults

nameContains

creationTimeBefore

creationTimeAfter

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField