GameSessionConnectionInfo (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.GameSessionConnectionInfo

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GameSessionConnectionInfo
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Connection information for the new game session that is created with matchmaking. (with StartMatchmaking). Once a match is set, the FlexMatch engine places the match and 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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GameSessionConnectionInfo()

Constructors
Constructor and Description
`GameSessionConnectionInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GameSessionConnectionInfo`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDnsName()` DNS identifier assigned to the instance that is running the game session.
`String`	`getGameSessionArn()` Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.
`String`	`getIpAddress()` IP address of the instance that is running the game session.
`List<MatchedPlayerSession>`	`getMatchedPlayerSessions()` A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
`Integer`	`getPort()` Port number for the game session.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDnsName(String dnsName)` DNS identifier assigned to the instance that is running the game session.
`void`	`setGameSessionArn(String gameSessionArn)` Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.
`void`	`setIpAddress(String ipAddress)` IP address of the instance that is running the game session.
`void`	`setMatchedPlayerSessions(Collection<MatchedPlayerSession> matchedPlayerSessions)` A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
`void`	`setPort(Integer port)` Port number for the game session.
`String`	`toString()` Returns a string representation of this object.
`GameSessionConnectionInfo`	`withDnsName(String dnsName)` DNS identifier assigned to the instance that is running the game session.
`GameSessionConnectionInfo`	`withGameSessionArn(String gameSessionArn)` Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.
`GameSessionConnectionInfo`	`withIpAddress(String ipAddress)` IP address of the instance that is running the game session.
`GameSessionConnectionInfo`	`withMatchedPlayerSessions(Collection<MatchedPlayerSession> matchedPlayerSessions)` A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
`GameSessionConnectionInfo`	`withMatchedPlayerSessions(MatchedPlayerSession... matchedPlayerSessions)` A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
`GameSessionConnectionInfo`	`withPort(Integer port)` Port number for the game session.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GameSessionConnectionInfo
```
public GameSessionConnectionInfo()
```
- Method Detail
  - setGameSessionArn
```
public void setGameSessionArn(String gameSessionArn)
```
    Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.
    
    Parameters:
    
    gameSessionArn - Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.
  - getGameSessionArn
```
public String getGameSessionArn()
```
    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.
  - withGameSessionArn
```
public GameSessionConnectionInfo withGameSessionArn(String gameSessionArn)
```
    Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.
    
    Parameters:
    
    gameSessionArn - Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpAddress
```
public void setIpAddress(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.
    
    Parameters:
    
    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.
  - getIpAddress
```
public String getIpAddress()
```
    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.
  - withIpAddress
```
public GameSessionConnectionInfo withIpAddress(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDnsName
```
public void setDnsName(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.
    Parameters:
    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.
  - getDnsName
```
public String getDnsName()
```
    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.
  - withDnsName
```
public GameSessionConnectionInfo withDnsName(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
public void setPort(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.
    
    Parameters:
    
    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.
  - getPort
```
public Integer getPort()
```
    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.
  - withPort
```
public GameSessionConnectionInfo withPort(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMatchedPlayerSessions
```
public List<MatchedPlayerSession> getMatchedPlayerSessions()
```
    A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
    
    Returns:
    
    A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
  - setMatchedPlayerSessions
```
public void setMatchedPlayerSessions(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.
  - withMatchedPlayerSessions
```
public GameSessionConnectionInfo withMatchedPlayerSessions(MatchedPlayerSession... matchedPlayerSessions)
```
    A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
    
    NOTE: This method appends the values to the existing list (if any). Use setMatchedPlayerSessions(java.util.Collection) or withMatchedPlayerSessions(java.util.Collection) if you want to override the existing values.
    
    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.
  - withMatchedPlayerSessions
```
public GameSessionConnectionInfo withMatchedPlayerSessions(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GameSessionConnectionInfo clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class GameSessionConnectionInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GameSessionConnectionInfo

Method Detail

setGameSessionArn

getGameSessionArn

withGameSessionArn

setIpAddress

getIpAddress

withIpAddress

setDnsName

getDnsName

withDnsName

setPort

getPort

withPort

getMatchedPlayerSessions

setMatchedPlayerSessions

withMatchedPlayerSessions

withMatchedPlayerSessions

toString

equals

hashCode

clone

marshall