Interface PlayerConnectionDetail.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PlayerConnectionDetail.Builder,PlayerConnectionDetail>, SdkBuilder<PlayerConnectionDetail.Builder,PlayerConnectionDetail>, SdkPojo
Enclosing class:
PlayerConnectionDetail
@Mutable @NotThreadSafe public static interface PlayerConnectionDetail.Builder extends SdkPojo, CopyableBuilder<PlayerConnectionDetail.Builder,PlayerConnectionDetail>

  • Method Details

    • playerId

      PlayerConnectionDetail.Builder playerId(String playerId)

      A unique identifier for a player associated with this connection.

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

    • endpoints

      PlayerConnectionDetail.Builder endpoints(Collection<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.

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

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

    • endpoints

      PlayerConnectionDetail.Builder endpoints(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.

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

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

    • endpoints

      PlayerConnectionDetail.Builder endpoints(Consumer<PlayerConnectionEndpoint.Builder>... 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.

      This is a convenience method that creates an instance of the PlayerConnectionEndpoint.Builder avoiding the need to create one manually via PlayerConnectionEndpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpoints(List<PlayerConnectionEndpoint>).

      Parameters:
      endpoints - a consumer that will call methods on PlayerConnectionEndpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • playerGatewayToken

      PlayerConnectionDetail.Builder playerGatewayToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • expiration

      PlayerConnectionDetail.Builder expiration(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.