ListHyperParameterTuningJobsRequest (AWS SDK for Java

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

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

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListHyperParameterTuningJobsRequest
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

ListHyperParameterTuningJobsRequest()

Constructors
Constructor and Description
`ListHyperParameterTuningJobsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListHyperParameterTuningJobsRequest`	`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 tuning jobs that were created after the specified time.
`Date`	`getCreationTimeBefore()` A filter that returns only tuning jobs that were created before the specified time.
`Date`	`getLastModifiedTimeAfter()` A filter that returns only tuning jobs that were modified after the specified time.
`Date`	`getLastModifiedTimeBefore()` A filter that returns only tuning jobs that were modified before the specified time.
`Integer`	`getMaxResults()` The maximum number of tuning jobs to return.
`String`	`getNameContains()` A string in the tuning job name.
`String`	`getNextToken()` If the result of the previous `ListHyperParameterTuningJobs` request was truncated, the response includes a `NextToken`.
`String`	`getSortBy()` The field to sort results by.
`String`	`getSortOrder()` The sort order for results.
`String`	`getStatusEquals()` A filter that returns only tuning jobs with the specified status.
`int`	`hashCode()`
`void`	`setCreationTimeAfter(Date creationTimeAfter)` A filter that returns only tuning jobs that were created after the specified time.
`void`	`setCreationTimeBefore(Date creationTimeBefore)` A filter that returns only tuning jobs that were created before the specified time.
`void`	`setLastModifiedTimeAfter(Date lastModifiedTimeAfter)` A filter that returns only tuning jobs that were modified after the specified time.
`void`	`setLastModifiedTimeBefore(Date lastModifiedTimeBefore)` A filter that returns only tuning jobs that were modified before the specified time.
`void`	`setMaxResults(Integer maxResults)` The maximum number of tuning jobs to return.
`void`	`setNameContains(String nameContains)` A string in the tuning job name.
`void`	`setNextToken(String nextToken)` If the result of the previous `ListHyperParameterTuningJobs` request was truncated, the response includes a `NextToken`.
`void`	`setSortBy(String sortBy)` The field to sort results by.
`void`	`setSortOrder(String sortOrder)` The sort order for results.
`void`	`setStatusEquals(String statusEquals)` A filter that returns only tuning jobs with the specified status.
`String`	`toString()` Returns a string representation of this object.
`ListHyperParameterTuningJobsRequest`	`withCreationTimeAfter(Date creationTimeAfter)` A filter that returns only tuning jobs that were created after the specified time.
`ListHyperParameterTuningJobsRequest`	`withCreationTimeBefore(Date creationTimeBefore)` A filter that returns only tuning jobs that were created before the specified time.
`ListHyperParameterTuningJobsRequest`	`withLastModifiedTimeAfter(Date lastModifiedTimeAfter)` A filter that returns only tuning jobs that were modified after the specified time.
`ListHyperParameterTuningJobsRequest`	`withLastModifiedTimeBefore(Date lastModifiedTimeBefore)` A filter that returns only tuning jobs that were modified before the specified time.
`ListHyperParameterTuningJobsRequest`	`withMaxResults(Integer maxResults)` The maximum number of tuning jobs to return.
`ListHyperParameterTuningJobsRequest`	`withNameContains(String nameContains)` A string in the tuning job name.
`ListHyperParameterTuningJobsRequest`	`withNextToken(String nextToken)` If the result of the previous `ListHyperParameterTuningJobs` request was truncated, the response includes a `NextToken`.
`ListHyperParameterTuningJobsRequest`	`withSortBy(HyperParameterTuningJobSortByOptions sortBy)` The field to sort results by.
`ListHyperParameterTuningJobsRequest`	`withSortBy(String sortBy)` The field to sort results by.
`ListHyperParameterTuningJobsRequest`	`withSortOrder(SortOrder sortOrder)` The sort order for results.
`ListHyperParameterTuningJobsRequest`	`withSortOrder(String sortOrder)` The sort order for results.
`ListHyperParameterTuningJobsRequest`	`withStatusEquals(HyperParameterTuningJobStatus statusEquals)` A filter that returns only tuning jobs with the specified status.
`ListHyperParameterTuningJobsRequest`	`withStatusEquals(String statusEquals)` A filter that returns only tuning jobs with the specified status.

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

- Constructor Detail
  - ListHyperParameterTuningJobsRequest
```
public ListHyperParameterTuningJobsRequest()
```
- Method Detail
  - setNextToken
```
public void setNextToken(String nextToken)
```
    If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
    
    Parameters:
    
    nextToken - If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
  - getNextToken
```
public String getNextToken()
```
    If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
    
    Returns:
    
    If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
  - withNextToken
```
public ListHyperParameterTuningJobsRequest withNextToken(String nextToken)
```
    If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
    
    Parameters:
    
    nextToken - If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, 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 tuning jobs to return. The default value is 10.
    
    Parameters:
    
    maxResults - The maximum number of tuning jobs to return. The default value is 10.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of tuning jobs to return. The default value is 10.
    
    Returns:
    
    The maximum number of tuning jobs to return. The default value is 10.
  - withMaxResults
```
public ListHyperParameterTuningJobsRequest withMaxResults(Integer maxResults)
```
    The maximum number of tuning jobs to return. The default value is 10.
    
    Parameters:
    
    maxResults - The maximum number of tuning jobs to return. The default value is 10.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSortBy
```
public void setSortBy(String sortBy)
```
    The field to sort results by. The default is Name.
    
    Parameters:
    
    sortBy - The field to sort results by. The default is Name.
    
    See Also:
    
    HyperParameterTuningJobSortByOptions
  - getSortBy
```
public String getSortBy()
```
    The field to sort results by. The default is Name.
    
    Returns:
    
    The field to sort results by. The default is Name.
    
    See Also:
    
    HyperParameterTuningJobSortByOptions
  - withSortBy
```
public ListHyperParameterTuningJobsRequest withSortBy(String sortBy)
```
    The field to sort results by. The default is Name.
    
    Parameters:
    
    sortBy - The field to sort results by. The default is Name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobSortByOptions
  - withSortBy
```
public ListHyperParameterTuningJobsRequest withSortBy(HyperParameterTuningJobSortByOptions sortBy)
```
    The field to sort results by. The default is Name.
    
    Parameters:
    
    sortBy - The field to sort results by. The default is Name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobSortByOptions
  - setSortOrder
```
public void setSortOrder(String sortOrder)
```
    The sort order for results. The default is Ascending.
    
    Parameters:
    
    sortOrder - The sort order for results. The default is Ascending.
    
    See Also:
    
    SortOrder
  - getSortOrder
```
public String getSortOrder()
```
    The sort order for results. The default is Ascending.
    
    Returns:
    
    The sort order for results. The default is Ascending.
    
    See Also:
    
    SortOrder
  - withSortOrder
```
public ListHyperParameterTuningJobsRequest withSortOrder(String sortOrder)
```
    The sort order for results. The default is Ascending.
    
    Parameters:
    
    sortOrder - The sort order for results. The default is Ascending.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SortOrder
  - withSortOrder
```
public ListHyperParameterTuningJobsRequest withSortOrder(SortOrder sortOrder)
```
    The sort order for results. The default is Ascending.
    
    Parameters:
    
    sortOrder - The sort order for results. The default is Ascending.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SortOrder
  - setNameContains
```
public void setNameContains(String nameContains)
```
    A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
    
    Parameters:
    
    nameContains - A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
  - getNameContains
```
public String getNameContains()
```
    A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
    
    Returns:
    
    A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
  - withNameContains
```
public ListHyperParameterTuningJobsRequest withNameContains(String nameContains)
```
    A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
    
    Parameters:
    
    nameContains - A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
    
    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 tuning jobs that were created after the specified time.
    
    Parameters:
    
    creationTimeAfter - A filter that returns only tuning jobs that were created after the specified time.
  - getCreationTimeAfter
```
public Date getCreationTimeAfter()
```
    A filter that returns only tuning jobs that were created after the specified time.
    
    Returns:
    
    A filter that returns only tuning jobs that were created after the specified time.
  - withCreationTimeAfter
```
public ListHyperParameterTuningJobsRequest withCreationTimeAfter(Date creationTimeAfter)
```
    A filter that returns only tuning jobs that were created after the specified time.
    
    Parameters:
    
    creationTimeAfter - A filter that returns only tuning jobs that were created after the specified time.
    
    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 tuning jobs that were created before the specified time.
    
    Parameters:
    
    creationTimeBefore - A filter that returns only tuning jobs that were created before the specified time.
  - getCreationTimeBefore
```
public Date getCreationTimeBefore()
```
    A filter that returns only tuning jobs that were created before the specified time.
    
    Returns:
    
    A filter that returns only tuning jobs that were created before the specified time.
  - withCreationTimeBefore
```
public ListHyperParameterTuningJobsRequest withCreationTimeBefore(Date creationTimeBefore)
```
    A filter that returns only tuning jobs that were created before the specified time.
    
    Parameters:
    
    creationTimeBefore - A filter that returns only tuning jobs that were created before the specified time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTimeAfter
```
public void setLastModifiedTimeAfter(Date lastModifiedTimeAfter)
```
    A filter that returns only tuning jobs that were modified after the specified time.
    
    Parameters:
    
    lastModifiedTimeAfter - A filter that returns only tuning jobs that were modified after the specified time.
  - getLastModifiedTimeAfter
```
public Date getLastModifiedTimeAfter()
```
    A filter that returns only tuning jobs that were modified after the specified time.
    
    Returns:
    
    A filter that returns only tuning jobs that were modified after the specified time.
  - withLastModifiedTimeAfter
```
public ListHyperParameterTuningJobsRequest withLastModifiedTimeAfter(Date lastModifiedTimeAfter)
```
    A filter that returns only tuning jobs that were modified after the specified time.
    
    Parameters:
    
    lastModifiedTimeAfter - A filter that returns only tuning jobs that were modified after the specified time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTimeBefore
```
public void setLastModifiedTimeBefore(Date lastModifiedTimeBefore)
```
    A filter that returns only tuning jobs that were modified before the specified time.
    
    Parameters:
    
    lastModifiedTimeBefore - A filter that returns only tuning jobs that were modified before the specified time.
  - getLastModifiedTimeBefore
```
public Date getLastModifiedTimeBefore()
```
    A filter that returns only tuning jobs that were modified before the specified time.
    
    Returns:
    
    A filter that returns only tuning jobs that were modified before the specified time.
  - withLastModifiedTimeBefore
```
public ListHyperParameterTuningJobsRequest withLastModifiedTimeBefore(Date lastModifiedTimeBefore)
```
    A filter that returns only tuning jobs that were modified before the specified time.
    
    Parameters:
    
    lastModifiedTimeBefore - A filter that returns only tuning jobs that were modified before the specified time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusEquals
```
public void setStatusEquals(String statusEquals)
```
    A filter that returns only tuning jobs with the specified status.
    
    Parameters:
    
    statusEquals - A filter that returns only tuning jobs with the specified status.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - getStatusEquals
```
public String getStatusEquals()
```
    A filter that returns only tuning jobs with the specified status.
    
    Returns:
    
    A filter that returns only tuning jobs with the specified status.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - withStatusEquals
```
public ListHyperParameterTuningJobsRequest withStatusEquals(String statusEquals)
```
    A filter that returns only tuning jobs with the specified status.
    
    Parameters:
    
    statusEquals - A filter that returns only tuning jobs with the specified status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - withStatusEquals
```
public ListHyperParameterTuningJobsRequest withStatusEquals(HyperParameterTuningJobStatus statusEquals)
```
    A filter that returns only tuning jobs with the specified status.
    
    Parameters:
    
    statusEquals - A filter that returns only tuning jobs with the specified status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - 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 ListHyperParameterTuningJobsRequest 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 ListHyperParameterTuningJobsRequest

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

ListHyperParameterTuningJobsRequest

Method Detail

setNextToken

getNextToken

withNextToken

setMaxResults

getMaxResults

withMaxResults

setSortBy

getSortBy

withSortBy

withSortBy

setSortOrder

getSortOrder

withSortOrder

withSortOrder

setNameContains

getNameContains

withNameContains

setCreationTimeAfter

getCreationTimeAfter

withCreationTimeAfter

setCreationTimeBefore

getCreationTimeBefore

withCreationTimeBefore

setLastModifiedTimeAfter

getLastModifiedTimeAfter

withLastModifiedTimeAfter

setLastModifiedTimeBefore

getLastModifiedTimeBefore

withLastModifiedTimeBefore

setStatusEquals

getStatusEquals

withStatusEquals

withStatusEquals

toString

equals

hashCode

clone