ListModelsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sagemaker.model.ListModelsRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListModelsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

ListModelsRequest()

Constructors
Constructor and Description
`ListModelsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListModelsRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Date`	`getCreationTimeAfter()` A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
`Date`	`getCreationTimeBefore()` A filter that returns only models created before the specified time (timestamp).
`Integer`	`getMaxResults()` The maximum number of models to return in the response.
`String`	`getNameContains()` A string in the model name.
`String`	`getNextToken()` If the response to a previous `ListModels` request was truncated, the response includes a `NextToken`.
`String`	`getSortBy()` Sorts the list of results.
`String`	`getSortOrder()` The sort order for results.
`int`	`hashCode()`
`void`	`setCreationTimeAfter(Date creationTimeAfter)` A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
`void`	`setCreationTimeBefore(Date creationTimeBefore)` A filter that returns only models created before the specified time (timestamp).
`void`	`setMaxResults(Integer maxResults)` The maximum number of models to return in the response.
`void`	`setNameContains(String nameContains)` A string in the model name.
`void`	`setNextToken(String nextToken)` If the response to a previous `ListModels` request was truncated, the response includes a `NextToken`.
`void`	`setSortBy(String sortBy)` Sorts the list of results.
`void`	`setSortOrder(String sortOrder)` The sort order for results.
`String`	`toString()` Returns a string representation of this object.
`ListModelsRequest`	`withCreationTimeAfter(Date creationTimeAfter)` A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
`ListModelsRequest`	`withCreationTimeBefore(Date creationTimeBefore)` A filter that returns only models created before the specified time (timestamp).
`ListModelsRequest`	`withMaxResults(Integer maxResults)` The maximum number of models to return in the response.
`ListModelsRequest`	`withNameContains(String nameContains)` A string in the model name.
`ListModelsRequest`	`withNextToken(String nextToken)` If the response to a previous `ListModels` request was truncated, the response includes a `NextToken`.
`ListModelsRequest`	`withSortBy(ModelSortKey sortBy)` Sorts the list of results.
`ListModelsRequest`	`withSortBy(String sortBy)` Sorts the list of results.
`ListModelsRequest`	`withSortOrder(OrderKey sortOrder)` The sort order for results.
`ListModelsRequest`	`withSortOrder(String sortOrder)` The sort order for results.

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

- Constructor Detail
  - ListModelsRequest
```
public ListModelsRequest()
```
- Method Detail
  - setSortBy
```
public void setSortBy(String sortBy)
```
    Sorts the list of results. The default is CreationTime.
    
    Parameters:
    
    sortBy - Sorts the list of results. The default is CreationTime.
    
    See Also:
    
    ModelSortKey
  - getSortBy
```
public String getSortBy()
```
    Sorts the list of results. The default is CreationTime.
    
    Returns:
    
    Sorts the list of results. The default is CreationTime.
    
    See Also:
    
    ModelSortKey
  - withSortBy
```
public ListModelsRequest withSortBy(String sortBy)
```
    Sorts the list of results. The default is CreationTime.
    
    Parameters:
    
    sortBy - Sorts the list of results. The default is CreationTime.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelSortKey
  - withSortBy
```
public ListModelsRequest withSortBy(ModelSortKey sortBy)
```
    Sorts the list of results. The default is CreationTime.
    
    Parameters:
    
    sortBy - Sorts the list of results. The default is CreationTime.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelSortKey
  - setSortOrder
```
public void setSortOrder(String sortOrder)
```
    The sort order for results. The default is Descending.
    
    Parameters:
    
    sortOrder - The sort order for results. The default is Descending.
    
    See Also:
    
    OrderKey
  - getSortOrder
```
public String getSortOrder()
```
    The sort order for results. The default is Descending.
    
    Returns:
    
    The sort order for results. The default is Descending.
    
    See Also:
    
    OrderKey
  - withSortOrder
```
public ListModelsRequest withSortOrder(String sortOrder)
```
    The sort order for results. The default is Descending.
    
    Parameters:
    
    sortOrder - The sort order for results. The default is Descending.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrderKey
  - withSortOrder
```
public ListModelsRequest withSortOrder(OrderKey sortOrder)
```
    The sort order for results. The default is Descending.
    
    Parameters:
    
    sortOrder - The sort order for results. The default is Descending.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrderKey
  - setNextToken
```
public void setNextToken(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.
    
    Parameters:
    
    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.
  - getNextToken
```
public String getNextToken()
```
    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.
  - withNextToken
```
public ListModelsRequest withNextToken(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    The maximum number of models to return in the response.
    
    Parameters:
    
    maxResults - The maximum number of models to return in the response.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of models to return in the response.
    
    Returns:
    
    The maximum number of models to return in the response.
  - withMaxResults
```
public ListModelsRequest withMaxResults(Integer maxResults)
```
    The maximum number of models to return in the response.
    
    Parameters:
    
    maxResults - The maximum number of models to return in the response.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNameContains
```
public void setNameContains(String nameContains)
```
    A string in the model name. This filter returns only models whose name contains the specified string.
    
    Parameters:
    
    nameContains - A string in the model name. This filter returns only models whose name contains the specified string.
  - getNameContains
```
public String getNameContains()
```
    A string in the model name. This filter returns only models whose name contains the specified string.
    
    Returns:
    
    A string in the model name. This filter returns only models whose name contains the specified string.
  - withNameContains
```
public ListModelsRequest withNameContains(String nameContains)
```
    A string in the model name. This filter returns only models whose name contains the specified string.
    
    Parameters:
    
    nameContains - A string in the model name. This filter returns only models whose name contains the specified string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTimeBefore
```
public void setCreationTimeBefore(Date creationTimeBefore)
```
    A filter that returns only models created before the specified time (timestamp).
    
    Parameters:
    
    creationTimeBefore - A filter that returns only models created before the specified time (timestamp).
  - getCreationTimeBefore
```
public Date getCreationTimeBefore()
```
    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).
  - withCreationTimeBefore
```
public ListModelsRequest withCreationTimeBefore(Date creationTimeBefore)
```
    A filter that returns only models created before the specified time (timestamp).
    
    Parameters:
    
    creationTimeBefore - A filter that returns only models created before the specified time (timestamp).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTimeAfter
```
public void setCreationTimeAfter(Date creationTimeAfter)
```
    A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
    
    Parameters:
    
    creationTimeAfter - A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
  - getCreationTimeAfter
```
public Date getCreationTimeAfter()
```
    A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
    
    Returns:
    
    A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
  - withCreationTimeAfter
```
public ListModelsRequest withCreationTimeAfter(Date creationTimeAfter)
```
    A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
    
    Parameters:
    
    creationTimeAfter - A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ListModelsRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class ListModelsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListModelsRequest

Method Detail

setSortBy

getSortBy

withSortBy

withSortBy

setSortOrder

getSortOrder

withSortOrder

withSortOrder

setNextToken

getNextToken

withNextToken

setMaxResults

getMaxResults

withMaxResults

setNameContains

getNameContains

withNameContains

setCreationTimeBefore

getCreationTimeBefore

withCreationTimeBefore

setCreationTimeAfter

getCreationTimeAfter

withCreationTimeAfter

toString

equals

hashCode

clone