software.amazon.awssdk.services.gamelift.model

Class GameSessionConnectionInfo

java.lang.Object

software.amazon.awssdk.services.gamelift.model.GameSessionConnectionInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GameSessionConnectionInfo.Builder,GameSessionConnectionInfo>

@Generated(value="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 StartMatchmaking 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 MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GameSessionConnectionInfo.Builder

Method Summary

Modifier and Type	Method and Description
static GameSessionConnectionInfo.Builder	builder()
String	dnsName() DNS identifier assigned to the instance that is running the game session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameSessionArn() Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMatchedPlayerSessions() Returns true if the MatchedPlayerSessions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	ipAddress() IP address of the instance that is running the game session.
List<MatchedPlayerSession>	matchedPlayerSessions() A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
Integer	port() Port number for the game session.
List<SdkField<?>>	sdkFields()
static Class<? extends GameSessionConnectionInfo.Builder>	serializableBuilderClass()
GameSessionConnectionInfo.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

gameSessionArn

public final String gameSessionArn()

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.

Returns:

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.

ipAddress

public final String ipAddress()

IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.

Returns:

IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.

dnsName

public final String dnsName()

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:

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 game server, an app needs both the IP address and port number.

Returns:

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

hasMatchedPlayerSessions

public final boolean hasMatchedPlayerSessions()

Returns true if the MatchedPlayerSessions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasMatchedPlayerSessions() to see if a value was sent in this field.

Returns:

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

toBuilder

public GameSessionConnectionInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GameSessionConnectionInfo.Builder,GameSessionConnectionInfo>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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