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

Class PlacementGroup

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

Describes a placement group.

See Also:

  • Method Details

    • groupName

      public final String groupName()

      The name of the placement group.

      Returns:
      The name of the placement group.

    • state

      public final PlacementGroupState state()

      The state of the placement group.

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

      Returns:
      The state of the placement group.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the placement group.

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

      Returns:
      The state of the placement group.
      See Also:

    • strategy

      public final PlacementStrategy strategy()

      The placement strategy.

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

      Returns:
      The placement strategy.
      See Also:

    • strategyAsString

      public final String strategyAsString()

      The placement strategy.

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

      Returns:
      The placement strategy.
      See Also:

    • partitionCount

      public final Integer partitionCount()

      The number of partitions. Valid only if strategy is set to partition.

      Returns:
      The number of partitions. Valid only if strategy is set to partition.

    • groupId

      public final String groupId()

      The ID of the placement group.

      Returns:
      The ID of the placement group.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      Any tags applied to the placement 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 hasTags() method.

      Returns:
      Any tags applied to the placement group.

    • groupArn

      public final String groupArn()

      The Amazon Resource Name (ARN) of the placement group.

      Returns:
      The Amazon Resource Name (ARN) of the placement group.

    • spreadLevel

      public final SpreadLevel spreadLevel()

      The spread level for the placement group. Only Outpost placement groups can be spread across hosts.

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

      Returns:
      The spread level for the placement group. Only Outpost placement groups can be spread across hosts.
      See Also:

    • spreadLevelAsString

      public final String spreadLevelAsString()

      The spread level for the placement group. Only Outpost placement groups can be spread across hosts.

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

      Returns:
      The spread level for the placement group. Only Outpost placement groups can be spread across hosts.
      See Also:

    • toBuilder

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

    • builder

      public static PlacementGroup.Builder builder()

    • serializableBuilderClass

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