software.amazon.awssdk.services.gamelift.model

Class Player

java.lang.Object

software.amazon.awssdk.services.gamelift.model.Player

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Player.Builder,Player>

@Generated(value="software.amazon.awssdk:codegen")
public final class Player
extends Object
implements StructuredPojo, ToCopyableBuilder<Player.Builder,Player>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Player.Builder

Method Summary

Modifier and Type	Method and Description
static Player.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
Map<String,AttributeValue>	playerAttributes() Collection of name:value pairs containing player information for use in matchmaking.
String	playerId() Unique identifier for a player
static Class<? extends Player.Builder>	serializableBuilderClass()
String	team() Name of the team that the player is assigned to in a match.
Player.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

playerId

public String playerId()

Unique identifier for a player

Returns:

Unique identifier for a player

playerAttributes

public 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"}}.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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"}}.

team

public String team()

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.

latencyInMs

public 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

toBuilder

public Player.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Player.Builder,Player>

Returns:

a builder for type T

builder

public static Player.Builder builder()

serializableBuilderClass

public static Class<? extends Player.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.