Class DeleteGameServerGroupRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeleteGameServerGroupRequest.Builder,DeleteGameServerGroupRequest>

@Generated("software.amazon.awssdk:codegen") public final class DeleteGameServerGroupRequest extends GameLiftRequest implements ToCopyableBuilder<DeleteGameServerGroupRequest.Builder,DeleteGameServerGroupRequest>
  • Method Details

    • gameServerGroupName

      public final String gameServerGroupName()

      A unique identifier for the game server group. Use either the name or ARN value.

      Returns:
      A unique identifier for the game server group. Use either the name or ARN value.
    • deleteOption

      public final GameServerGroupDeleteOption deleteOption()

      The type of delete to perform. Options include the following:

      • SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

      • FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group.

      • RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.

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

      Returns:
      The type of delete to perform. Options include the following:

      • SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

      • FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group.

      • RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.

      See Also:
    • deleteOptionAsString

      public final String deleteOptionAsString()

      The type of delete to perform. Options include the following:

      • SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

      • FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group.

      • RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.

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

      Returns:
      The type of delete to perform. Options include the following:

      • SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

      • FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group.

      • RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.

      See Also:
    • 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<DeleteGameServerGroupRequest.Builder,DeleteGameServerGroupRequest>
      Specified by:
      toBuilder in class GameLiftRequest
      Returns:
      a builder for type T
    • builder

      public static DeleteGameServerGroupRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends DeleteGameServerGroupRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.