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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListClustersRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListClustersRequest.Builder`	`builder()`
`Instant`	`creationTimeAfter()`	Set a start time for the time range during which you want to list SageMaker HyperPod clusters.
`Instant`	`creationTimeBefore()`	Set an end time for the time range during which you want to list SageMaker HyperPod clusters.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxResults()`	Set the maximum number of SageMaker HyperPod clusters to list.
`String`	`nameContains()`	Set the maximum number of instances to print in the list.
`String`	`nextToken()`	Set the next token to retrieve the list of SageMaker HyperPod clusters.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListClustersRequest.Builder>`	`serializableBuilderClass()`
`ClusterSortBy`	`sortBy()`	The field by which to sort results.
`String`	`sortByAsString()`	The field by which to sort results.
`SortOrder`	`sortOrder()`	The sort order for results.
`String`	`sortOrderAsString()`	The sort order for results.
`ListClustersRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`trainingPlanArn()`	The Amazon Resource Name (ARN); of the training plan to filter clusters by.

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
  - creationTimeAfter
```
public final Instant creationTimeAfter()
```
    Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.
    
    Acceptable formats include:
    
    YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z
    
    YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00
    
    YYYY-MM-DD, for example, 2014-10-01
    
    Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.
    
    For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
    Returns:
    
    Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.
    
    Acceptable formats include:
    
    YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z
    
    YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00
    
    YYYY-MM-DD, for example, 2014-10-01
    
    Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.
    
    For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
  - creationTimeBefore
```
public final Instant creationTimeBefore()
```
    Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
    
    Returns:
    
    Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
  - maxResults
```
public final Integer maxResults()
```
    Set the maximum number of SageMaker HyperPod clusters to list.
    
    Returns:
    
    Set the maximum number of SageMaker HyperPod clusters to list.
  - nameContains
```
public final String nameContains()
```
    Set the maximum number of instances to print in the list.
    
    Returns:
    
    Set the maximum number of instances to print in the list.
  - nextToken
```
public final String nextToken()
```
    Set the next token to retrieve the list of SageMaker HyperPod clusters.
    
    Returns:
    
    Set the next token to retrieve the list of SageMaker HyperPod clusters.
  - sortBy
```
public final ClusterSortBy sortBy()
```
    The field by which to sort results. The default value is CREATION_TIME.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return ClusterSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    The field by which to sort results. The default value is CREATION_TIME.
    
    See Also:
    
    ClusterSortBy
  - sortByAsString
```
public final String sortByAsString()
```
    The field by which to sort results. The default value is CREATION_TIME.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return ClusterSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    The field by which to sort results. The default value is CREATION_TIME.
    
    See Also:
    
    ClusterSortBy
  - sortOrder
```
public final SortOrder sortOrder()
```
    The sort order for results. The default value 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 value is Ascending.
    
    See Also:
    
    SortOrder
  - sortOrderAsString
```
public final String sortOrderAsString()
```
    The sort order for results. The default value 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 value is Ascending.
    
    See Also:
    
    SortOrder
  - trainingPlanArn
```
public final String trainingPlanArn()
```
    The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
    
    Returns:
    
    The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
  - toBuilder
```
public ListClustersRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListClustersRequest.Builder,ListClustersRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static ListClustersRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListClustersRequest.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 ListClustersRequest

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

creationTimeAfter

creationTimeBefore

maxResults

nameContains

nextToken

sortBy

sortByAsString

sortOrder

sortOrderAsString

trainingPlanArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField