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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,ListTrainingJobsForHyperParameterTuningJobRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListTrainingJobsForHyperParameterTuningJobRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListTrainingJobsForHyperParameterTuningJobRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`hyperParameterTuningJobName()`	The name of the tuning job whose training jobs you want to list.
`Integer`	`maxResults()`	The maximum number of training jobs to return.
`String`	`nextToken()`	If the result of the previous `ListTrainingJobsForHyperParameterTuningJob` request was truncated, the response includes a `NextToken`.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListTrainingJobsForHyperParameterTuningJobRequest.Builder>`	`serializableBuilderClass()`
`TrainingJobSortByOptions`	`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 returns only training jobs with the specified status.
`String`	`statusEqualsAsString()`	A filter that returns only training jobs with the specified status.
`ListTrainingJobsForHyperParameterTuningJobRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

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

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

- Method Detail
  - hyperParameterTuningJobName
```
public final String hyperParameterTuningJobName()
```
    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.
  - nextToken
```
public final 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.
    
    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.
  - maxResults
```
public final Integer maxResults()
```
    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.
  - statusEquals
```
public final TrainingJobStatus statusEquals()
```
    A filter that returns only training jobs with the specified 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 returns only training jobs with the specified status.
    
    See Also:
    
    TrainingJobStatus
  - statusEqualsAsString
```
public final String statusEqualsAsString()
```
    A filter that returns only training jobs with the specified 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 returns only training jobs with the specified status.
    
    See Also:
    
    TrainingJobStatus
  - sortBy
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return TrainingJobSortByOptions.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 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
  - sortByAsString
```
public final String sortByAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return TrainingJobSortByOptions.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 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
  - sortOrder
```
public final 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 final 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 ListTrainingJobsForHyperParameterTuningJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,ListTrainingJobsForHyperParameterTuningJobRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static ListTrainingJobsForHyperParameterTuningJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListTrainingJobsForHyperParameterTuningJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ListTrainingJobsForHyperParameterTuningJobRequest

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

hyperParameterTuningJobName

nextToken

maxResults

statusEquals

statusEqualsAsString

sortBy

sortByAsString

sortOrder

sortOrderAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField