com.amazonaws.services.gamelift.model

Class ClaimGameServerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.ClaimGameServerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ClaimGameServerRequest
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
ClaimGameServerRequest()

Method Summary

Modifier and Type	Method and Description
ClaimGameServerRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getGameServerData() A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.
String	getGameServerGroupName() An identifier for the game server group.
String	getGameServerId() A custom string that uniquely identifies the game server to claim.
int	hashCode()
void	setGameServerData(String gameServerData) A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.
void	setGameServerGroupName(String gameServerGroupName) An identifier for the game server group.
void	setGameServerId(String gameServerId) A custom string that uniquely identifies the game server to claim.
String	toString() Returns a string representation of this object.
ClaimGameServerRequest	withGameServerData(String gameServerData) A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.
ClaimGameServerRequest	withGameServerGroupName(String gameServerGroupName) An identifier for the game server group.
ClaimGameServerRequest	withGameServerId(String gameServerId) A custom string that uniquely identifies the game server to claim.

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

ClaimGameServerRequest

public ClaimGameServerRequest()

Method Detail

setGameServerGroupName

public void setGameServerGroupName(String gameServerGroupName)

An identifier for the game server group. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.

Parameters:

gameServerGroupName - An identifier for the game server group. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.

getGameServerGroupName

public String getGameServerGroupName()

An identifier for the game server group. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.

Returns:

An identifier for the game server group. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.

withGameServerGroupName

public ClaimGameServerRequest withGameServerGroupName(String gameServerGroupName)

An identifier for the game server group. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.

Parameters:

gameServerGroupName - An identifier for the game server group. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.

Returns:

Returns a reference to this object so that method calls can be chained together.

setGameServerId

public void setGameServerId(String gameServerId)

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.

Parameters:

gameServerId - A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.

getGameServerId

public String getGameServerId()

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.

Returns:

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.

withGameServerId

public ClaimGameServerRequest withGameServerId(String gameServerId)

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.

Parameters:

gameServerId - A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.

Returns:

Returns a reference to this object so that method calls can be chained together.

setGameServerData

public void setGameServerData(String gameServerData)

A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.

Parameters:

gameServerData - A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.

getGameServerData

public String getGameServerData()

A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.

Returns:

A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.

withGameServerData

public ClaimGameServerRequest withGameServerData(String gameServerData)

A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.

Parameters:

gameServerData - A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.

Returns:

Returns a reference to this object so that method calls can be chained together.

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 ClaimGameServerRequest 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()