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)
ClaimFilterOption	getFilterOption() Object that restricts how a claimed game server is chosen.
String	getGameServerData() A set of custom game server properties, formatted as a single string value.
String	getGameServerGroupName() A unique identifier for the game server group where the game server is running.
String	getGameServerId() A custom string that uniquely identifies the game server to claim.
int	hashCode()
void	setFilterOption(ClaimFilterOption filterOption) Object that restricts how a claimed game server is chosen.
void	setGameServerData(String gameServerData) A set of custom game server properties, formatted as a single string value.
void	setGameServerGroupName(String gameServerGroupName) A unique identifier for the game server group where the game server is running.
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	withFilterOption(ClaimFilterOption filterOption) Object that restricts how a claimed game server is chosen.
ClaimGameServerRequest	withGameServerData(String gameServerData) A set of custom game server properties, formatted as a single string value.
ClaimGameServerRequest	withGameServerGroupName(String gameServerGroupName) A unique identifier for the game server group where the game server is running.
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)

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

Parameters:

gameServerGroupName - A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

getGameServerGroupName

public String getGameServerGroupName()

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

Returns:

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

withGameServerGroupName

public ClaimGameServerRequest withGameServerGroupName(String gameServerGroupName)

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

Parameters:

gameServerGroupName - A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

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, Amazon 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, Amazon 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, Amazon 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, Amazon 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, Amazon 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, Amazon 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. This data is passed to a game client or service when it requests information on game servers.

Parameters:

gameServerData - A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

getGameServerData

public String getGameServerData()

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

Returns:

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

withGameServerData

public ClaimGameServerRequest withGameServerData(String gameServerData)

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

Parameters:

gameServerData - A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

Returns:

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

setFilterOption

public void setFilterOption(ClaimFilterOption filterOption)

Object that restricts how a claimed game server is chosen.

Parameters:

filterOption - Object that restricts how a claimed game server is chosen.

getFilterOption

public ClaimFilterOption getFilterOption()

Object that restricts how a claimed game server is chosen.

Returns:

Object that restricts how a claimed game server is chosen.

withFilterOption

public ClaimGameServerRequest withFilterOption(ClaimFilterOption filterOption)

Object that restricts how a claimed game server is chosen.

Parameters:

filterOption - Object that restricts how a claimed game server is chosen.

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