GameSessionPlacement class

Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.

Game session placement-related operations include:

Constructors

GameSessionPlacement({String? dnsName, DateTime? endTime, List<GameProperty>? gameProperties, String? gameSessionArn, String? gameSessionData, String? gameSessionId, String? gameSessionName, String? gameSessionQueueName, String? gameSessionRegion, String? ipAddress, String? matchmakerData, int? maximumPlayerSessionCount, List<PlacedPlayerSession>? placedPlayerSessions, String? placementId, List<PlayerLatency>? playerLatencies, int? port, DateTime? startTime, GameSessionPlacementState? status})
GameSessionPlacement.fromJson(Map<String, dynamic> json)
factory

Properties

dnsName → String?
DNS identifier assigned to the instance that is running the game session. Values have the following format:
final
endTime → DateTime?
Time stamp indicating when this request was completed, canceled, or timed out.
final
gameProperties → List<GameProperty>?
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
final
gameSessionArn → String?
Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.
final
gameSessionData → String?
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
final
gameSessionId → String?
A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).
final
gameSessionName → String?
A descriptive label that is associated with a game session. Session names do not need to be unique.
final
gameSessionQueueName → String?
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
final
gameSessionRegion → String?
Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).
final
hashCode → int
The hash code for this object.
no setterinherited
ipAddress → String?
IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number. This value is set once the new game session is placed (placement status is FULFILLED).
final
matchmakerData → String?
Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
final
maximumPlayerSessionCount → int?
The maximum number of players that can be connected simultaneously to the game session.
final
placedPlayerSessions → List<PlacedPlayerSession>?
A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
final
placementId → String?
A unique identifier for a game session placement.
final
playerLatencies → List<PlayerLatency>?
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions.
final
port → int?
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startTime → DateTime?
Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
final
status → GameSessionPlacementState?
Current status of the game session placement request.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited