software.amazon.awssdk.services.gamelift.model

Class Player

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Player.Builder,Player>

@Generated(value="software.amazon.awssdk:codegen")
public final class Player
extends Object
implements SdkPojo, Serializable, 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.

See Also:

Serialized Form

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLatencyInMs() For responses, this returns true if the service returned a value for the LatencyInMs property.
boolean	hasPlayerAttributes() For responses, this returns true if the service returned a value for the PlayerAttributes property.
Map<String,Integer>	latencyInMs() A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions.
Map<String,AttributeValue>	playerAttributes() A collection of key:value pairs containing player information for use in matchmaking.
String	playerId() A unique identifier for a player
List<SdkField<?>>	sdkFields()
static Class<? extends Player.Builder>	serializableBuilderClass()
String	team() Name of the team that the player is assigned to in a match.
Player.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

playerId

public final String playerId()

A unique identifier for a player

Returns:

A unique identifier for a player

hasPlayerAttributes

public final boolean hasPlayerAttributes()

For responses, this returns true if the service returned a value for the PlayerAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

playerAttributes

public final Map<String,AttributeValue> playerAttributes()

A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

You can provide up to 10 PlayerAttributes.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlayerAttributes() method.

Returns:

A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

You can provide up to 10 PlayerAttributes.

team

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

hasLatencyInMs

public final boolean hasLatencyInMs()

For responses, this returns true if the service returned a value for the LatencyInMs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

latencyInMs

public final Map<String,Integer> latencyInMs()

A set of values, expressed in milliseconds, that indicates 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLatencyInMs() method.

Returns:

A set of values, expressed in milliseconds, that indicates 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()

Specified by:

toBuilder in interface ToCopyableBuilder<Player.Builder,Player>

builder

public static Player.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo