Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GameLift.Types.PlayerLatency

Description

Documentation

data PlayerLatency Source #

Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement. 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: newPlayerLatency smart constructor.

Constructors

PlayerLatency'
Fields latencyInMilliseconds :: Maybe Double Amount of time that represents the time lag experienced by the player when connected to the specified Region. regionIdentifier :: Maybe Text Name of the Region that is associated with the latency value. playerId :: Maybe Text A unique identifier for a player associated with the latency data.

Instances

Instances details

Eq PlayerLatency Source #
Instance details Defined in Amazonka.GameLift.Types.PlayerLatency Methods (==) :: PlayerLatency -> PlayerLatency -> Bool # (/=) :: PlayerLatency -> PlayerLatency -> Bool #
Read PlayerLatency Source #
Instance details Defined in Amazonka.GameLift.Types.PlayerLatency Methods readsPrec :: Int -> ReadS PlayerLatency # readList :: ReadS [PlayerLatency] # readPrec :: ReadPrec PlayerLatency # readListPrec :: ReadPrec [PlayerLatency] #
Show PlayerLatency Source #
Instance details Defined in Amazonka.GameLift.Types.PlayerLatency Methods showsPrec :: Int -> PlayerLatency -> ShowS # show :: PlayerLatency -> String # showList :: [PlayerLatency] -> ShowS #
Generic PlayerLatency Source #
Instance details Defined in Amazonka.GameLift.Types.PlayerLatency Associated Types type Rep PlayerLatency :: Type -> Type # Methods from :: PlayerLatency -> Rep PlayerLatency x # to :: Rep PlayerLatency x -> PlayerLatency #
NFData PlayerLatency Source #
Instance details Defined in Amazonka.GameLift.Types.PlayerLatency Methods rnf :: PlayerLatency -> () #
Hashable PlayerLatency Source #
Instance details Defined in Amazonka.GameLift.Types.PlayerLatency Methods hashWithSalt :: Int -> PlayerLatency -> Int # hash :: PlayerLatency -> Int #
ToJSON PlayerLatency Source #
Instance details Defined in Amazonka.GameLift.Types.PlayerLatency Methods toJSON :: PlayerLatency -> Value # toEncoding :: PlayerLatency -> Encoding # toJSONList :: [PlayerLatency] -> Value # toEncodingList :: [PlayerLatency] -> Encoding #
FromJSON PlayerLatency Source #
Instance details Defined in Amazonka.GameLift.Types.PlayerLatency Methods parseJSON :: Value -> Parser PlayerLatency # parseJSONList :: Value -> Parser [PlayerLatency] #
type Rep PlayerLatency Source #
Instance details Defined in Amazonka.GameLift.Types.PlayerLatency type Rep PlayerLatency = D1 ('MetaData "PlayerLatency" "Amazonka.GameLift.Types.PlayerLatency" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "PlayerLatency'" 'PrefixI 'True) (S1 ('MetaSel ('Just "latencyInMilliseconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "regionIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "playerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newPlayerLatency :: PlayerLatency Source #

Create a value of PlayerLatency with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:latencyInMilliseconds:PlayerLatency', playerLatency_latencyInMilliseconds - Amount of time that represents the time lag experienced by the player when connected to the specified Region.

$sel:regionIdentifier:PlayerLatency', playerLatency_regionIdentifier - Name of the Region that is associated with the latency value.

$sel:playerId:PlayerLatency', playerLatency_playerId - A unique identifier for a player associated with the latency data.

playerLatency_latencyInMilliseconds :: Lens' PlayerLatency (Maybe Double) Source #

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

playerLatency_regionIdentifier :: Lens' PlayerLatency (Maybe Text) Source #

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

playerLatency_playerId :: Lens' PlayerLatency (Maybe Text) Source #

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