Class Player
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Player.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LatencyInMs property.final boolean
For responses, this returns true if the service returned a value for the PlayerAttributes property.A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions.final Map
<String, AttributeValue> A collection of key:value pairs containing player information for use in matchmaking.final String
playerId()
A unique identifier for a playerstatic Class
<? extends Player.Builder> final String
team()
Name of the team that the player is assigned to in a match.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<Player.Builder,
Player> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-