Amazonka.GameLift.Types.PlayerLatency

Documentation

data 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: 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.

• playerId :: Maybe Text

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

• regionIdentifier :: Maybe Text

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

Instances

FromJSON PlayerLatency

Defined in Amazonka.GameLift.Types.PlayerLatency

Methods

parseJSON :: Value -> Parser PlayerLatency

parseJSONList :: Value -> Parser [PlayerLatency]

ToJSON PlayerLatency

Defined in Amazonka.GameLift.Types.PlayerLatency

Methods

toJSON :: PlayerLatency -> Value

toEncoding :: PlayerLatency -> Encoding

toJSONList :: [PlayerLatency] -> Value

toEncodingList :: [PlayerLatency] -> Encoding

Generic PlayerLatency

Defined in Amazonka.GameLift.Types.PlayerLatency

Associated Types

type Rep PlayerLatency :: Type -> Type

Methods

from :: PlayerLatency -> Rep PlayerLatency x

to :: Rep PlayerLatency x -> PlayerLatency

Read PlayerLatency

Defined in Amazonka.GameLift.Types.PlayerLatency

Methods

readsPrec :: Int -> ReadS PlayerLatency

readList :: ReadS [PlayerLatency]

readPrec :: ReadPrec PlayerLatency

readListPrec :: ReadPrec [PlayerLatency]

Show PlayerLatency

Defined in Amazonka.GameLift.Types.PlayerLatency

Methods

showsPrec :: Int -> PlayerLatency -> ShowS

show :: PlayerLatency -> String

showList :: [PlayerLatency] -> ShowS

NFData PlayerLatency

Defined in Amazonka.GameLift.Types.PlayerLatency

Methods

rnf :: PlayerLatency -> ()

Eq PlayerLatency

Defined in Amazonka.GameLift.Types.PlayerLatency

Methods

(==) :: PlayerLatency -> PlayerLatency -> Bool

(/=) :: PlayerLatency -> PlayerLatency -> Bool

Hashable PlayerLatency

Defined in Amazonka.GameLift.Types.PlayerLatency

Methods

hashWithSalt :: Int -> PlayerLatency -> Int

hash :: PlayerLatency -> Int

type Rep PlayerLatency

Defined in Amazonka.GameLift.Types.PlayerLatency

type Rep PlayerLatency = D1 ('MetaData "PlayerLatency" "Amazonka.GameLift.Types.PlayerLatency" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "PlayerLatency'" 'PrefixI 'True) (S1 ('MetaSel ('Just "latencyInMilliseconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "playerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "regionIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newPlayerLatency :: PlayerLatency

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:playerId:PlayerLatency', playerLatency_playerId - A unique identifier for a player associated with the latency data.

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

playerLatency_latencyInMilliseconds :: Lens' PlayerLatency (Maybe Double)

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

playerLatency_playerId :: Lens' PlayerLatency (Maybe Text)

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

playerLatency_regionIdentifier :: Lens' PlayerLatency (Maybe Text)

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