com.amazonaws.services.gamelift.model

Class PlayerLatency

java.lang.Object

com.amazonaws.services.gamelift.model.PlayerLatency

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PlayerLatency
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PlayerLatency()

Method Summary

Modifier and Type	Method and Description
PlayerLatency	clone()
boolean	equals(Object obj)
Float	getLatencyInMilliseconds() Amount of time that represents the time lag experienced by the player when connected to the specified Region.
String	getPlayerId() A unique identifier for a player associated with the latency data.
String	getRegionIdentifier() Name of the Region that is associated with the latency value.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setLatencyInMilliseconds(Float latencyInMilliseconds) Amount of time that represents the time lag experienced by the player when connected to the specified Region.
void	setPlayerId(String playerId) A unique identifier for a player associated with the latency data.
void	setRegionIdentifier(String regionIdentifier) Name of the Region that is associated with the latency value.
String	toString() Returns a string representation of this object.
PlayerLatency	withLatencyInMilliseconds(Float latencyInMilliseconds) Amount of time that represents the time lag experienced by the player when connected to the specified Region.
PlayerLatency	withPlayerId(String playerId) A unique identifier for a player associated with the latency data.
PlayerLatency	withRegionIdentifier(String regionIdentifier) Name of the Region that is associated with the latency value.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PlayerLatency

public PlayerLatency()

Method Detail

setPlayerId

public void setPlayerId(String playerId)

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

Parameters:

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

getPlayerId

public String getPlayerId()

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

Returns:

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

withPlayerId

public PlayerLatency withPlayerId(String playerId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegionIdentifier

public void setRegionIdentifier(String regionIdentifier)

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

Parameters:

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

getRegionIdentifier

public String getRegionIdentifier()

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

Returns:

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

withRegionIdentifier

public PlayerLatency withRegionIdentifier(String regionIdentifier)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLatencyInMilliseconds

public void setLatencyInMilliseconds(Float latencyInMilliseconds)

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

Parameters:

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

getLatencyInMilliseconds

public Float getLatencyInMilliseconds()

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.

withLatencyInMilliseconds

public PlayerLatency withLatencyInMilliseconds(Float latencyInMilliseconds)

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

Parameters:

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

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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