Class: Aws::GameLift::Types::PlayerLatency
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::PlayerLatency
- Defined in:
- gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb
Overview
When making an API call, you may pass PlayerLatency data as a hash:
{
player_id: "NonZeroAndMaxString",
region_identifier: "NonZeroAndMaxString",
latency_in_milliseconds: 1.0,
}
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#latency_in_milliseconds ⇒ Float
Amount of time that represents the time lag experienced by the player when connected to the specified Region.
-
#player_id ⇒ String
A unique identifier for a player associated with the latency data.
-
#region_identifier ⇒ String
Name of the Region that is associated with the latency value.
Instance Attribute Details
#latency_in_milliseconds ⇒ Float
Amount of time that represents the time lag experienced by the player when connected to the specified Region.
7417 7418 7419 7420 7421 7422 7423 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7417 class PlayerLatency < Struct.new( :player_id, :region_identifier, :latency_in_milliseconds) SENSITIVE = [] include Aws::Structure end |
#player_id ⇒ String
A unique identifier for a player associated with the latency data.
7417 7418 7419 7420 7421 7422 7423 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7417 class PlayerLatency < Struct.new( :player_id, :region_identifier, :latency_in_milliseconds) SENSITIVE = [] include Aws::Structure end |
#region_identifier ⇒ String
Name of the Region that is associated with the latency value.
7417 7418 7419 7420 7421 7422 7423 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7417 class PlayerLatency < Struct.new( :player_id, :region_identifier, :latency_in_milliseconds) SENSITIVE = [] include Aws::Structure end |