Class GameSessionConnectionInfo

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

Connection information for a new game session that is created in response to a start matchmaking request. Once a match is made, the FlexMatch engine creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the matchmaking ticket.

See Also:

  • Method Details

    • gameSessionArn

      public final String gameSessionArn()

      A unique identifier for the game session. Use the game session ID.

      Returns:
      A unique identifier for the game session. Use the game session ID.

    • 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()

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

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

    • hasMatchedPlayerSessions

      public final boolean hasMatchedPlayerSessions()
      For responses, this returns true if the service returned a value for the MatchedPlayerSessions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • matchedPlayerSessions

      public final List<MatchedPlayerSession> matchedPlayerSessions()

      A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMatchedPlayerSessions() method.

      Returns:
      A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

    • playerGatewayStatus

      public final PlayerGatewayStatus playerGatewayStatus()

      The current status of player gateway for the game session. Note, even if a fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see supported locations.

      Possible values include:

      • ENABLED -- Player gateway is available for this game session.

      • DISABLED -- Player gateway is not available for this game session.

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

      Returns:
      The current status of player gateway for the game session. Note, even if a fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see supported locations.

      Possible values include:

      • ENABLED -- Player gateway is available for this game session.

      • DISABLED -- Player gateway is not available for this game session.

      See Also:

    • playerGatewayStatusAsString

      public final String playerGatewayStatusAsString()

      The current status of player gateway for the game session. Note, even if a fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see supported locations.

      Possible values include:

      • ENABLED -- Player gateway is available for this game session.

      • DISABLED -- Player gateway is not available for this game session.

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

      Returns:
      The current status of player gateway for the game session. Note, even if a fleet has PlayerGatewayMode configured as ENABLED, player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see supported locations.

      Possible values include:

      • ENABLED -- Player gateway is available for this game session.

      • DISABLED -- Player gateway is not available for this game session.

      See Also:

    • toBuilder

      public GameSessionConnectionInfo.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<GameSessionConnectionInfo.Builder,GameSessionConnectionInfo>
      Returns:
      a builder for type T

    • builder

      public static GameSessionConnectionInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GameSessionConnectionInfo.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.