com.amazonaws.services.gamelift.model

Class CreatePlayerSessionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.CreatePlayerSessionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreatePlayerSessionsRequest	addPlayerDataMapEntry(String key, String value) Add a single PlayerDataMap entry
CreatePlayerSessionsRequest	clearPlayerDataMapEntries() Removes all the entries added into PlayerDataMap.
CreatePlayerSessionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getGameSessionId() A unique identifier for the game session to add players to.
Map<String,String>	getPlayerDataMap() Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player.
List<String>	getPlayerIds() List of unique identifiers for the players to be added.
int	hashCode()
void	setGameSessionId(String gameSessionId) A unique identifier for the game session to add players to.
void	setPlayerDataMap(Map<String,String> playerDataMap) Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player.
void	setPlayerIds(Collection<String> playerIds) List of unique identifiers for the players to be added.
String	toString() Returns a string representation of this object.
CreatePlayerSessionsRequest	withGameSessionId(String gameSessionId) A unique identifier for the game session to add players to.
CreatePlayerSessionsRequest	withPlayerDataMap(Map<String,String> playerDataMap) Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player.
CreatePlayerSessionsRequest	withPlayerIds(Collection<String> playerIds) List of unique identifiers for the players to be added.
CreatePlayerSessionsRequest	withPlayerIds(String... playerIds) List of unique identifiers for the players to be added.

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

CreatePlayerSessionsRequest

public CreatePlayerSessionsRequest()

Method Detail

setGameSessionId

public void setGameSessionId(String gameSessionId)

A unique identifier for the game session to add players to.

Parameters:

gameSessionId - A unique identifier for the game session to add players to.

getGameSessionId

public String getGameSessionId()

A unique identifier for the game session to add players to.

Returns:

A unique identifier for the game session to add players to.

withGameSessionId

public CreatePlayerSessionsRequest withGameSessionId(String gameSessionId)

A unique identifier for the game session to add players to.

Parameters:

gameSessionId - A unique identifier for the game session to add players to.

Returns:

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

getPlayerIds

public List<String> getPlayerIds()

List of unique identifiers for the players to be added.

Returns:

List of unique identifiers for the players to be added.

setPlayerIds

public void setPlayerIds(Collection<String> playerIds)

List of unique identifiers for the players to be added.

Parameters:

playerIds - List of unique identifiers for the players to be added.

withPlayerIds

public CreatePlayerSessionsRequest withPlayerIds(String... playerIds)

List of unique identifiers for the players to be added.

NOTE: This method appends the values to the existing list (if any). Use setPlayerIds(java.util.Collection) or withPlayerIds(java.util.Collection) if you want to override the existing values.

Parameters:

playerIds - List of unique identifiers for the players to be added.

Returns:

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

withPlayerIds

public CreatePlayerSessionsRequest withPlayerIds(Collection<String> playerIds)

List of unique identifiers for the players to be added.

Parameters:

playerIds - List of unique identifiers for the players to be added.

Returns:

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

getPlayerDataMap

public Map<String,String> getPlayerDataMap()

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

Returns:

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

setPlayerDataMap

public void setPlayerDataMap(Map<String,String> playerDataMap)

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

Parameters:

playerDataMap - Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

withPlayerDataMap

public CreatePlayerSessionsRequest withPlayerDataMap(Map<String,String> playerDataMap)

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

Parameters:

playerDataMap - Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

Returns:

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

addPlayerDataMapEntry

public CreatePlayerSessionsRequest addPlayerDataMapEntry(String key,
                                                         String value)

Add a single PlayerDataMap entry

See Also:

withPlayerDataMap(java.util.Map<java.lang.String, java.lang.String>)

clearPlayerDataMapEntries

public CreatePlayerSessionsRequest clearPlayerDataMapEntries()

Removes all the entries added into PlayerDataMap.

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