Class ClusterNetworkInterface

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

The network interface configuration for a Amazon SageMaker HyperPod cluster instance group.

See Also:

  • Method Details

    • interfaceType

      public final ClusterInterfaceType interfaceType()

      The type of network interface for the instance group. Valid values:

      • efa – An EFA with ENA interface, which provides both the EFA device for low-latency, high-throughput communication and the ENA device for IP networking.

      • efa-only – An EFA-only interface, which provides only the EFA device capabilities without the ENA device for traditional IP networking.

      For more information, see Elastic Fabric Adapter.

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

      Returns:
      The type of network interface for the instance group. Valid values:

      • efa – An EFA with ENA interface, which provides both the EFA device for low-latency, high-throughput communication and the ENA device for IP networking.

      • efa-only – An EFA-only interface, which provides only the EFA device capabilities without the ENA device for traditional IP networking.

      For more information, see Elastic Fabric Adapter.

      See Also:

    • interfaceTypeAsString

      public final String interfaceTypeAsString()

      The type of network interface for the instance group. Valid values:

      • efa – An EFA with ENA interface, which provides both the EFA device for low-latency, high-throughput communication and the ENA device for IP networking.

      • efa-only – An EFA-only interface, which provides only the EFA device capabilities without the ENA device for traditional IP networking.

      For more information, see Elastic Fabric Adapter.

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

      Returns:
      The type of network interface for the instance group. Valid values:

      • efa – An EFA with ENA interface, which provides both the EFA device for low-latency, high-throughput communication and the ENA device for IP networking.

      • efa-only – An EFA-only interface, which provides only the EFA device capabilities without the ENA device for traditional IP networking.

      For more information, see Elastic Fabric Adapter.

      See Also:

    • toBuilder

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

    • builder

      public static ClusterNetworkInterface.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClusterNetworkInterface.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.