Package software.amazon.awssdk.services.sagemaker.model

Class ListClusterNodesRequest

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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public ListClusterNodesRequest.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<ListClusterNodesRequest.Builder,ListClusterNodesRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.