Package software.amazon.awssdk.services.ec2.model

Class InstanceTopology

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

Information about the instance topology.

See Also:

  • Method Details

    • instanceId

      public final String instanceId()

      The instance ID.

      Returns:
      The instance ID.

    • instanceType

      public final String instanceType()

      The instance type.

      Returns:
      The instance type.

    • groupName

      public final String groupName()

      The name of the placement group that the instance is in.

      Returns:
      The name of the placement group that the instance is in.

    • hasNetworkNodes

      public final boolean hasNetworkNodes()
      For responses, this returns true if the service returned a value for the NetworkNodes 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.

    • networkNodes

      public final List<String> networkNodes()

      The network nodes. The nodes are hashed based on your account. Instances from different accounts running under the same server will return a different hashed list of strings.

      The value is null or empty if:

      • The instance type is not supported.

      • The instance is in a state other than running.

      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 hasNetworkNodes() method.

      Returns:
      The network nodes. The nodes are hashed based on your account. Instances from different accounts running under the same server will return a different hashed list of strings.

      The value is null or empty if:

      • The instance type is not supported.

      • The instance is in a state other than running.

    • availabilityZone

      public final String availabilityZone()

      The name of the Availability Zone or Local Zone that the instance is in.

      Returns:
      The name of the Availability Zone or Local Zone that the instance is in.

    • zoneId

      public final String zoneId()

      The ID of the Availability Zone or Local Zone that the instance is in.

      Returns:
      The ID of the Availability Zone or Local Zone that the instance is in.

    • capacityBlockId

      public final String capacityBlockId()

      The ID of the Capacity Block. This parameter is only supported for UltraServer instances and identifies instances within the UltraServer domain.

      Returns:
      The ID of the Capacity Block. This parameter is only supported for UltraServer instances and identifies instances within the UltraServer domain.

    • toBuilder

      public InstanceTopology.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<InstanceTopology.Builder,InstanceTopology>

    • builder

      public static InstanceTopology.Builder builder()

    • serializableBuilderClass

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo