Package software.amazon.awssdk.services.gamelift.model

Class PlayerLatency

java.lang.Object

software.amazon.awssdk.services.gamelift.model.PlayerLatency

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class PlayerLatency
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PlayerLatency.Builder,PlayerLatency>

Regional latency information for a player, used when requesting a new game session. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified Region. The relative difference between a player's latency values for multiple Regions are used to determine which fleets are best suited to place a new game session for the player.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PlayerLatency.Builder

Method Summary

Modifier and Type	Method	Description
static PlayerLatency.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Float	latencyInMilliseconds()	Amount of time that represents the time lag experienced by the player when connected to the specified Region.
String	playerId()	A unique identifier for a player associated with the latency data.
String	regionIdentifier()	Name of the Region that is associated with the latency value.
List<SdkField<?>>	sdkFields()
static Class<? extends PlayerLatency.Builder>	serializableBuilderClass()
PlayerLatency.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 associated with the latency data.

Returns:

A unique identifier for a player associated with the latency data.

regionIdentifier

public final String regionIdentifier()

Name of the Region that is associated with the latency value.

Returns:

Name of the Region that is associated with the latency value.

latencyInMilliseconds

public final Float latencyInMilliseconds()

Amount of time that represents the time lag experienced by the player when connected to the specified Region.

Returns:

Amount of time that represents the time lag experienced by the player when connected to the specified Region.

toBuilder

public PlayerLatency.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PlayerLatency.Builder,PlayerLatency>

builder

public static PlayerLatency.Builder builder()

serializableBuilderClass

public static Class<? extends PlayerLatency.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