You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GameLift::Types::PlayerLatency

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

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.

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (Float) 


5457
5458
5459
5460
5461
5462
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5457

class PlayerLatency < Struct.new(
  :player_id,
  :region_identifier,
  :latency_in_milliseconds)
  include Aws::Structure
end

#player_id ⇒ String

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

Returns:

  • (String) 


5457
5458
5459
5460
5461
5462
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5457

class PlayerLatency < Struct.new(
  :player_id,
  :region_identifier,
  :latency_in_milliseconds)
  include Aws::Structure
end

#region_identifier ⇒ String

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

Returns:

  • (String) 


5457
5458
5459
5460
5461
5462
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5457

class PlayerLatency < Struct.new(
  :player_id,
  :region_identifier,
  :latency_in_milliseconds)
  include Aws::Structure
end