ListTrainingJobsForHyperParameterTuningJobRequest (AWS SDK for Java

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

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

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

ListTrainingJobsForHyperParameterTuningJobRequest()

Constructors
Constructor and Description
`ListTrainingJobsForHyperParameterTuningJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListTrainingJobsForHyperParameterTuningJobRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getHyperParameterTuningJobName()` The name of the tuning job whose training jobs you want to list.
`Integer`	`getMaxResults()` The maximum number of training jobs to return.
`String`	`getNextToken()` If the result of the previous `ListTrainingJobsForHyperParameterTuningJob` 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 training jobs with the specified status.
`int`	`hashCode()`
`void`	`setHyperParameterTuningJobName(String hyperParameterTuningJobName)` The name of the tuning job whose training jobs you want to list.
`void`	`setMaxResults(Integer maxResults)` The maximum number of training jobs to return.
`void`	`setNextToken(String nextToken)` If the result of the previous `ListTrainingJobsForHyperParameterTuningJob` 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 training jobs with the specified status.
`String`	`toString()` Returns a string representation of this object.
`ListTrainingJobsForHyperParameterTuningJobRequest`	`withHyperParameterTuningJobName(String hyperParameterTuningJobName)` The name of the tuning job whose training jobs you want to list.
`ListTrainingJobsForHyperParameterTuningJobRequest`	`withMaxResults(Integer maxResults)` The maximum number of training jobs to return.
`ListTrainingJobsForHyperParameterTuningJobRequest`	`withNextToken(String nextToken)` If the result of the previous `ListTrainingJobsForHyperParameterTuningJob` request was truncated, the response includes a `NextToken`.
`ListTrainingJobsForHyperParameterTuningJobRequest`	`withSortBy(String sortBy)` The field to sort results by.
`ListTrainingJobsForHyperParameterTuningJobRequest`	`withSortBy(TrainingJobSortByOptions sortBy)` The field to sort results by.
`ListTrainingJobsForHyperParameterTuningJobRequest`	`withSortOrder(SortOrder sortOrder)` The sort order for results.
`ListTrainingJobsForHyperParameterTuningJobRequest`	`withSortOrder(String sortOrder)` The sort order for results.
`ListTrainingJobsForHyperParameterTuningJobRequest`	`withStatusEquals(String statusEquals)` A filter that returns only training jobs with the specified status.
`ListTrainingJobsForHyperParameterTuningJobRequest`	`withStatusEquals(TrainingJobStatus statusEquals)` A filter that returns only training jobs with the specified status.

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

- Constructor Detail
  - ListTrainingJobsForHyperParameterTuningJobRequest
```
public ListTrainingJobsForHyperParameterTuningJobRequest()
```
- Method Detail
  - setHyperParameterTuningJobName
```
public void setHyperParameterTuningJobName(String hyperParameterTuningJobName)
```
    The name of the tuning job whose training jobs you want to list.
    
    Parameters:
    
    hyperParameterTuningJobName - The name of the tuning job whose training jobs you want to list.
  - getHyperParameterTuningJobName
```
public String getHyperParameterTuningJobName()
```
    The name of the tuning job whose training jobs you want to list.
    
    Returns:
    
    The name of the tuning job whose training jobs you want to list.
  - withHyperParameterTuningJobName
```
public ListTrainingJobsForHyperParameterTuningJobRequest withHyperParameterTuningJobName(String hyperParameterTuningJobName)
```
    The name of the tuning job whose training jobs you want to list.
    
    Parameters:
    
    hyperParameterTuningJobName - The name of the tuning job whose training jobs you want to list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextToken
```
public void setNextToken(String nextToken)
```
    If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
    
    Parameters:
    
    nextToken - If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
  - getNextToken
```
public String getNextToken()
```
    If the result of the previous ListTrainingJobsForHyperParameterTuningJob 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 ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
  - withNextToken
```
public ListTrainingJobsForHyperParameterTuningJobRequest withNextToken(String nextToken)
```
    If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
    
    Parameters:
    
    nextToken - If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training 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 training jobs to return. The default value is 10.
    
    Parameters:
    
    maxResults - The maximum number of training jobs to return. The default value is 10.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of training jobs to return. The default value is 10.
    
    Returns:
    
    The maximum number of training jobs to return. The default value is 10.
  - withMaxResults
```
public ListTrainingJobsForHyperParameterTuningJobRequest withMaxResults(Integer maxResults)
```
    The maximum number of training jobs to return. The default value is 10.
    
    Parameters:
    
    maxResults - The maximum number of training jobs to return. The default value is 10.
    
    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 training jobs with the specified status.
    
    Parameters:
    
    statusEquals - A filter that returns only training jobs with the specified status.
    
    See Also:
    
    TrainingJobStatus
  - getStatusEquals
```
public String getStatusEquals()
```
    A filter that returns only training jobs with the specified status.
    
    Returns:
    
    A filter that returns only training jobs with the specified status.
    
    See Also:
    
    TrainingJobStatus
  - withStatusEquals
```
public ListTrainingJobsForHyperParameterTuningJobRequest withStatusEquals(String statusEquals)
```
    A filter that returns only training jobs with the specified status.
    
    Parameters:
    
    statusEquals - A filter that returns only training jobs with the specified status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingJobStatus
  - withStatusEquals
```
public ListTrainingJobsForHyperParameterTuningJobRequest withStatusEquals(TrainingJobStatus statusEquals)
```
    A filter that returns only training jobs with the specified status.
    
    Parameters:
    
    statusEquals - A filter that returns only training jobs with the specified status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingJobStatus
  - setSortBy
```
public void setSortBy(String sortBy)
```
    The field to sort results by. The default is Name.
    
    If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
    
    Parameters:
    
    sortBy - The field to sort results by. The default is Name.
    
    If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
    
    See Also:
    
    TrainingJobSortByOptions
  - getSortBy
```
public String getSortBy()
```
    The field to sort results by. The default is Name.
    
    If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
    
    Returns:
    
    The field to sort results by. The default is Name.
    
    If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
    
    See Also:
    
    TrainingJobSortByOptions
  - withSortBy
```
public ListTrainingJobsForHyperParameterTuningJobRequest withSortBy(String sortBy)
```
    The field to sort results by. The default is Name.
    
    If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
    
    Parameters:
    
    sortBy - The field to sort results by. The default is Name.
    
    If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingJobSortByOptions
  - withSortBy
```
public ListTrainingJobsForHyperParameterTuningJobRequest withSortBy(TrainingJobSortByOptions sortBy)
```
    The field to sort results by. The default is Name.
    
    If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
    
    Parameters:
    
    sortBy - The field to sort results by. The default is Name.
    
    If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingJobSortByOptions
  - 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 ListTrainingJobsForHyperParameterTuningJobRequest 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 ListTrainingJobsForHyperParameterTuningJobRequest 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
  - 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 ListTrainingJobsForHyperParameterTuningJobRequest 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()

AWS SDK for Java 1.x API Reference - 1.12.793

Class ListTrainingJobsForHyperParameterTuningJobRequest

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

ListTrainingJobsForHyperParameterTuningJobRequest

Method Detail

setHyperParameterTuningJobName

getHyperParameterTuningJobName

withHyperParameterTuningJobName

setNextToken

getNextToken

withNextToken

setMaxResults

getMaxResults

withMaxResults

setStatusEquals

getStatusEquals

withStatusEquals

withStatusEquals

setSortBy

getSortBy

withSortBy

withSortBy

setSortOrder

getSortOrder

withSortOrder

withSortOrder

toString

equals

hashCode

clone