Interface PlayerSession.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PlayerSession.Builder,PlayerSession>, SdkBuilder<PlayerSession.Builder,PlayerSession>, SdkPojo
Enclosing class:
PlayerSession

public static interface PlayerSession.Builder extends SdkPojo, CopyableBuilder<PlayerSession.Builder,PlayerSession>
  • Method Details

    • playerSessionId

      PlayerSession.Builder playerSessionId(String playerSessionId)

      A unique identifier for a player session.

      Parameters:
      playerSessionId - A unique identifier for a player session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • playerId

      PlayerSession.Builder playerId(String playerId)

      A unique identifier for a player that is associated with this player session.

      Parameters:
      playerId - A unique identifier for a player that is associated with this player session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • gameSessionId

      PlayerSession.Builder gameSessionId(String gameSessionId)

      A unique identifier for the game session that the player session is connected to.

      Parameters:
      gameSessionId - A unique identifier for the game session that the player session is connected to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fleetId

      PlayerSession.Builder fleetId(String fleetId)

      A unique identifier for the fleet that the player's game session is running on.

      Parameters:
      fleetId - A unique identifier for the fleet that the player's game session is running on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fleetArn

      PlayerSession.Builder fleetArn(String fleetArn)

      The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

      Parameters:
      fleetArn - The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • creationTime

      PlayerSession.Builder creationTime(Instant creationTime)

      A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      Parameters:
      creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • terminationTime

      PlayerSession.Builder terminationTime(Instant terminationTime)

      A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      Parameters:
      terminationTime - A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      PlayerSession.Builder status(String status)

      Current status of the player session.

      Possible player session statuses include the following:

      • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

      • ACTIVE -- The player has been validated by the server process and is currently connected.

      • COMPLETED -- The player connection has been dropped.

      • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

      Parameters:
      status - Current status of the player session.

      Possible player session statuses include the following:

      • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

      • ACTIVE -- The player has been validated by the server process and is currently connected.

      • COMPLETED -- The player connection has been dropped.

      • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      Current status of the player session.

      Possible player session statuses include the following:

      • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

      • ACTIVE -- The player has been validated by the server process and is currently connected.

      • COMPLETED -- The player connection has been dropped.

      • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

      Parameters:
      status - Current status of the player session.

      Possible player session statuses include the following:

      • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

      • ACTIVE -- The player has been validated by the server process and is currently connected.

      • COMPLETED -- The player connection has been dropped.

      • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • ipAddress

      PlayerSession.Builder ipAddress(String ipAddress)

      The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

      Parameters:
      ipAddress - The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dnsName

      PlayerSession.Builder dnsName(String dnsName)

      The DNS identifier assigned to the instance that is running the game session. Values have the following format:

      • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

      • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

      When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

      Parameters:
      dnsName - The DNS identifier assigned to the instance that is running the game session. Values have the following format:

      • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

      • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

      When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • port

      Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

      Parameters:
      port - Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • playerData

      PlayerSession.Builder playerData(String playerData)

      Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

      Parameters:
      playerData - Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
      Returns:
      Returns a reference to this object so that method calls can be chained together.