Player (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.Player

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Player
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Player()

Constructors
Constructor and Description
`Player()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Player`	`addLatencyInMsEntry(String key, Integer value)`
`Player`	`addPlayerAttributesEntry(String key, AttributeValue value)`
`Player`	`clearLatencyInMsEntries()` Removes all the entries added into LatencyInMs.
`Player`	`clearPlayerAttributesEntries()` Removes all the entries added into PlayerAttributes.
`Player`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,Integer>`	`getLatencyInMs()` Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
`Map<String,AttributeValue>`	`getPlayerAttributes()` Collection of name:value pairs containing player information for use in matchmaking.
`String`	`getPlayerId()` Unique identifier for a player
`String`	`getTeam()` Name of the team that the player is assigned to in a match.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setLatencyInMs(Map<String,Integer> latencyInMs)` Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
`void`	`setPlayerAttributes(Map<String,AttributeValue> playerAttributes)` Collection of name:value pairs containing player information for use in matchmaking.
`void`	`setPlayerId(String playerId)` Unique identifier for a player
`void`	`setTeam(String team)` Name of the team that the player is assigned to in a match.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Player`	`withLatencyInMs(Map<String,Integer> latencyInMs)` Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
`Player`	`withPlayerAttributes(Map<String,AttributeValue> playerAttributes)` Collection of name:value pairs containing player information for use in matchmaking.
`Player`	`withPlayerId(String playerId)` Unique identifier for a player
`Player`	`withTeam(String team)` Name of the team that the player is assigned to in a match.

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

- Constructor Detail
  - Player
```
public Player()
```
- Method Detail
  - setPlayerId
```
public void setPlayerId(String playerId)
```
    Unique identifier for a player
    
    Parameters:
    
    playerId - Unique identifier for a player
  - getPlayerId
```
public String getPlayerId()
```
    Unique identifier for a player
    
    Returns:
    
    Unique identifier for a player
  - withPlayerId
```
public Player withPlayerId(String playerId)
```
    Unique identifier for a player
    
    Parameters:
    
    playerId - Unique identifier for a player
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPlayerAttributes
```
public Map<String,AttributeValue> getPlayerAttributes()
```
    Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.
    
    Returns:
    
    Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.
  - setPlayerAttributes
```
public void setPlayerAttributes(Map<String,AttributeValue> playerAttributes)
```
    Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.
    
    Parameters:
    
    playerAttributes - Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.
  - withPlayerAttributes
```
public Player withPlayerAttributes(Map<String,AttributeValue> playerAttributes)
```
    Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.
    
    Parameters:
    
    playerAttributes - Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addPlayerAttributesEntry
```
public Player addPlayerAttributesEntry(String key,
                                       AttributeValue value)
```
  - clearPlayerAttributesEntries
```
public Player clearPlayerAttributesEntries()
```
    Removes all the entries added into PlayerAttributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTeam
```
public void setTeam(String team)
```
    Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
    
    Parameters:
    
    team - Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
  - getTeam
```
public String getTeam()
```
    Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
    
    Returns:
    
    Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
  - withTeam
```
public Player withTeam(String team)
```
    Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
    
    Parameters:
    
    team - Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLatencyInMs
```
public Map<String,Integer> getLatencyInMs()
```
    Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
    
    If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
    
    Returns:
    
    Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
    
    If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
  - setLatencyInMs
```
public void setLatencyInMs(Map<String,Integer> latencyInMs)
```
    Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
    
    If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
    
    Parameters:
    
    latencyInMs - Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
    
    If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
  - withLatencyInMs
```
public Player withLatencyInMs(Map<String,Integer> latencyInMs)
```
    Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
    
    If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
    
    Parameters:
    
    latencyInMs - Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
    
    If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addLatencyInMsEntry
```
public Player addLatencyInMsEntry(String key,
                                  Integer value)
```
  - clearLatencyInMsEntries
```
public Player clearLatencyInMsEntries()
```
    Removes all the entries added into LatencyInMs.
    
    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; useful for testing and debugging.
    
    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 Player clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Player

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Player

Method Detail

setPlayerId

getPlayerId

withPlayerId

getPlayerAttributes

setPlayerAttributes

withPlayerAttributes

addPlayerAttributesEntry

clearPlayerAttributesEntries

setTeam

getTeam

withTeam

getLatencyInMs

setLatencyInMs

withLatencyInMs

addLatencyInMsEntry

clearLatencyInMsEntries

toString

equals

hashCode

clone

marshall