ListHyperParameterTuningJobsRequest (AWS Java SDK :: Services

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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListHyperParameterTuningJobsRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListHyperParameterTuningJobsRequest.Builder`	`builder()`
`Instant`	`creationTimeAfter()` A filter that returns only tuning jobs that were created after the specified time.
`Instant`	`creationTimeBefore()` A filter that returns only tuning jobs that were created before the specified time.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastModifiedTimeAfter()` A filter that returns only tuning jobs that were modified after the specified time.
`Instant`	`lastModifiedTimeBefore()` A filter that returns only tuning jobs that were modified before the specified time.
`Integer`	`maxResults()` The maximum number of tuning jobs to return.
`String`	`nameContains()` A string in the tuning job name.
`String`	`nextToken()` If the result of the previous `ListHyperParameterTuningJobs` request was truncated, the response includes a `NextToken`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListHyperParameterTuningJobsRequest.Builder>`	`serializableBuilderClass()`
`HyperParameterTuningJobSortByOptions`	`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.
`HyperParameterTuningJobStatus`	`statusEquals()` A filter that returns only tuning jobs with the specified status.
`String`	`statusEqualsAsString()` A filter that returns only tuning jobs with the specified status.
`ListHyperParameterTuningJobsRequest.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
  - nextToken
```
public 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.
    
    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.
  - maxResults
```
public Integer maxResults()
```
    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.
  - sortBy
```
public HyperParameterTuningJobSortByOptions sortBy()
```
    The field to sort results by. The default is Name.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return HyperParameterTuningJobSortByOptions.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.
    
    See Also:
    
    HyperParameterTuningJobSortByOptions
  - sortByAsString
```
public String sortByAsString()
```
    The field to sort results by. The default is Name.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return HyperParameterTuningJobSortByOptions.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.
    
    See Also:
    
    HyperParameterTuningJobSortByOptions
  - 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
  - nameContains
```
public String nameContains()
```
    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.
  - creationTimeAfter
```
public Instant creationTimeAfter()
```
    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.
  - creationTimeBefore
```
public Instant creationTimeBefore()
```
    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.
  - lastModifiedTimeAfter
```
public Instant lastModifiedTimeAfter()
```
    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.
  - lastModifiedTimeBefore
```
public Instant lastModifiedTimeBefore()
```
    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.
  - statusEquals
```
public HyperParameterTuningJobStatus statusEquals()
```
    A filter that returns only tuning jobs with the specified status.
    
    If the service returns an enum value that is not available in the current SDK version, statusEquals will return HyperParameterTuningJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusEqualsAsString().
    
    Returns:
    
    A filter that returns only tuning jobs with the specified status.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - statusEqualsAsString
```
public String statusEqualsAsString()
```
    A filter that returns only tuning jobs with the specified status.
    
    If the service returns an enum value that is not available in the current SDK version, statusEquals will return HyperParameterTuningJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusEqualsAsString().
    
    Returns:
    
    A filter that returns only tuning jobs with the specified status.
    
    See Also:
    
    HyperParameterTuningJobStatus
  - toBuilder
```
public ListHyperParameterTuningJobsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListHyperParameterTuningJobsRequest.Builder,ListHyperParameterTuningJobsRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static ListHyperParameterTuningJobsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListHyperParameterTuningJobsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListHyperParameterTuningJobsRequest

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

nextToken

maxResults

sortBy

sortByAsString

sortOrder

sortOrderAsString

nameContains

creationTimeAfter

creationTimeBefore

lastModifiedTimeAfter

lastModifiedTimeBefore

statusEquals

statusEqualsAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields