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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListTrainingJobsForHyperParameterTuningJobRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListTrainingJobsForHyperParameterTuningJobRequest.Builder`	`builder()`
`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()`
`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`.
`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()` 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
overrideConfiguration

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
  - hyperParameterTuningJobName
```
public 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 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 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 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 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 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 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 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 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()
```
    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<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,ListTrainingJobsForHyperParameterTuningJobRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListTrainingJobsForHyperParameterTuningJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListTrainingJobsForHyperParameterTuningJobRequest.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
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

toString

getValueForField

sdkFields