Class UltraServer

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.UltraServer
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UltraServer.Builder,UltraServer>
@Generated("software.amazon.awssdk:codegen") public final class UltraServer extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UltraServer.Builder,UltraServer>

Represents a high-performance compute server used for distributed training in SageMaker AI. An UltraServer consists of multiple instances within a shared NVLink interconnect domain.

See Also:

  • Method Details

    • ultraServerId

      public final String ultraServerId()

      The unique identifier for the UltraServer.

      Returns:
      The unique identifier for the UltraServer.

    • ultraServerType

      public final String ultraServerType()

      The type of UltraServer, such as ml.u-p6e-gb200x72.

      Returns:
      The type of UltraServer, such as ml.u-p6e-gb200x72.

    • availabilityZone

      public final String availabilityZone()

      The name of the Availability Zone where the UltraServer is provisioned.

      Returns:
      The name of the Availability Zone where the UltraServer is provisioned.

    • instanceType

      public final ReservedCapacityInstanceType instanceType()

      The Amazon EC2 instance type used in the UltraServer.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ReservedCapacityInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The Amazon EC2 instance type used in the UltraServer.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The Amazon EC2 instance type used in the UltraServer.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ReservedCapacityInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The Amazon EC2 instance type used in the UltraServer.
      See Also:

    • totalInstanceCount

      public final Integer totalInstanceCount()

      The total number of instances in this UltraServer.

      Returns:
      The total number of instances in this UltraServer.

    • configuredSpareInstanceCount

      public final Integer configuredSpareInstanceCount()

      The number of spare instances configured for this UltraServer to provide enhanced resiliency.

      Returns:
      The number of spare instances configured for this UltraServer to provide enhanced resiliency.

    • availableInstanceCount

      public final Integer availableInstanceCount()

      The number of instances currently available for use in this UltraServer.

      Returns:
      The number of instances currently available for use in this UltraServer.

    • inUseInstanceCount

      public final Integer inUseInstanceCount()

      The number of instances currently in use in this UltraServer.

      Returns:
      The number of instances currently in use in this UltraServer.

    • availableSpareInstanceCount

      public final Integer availableSpareInstanceCount()

      The number of available spare instances in the UltraServer.

      Returns:
      The number of available spare instances in the UltraServer.

    • unhealthyInstanceCount

      public final Integer unhealthyInstanceCount()

      The number of instances in this UltraServer that are currently in an unhealthy state.

      Returns:
      The number of instances in this UltraServer that are currently in an unhealthy state.

    • healthStatus

      public final UltraServerHealthStatus healthStatus()

      The overall health status of the UltraServer.

      If the service returns an enum value that is not available in the current SDK version, healthStatus will return UltraServerHealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().

      Returns:
      The overall health status of the UltraServer.
      See Also:

    • healthStatusAsString

      public final String healthStatusAsString()

      The overall health status of the UltraServer.

      If the service returns an enum value that is not available in the current SDK version, healthStatus will return UltraServerHealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().

      Returns:
      The overall health status of the UltraServer.
      See Also:

    • toBuilder

      public UltraServer.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<UltraServer.Builder,UltraServer>
      Returns:
      a builder for type T

    • builder

      public static UltraServer.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UltraServer.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.