software.amazon.awssdk.services.gamelift.model

Class DeleteGameServerGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.DeleteGameServerGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteGameServerGroupRequest.Builder,DeleteGameServerGroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeleteGameServerGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DeleteGameServerGroupRequest.Builder	builder()
GameServerGroupDeleteOption	deleteOption() The type of delete to perform.
String	deleteOptionAsString() The type of delete to perform.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameServerGroupName() A unique identifier for the game server group.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteGameServerGroupRequest.Builder>	serializableBuilderClass()
DeleteGameServerGroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

GameServerGroupDeleteOption

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:

GameServerGroupDeleteOption

toBuilder

public DeleteGameServerGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteGameServerGroupRequest.Builder,DeleteGameServerGroupRequest>

Specified by:

toBuilder in class GameLiftRequest

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)

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo