Class InstanceGroupMetadata

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

Metadata information about an instance group in a HyperPod cluster.

See Also:

  • Method Details

    • failureMessage

      public final String failureMessage()

      An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.

      Returns:
      An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.

    • availabilityZoneId

      public final String availabilityZoneId()

      The ID of the Availability Zone where the instance group is located.

      Returns:
      The ID of the Availability Zone where the instance group is located.

    • capacityReservation

      public final CapacityReservation capacityReservation()

      Information about the Capacity Reservation used by the instance group.

      Returns:
      Information about the Capacity Reservation used by the instance group.

    • subnetId

      public final String subnetId()

      The ID of the subnet where the instance group is located.

      Returns:
      The ID of the subnet where the instance group is located.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroupIds

      public final List<String> securityGroupIds()

      A list of security group IDs associated with the instance group.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

      Returns:
      A list of security group IDs associated with the instance group.

    • amiOverride

      public final String amiOverride()

      If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.

      Returns:
      If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.

    • toBuilder

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

    • builder

      public static InstanceGroupMetadata.Builder builder()

    • serializableBuilderClass

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