Interface GameSessionConnectionInfo.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GameSessionConnectionInfo.Builder,GameSessionConnectionInfo>, SdkBuilder<GameSessionConnectionInfo.Builder,GameSessionConnectionInfo>, SdkPojo

Enclosing class:

GameSessionConnectionInfo

@Mutable
@NotThreadSafe
public static interface GameSessionConnectionInfo.Builder
extends SdkPojo, CopyableBuilder<GameSessionConnectionInfo.Builder,GameSessionConnectionInfo>

Method Summary

Modifier and Type	Method	Description
GameSessionConnectionInfo.Builder	dnsName(String dnsName)	The DNS identifier assigned to the instance that is running the game session.
GameSessionConnectionInfo.Builder	gameSessionArn(String gameSessionArn)	A unique identifier for the game session.
GameSessionConnectionInfo.Builder	ipAddress(String ipAddress)	The IP address of the game session.
GameSessionConnectionInfo.Builder	matchedPlayerSessions(Collection<MatchedPlayerSession> matchedPlayerSessions)	A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
GameSessionConnectionInfo.Builder	matchedPlayerSessions(Consumer<MatchedPlayerSession.Builder>... matchedPlayerSessions)	A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
GameSessionConnectionInfo.Builder	matchedPlayerSessions(MatchedPlayerSession... matchedPlayerSessions)	A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
GameSessionConnectionInfo.Builder	playerGatewayStatus(String playerGatewayStatus)	The current status of player gateway for the game session.
GameSessionConnectionInfo.Builder	playerGatewayStatus(PlayerGatewayStatus playerGatewayStatus)	The current status of player gateway for the game session.
GameSessionConnectionInfo.Builder	port(Integer port)	The port number for the game session.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

gameSessionArn

GameSessionConnectionInfo.Builder gameSessionArn(String gameSessionArn)

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

Parameters:

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

Returns:

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

ipAddress

GameSessionConnectionInfo.Builder ipAddress(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.

Parameters:

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:

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

dnsName

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

GameSessionConnectionInfo.Builder port(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.

Parameters:

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:

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

matchedPlayerSessions

GameSessionConnectionInfo.Builder matchedPlayerSessions(Collection<MatchedPlayerSession> matchedPlayerSessions)

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

Parameters:

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

Returns:

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

matchedPlayerSessions

GameSessionConnectionInfo.Builder matchedPlayerSessions(MatchedPlayerSession... matchedPlayerSessions)

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

Parameters:

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

Returns:

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

matchedPlayerSessions

GameSessionConnectionInfo.Builder matchedPlayerSessions(Consumer<MatchedPlayerSession.Builder>... matchedPlayerSessions)

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

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

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

Parameters:

matchedPlayerSessions - a consumer that will call methods on MatchedPlayerSession.Builder

Returns:

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

See Also:

• matchedPlayerSessions(java.util.Collection<MatchedPlayerSession>)

playerGatewayStatus

GameSessionConnectionInfo.Builder playerGatewayStatus(String 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.

Parameters:

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.

Returns:

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

See Also:

• PlayerGatewayStatus
• PlayerGatewayStatus

playerGatewayStatus

GameSessionConnectionInfo.Builder playerGatewayStatus(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.

Parameters:

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.

Returns:

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

See Also:

• PlayerGatewayStatus
• PlayerGatewayStatus