DeleteGameServerGroupRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.gamelift.model

Class DeleteGameServerGroupRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.gamelift.model.DeleteGameServerGroupRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeleteGameServerGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

DeleteGameServerGroupRequest ()

Constructors
Constructor and Description
`DeleteGameServerGroupRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`DeleteGameServerGroupRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getDeleteOption ()` The type of delete to perform.
`String`	`getGameServerGroupName ()` A unique identifier for the game server group.
`int`	`hashCode ()`
`void`	`setDeleteOption (String deleteOption)` The type of delete to perform.
`void`	`setGameServerGroupName (String gameServerGroupName)` A unique identifier for the game server group.
`String`	`toString ()` Returns a string representation of this object.
`DeleteGameServerGroupRequest`	`withDeleteOption (GameServerGroupDeleteOption deleteOption)` The type of delete to perform.
`DeleteGameServerGroupRequest`	`withDeleteOption (String deleteOption)` The type of delete to perform.
`DeleteGameServerGroupRequest`	`withGameServerGroupName (String gameServerGroupName)` A unique identifier for the game server group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DeleteGameServerGroupRequest
```
public DeleteGameServerGroupRequest()
```
- Method Detail
  - setGameServerGroupName
```
public void setGameServerGroupName(String gameServerGroupName)
```
    A unique identifier for the game server group. Use either the name or ARN value.
    
    Parameters:
    
    gameServerGroupName - A unique identifier for the game server group. Use either the name or ARN value.
  - getGameServerGroupName
```
public String getGameServerGroupName()
```
    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.
  - withGameServerGroupName
```
public DeleteGameServerGroupRequest withGameServerGroupName(String gameServerGroupName)
```
    A unique identifier for the game server group. Use either the name or ARN value.
    
    Parameters:
    
    gameServerGroupName - A unique identifier for the game server group. Use either the name or ARN value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeleteOption
```
public void setDeleteOption(String 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.
    Parameters:
    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.
    See Also:
    
    GameServerGroupDeleteOption
  - getDeleteOption
```
public String getDeleteOption()
```
    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.
    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
  - withDeleteOption
```
public DeleteGameServerGroupRequest withDeleteOption(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameServerGroupDeleteOption
  - withDeleteOption
```
public DeleteGameServerGroupRequest withDeleteOption(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameServerGroupDeleteOption
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DeleteGameServerGroupRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class DeleteGameServerGroupRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DeleteGameServerGroupRequest

Method Detail

setGameServerGroupName

getGameServerGroupName

withGameServerGroupName

setDeleteOption

getDeleteOption

withDeleteOption

withDeleteOption

toString

equals

hashCode

clone