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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListClusterNodesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListClusterNodesRequest.Builder`	`builder()`
`String`	`clusterName()`	The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
`Instant`	`creationTimeAfter()`	A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time.
`Instant`	`creationTimeBefore()`	A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`instanceGroupNameContains()`	A filter that returns the instance groups whose name contain a specified string.
`Integer`	`maxResults()`	The maximum number of nodes to return in the response.
`String`	`nextToken()`	If the result of the previous `ListClusterNodes` request was truncated, the response includes a `NextToken`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListClusterNodesRequest.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.
`ListClusterNodesRequest.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
  - clusterName
```
public final String clusterName()
```
    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
    
    Returns:
    
    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
  - creationTimeAfter
```
public final Instant creationTimeAfter()
```
    A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. 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:
    
    A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. 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()
```
    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:
    
    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.
  - instanceGroupNameContains
```
public final String instanceGroupNameContains()
```
    A filter that returns the instance groups whose name contain a specified string.
    
    Returns:
    
    A filter that returns the instance groups whose name contain a specified string.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of nodes to return in the response.
    
    Returns:
    
    The maximum number of nodes to return in the response.
  - nextToken
```
public final String nextToken()
```
    If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.
    
    Returns:
    
    If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.
  - 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
  - toBuilder
```
public ListClusterNodesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListClusterNodesRequest.Builder,ListClusterNodesRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static ListClusterNodesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListClusterNodesRequest.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

Class ListClusterNodesRequest

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

clusterName

creationTimeAfter

creationTimeBefore

instanceGroupNameContains

maxResults

nextToken

sortBy

sortByAsString

sortOrder

sortOrderAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields