Class PlayerSession

java.lang.Object
software.amazon.awssdk.services.gamelift.model.PlayerSession
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PlayerSession.Builder,PlayerSession>
@Generated("software.amazon.awssdk:codegen") public final class PlayerSession extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PlayerSession.Builder,PlayerSession>

Represents a player session. Player sessions are created either for a specific game session, or as part of a game session placement or matchmaking request. A player session can represents a reserved player slot in a game session (when status is RESERVED) or actual player activity in a game session (when status is ACTIVE). A player session object, including player data, is automatically passed to a game session when the player connects to the game session and is validated. After the game session ends, player sessions information is retained for 30 days and then removed.

Related actions

All APIs by task

See Also:

  • Method Details

    • playerSessionId

      public final String playerSessionId()

      A unique identifier for a player session.

      Returns:
      A unique identifier for a player session.

    • playerId

      public final String playerId()

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

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

    • gameSessionId

      public final String gameSessionId()

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

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

    • fleetId

      public final String fleetId()

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

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

    • fleetArn

      public final String fleetArn()

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

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

    • creationTime

      public final 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").

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

    • terminationTime

      public final 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").

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

    • status

      public final PlayerSessionStatus 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).

      If the service returns an enum value that is not available in the current SDK version, status will return PlayerSessionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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).

      See Also:

    • statusAsString

      public final String statusAsString()

      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).

      If the service returns an enum value that is not available in the current SDK version, status will return PlayerSessionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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).

      See Also:

    • ipAddress

      public final String ipAddress()

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

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

    • dnsName

      public final 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.

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

    • port

      public final Integer port()

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

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

    • playerData

      public final String playerData()

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

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

    • toBuilder

      public PlayerSession.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PlayerSession.Builder,PlayerSession>
      Returns:
      a builder for type T

    • builder

      public static PlayerSession.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PlayerSession.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.