Class PlayerConnectionDetail

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

Connection information for a game client to connect to a game session. This object contains the IP address(es), port(s), and authentication details your game client needs to establish a connection.

With player gateway enabled: Contains relay endpoints and a player gateway token. Your game client must prepend player gateway token to each payload for validation and connection through relay endpoints.

With player gateway disabled: Contains game server endpoint. Player gateway token and expiration fields are empty.

See Also:

  • Method Details

    • playerId

      public final String playerId()

      A unique identifier for a player associated with this connection.

      Returns:
      A unique identifier for a player associated with this connection.

    • hasEndpoints

      public final boolean hasEndpoints()
      For responses, this returns true if the service returned a value for the Endpoints 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.

    • endpoints

      public final List<PlayerConnectionEndpoint> endpoints()

      List of connection endpoints for the game client. Your game client uses these IP address(es) and port(s) to connect to the game session.

      When player gateway is enabled, these are relay endpoints with benefits such as DDoS protection. When disabled, this is the game server endpoint.

      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 hasEndpoints() method.

      Returns:
      List of connection endpoints for the game client. Your game client uses these IP address(es) and port(s) to connect to the game session.

      When player gateway is enabled, these are relay endpoints with benefits such as DDoS protection. When disabled, this is the game server endpoint.

    • playerGatewayToken

      public final String playerGatewayToken()

      Access token that your game client must prepend to all traffic sent through player gateway. Player gateway verifies identity and authorizes connection based on this token.

      This value is empty when player gateway is disabled.

      Returns:
      Access token that your game client must prepend to all traffic sent through player gateway. Player gateway verifies identity and authorizes connection based on this token.

      This value is empty when player gateway is disabled.

    • expiration

      public final Instant expiration()

      When player gateway is enabled, this is the timestamp indicating when player gateway token expires. Your game backend should call GetPlayerConnectionDetails to retrieve fresh connection information for your game clients before this time. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      This value is empty when player gateway is disabled.

      Returns:
      When player gateway is enabled, this is the timestamp indicating when player gateway token expires. Your game backend should call GetPlayerConnectionDetails to retrieve fresh connection information for your game clients before this time. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      This value is empty when player gateway is disabled.

    • toBuilder

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

    • builder

      public static PlayerConnectionDetail.Builder builder()

    • serializableBuilderClass

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