Interface GameSessionPlacement.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<GameSessionPlacement.Builder,
,GameSessionPlacement> SdkBuilder<GameSessionPlacement.Builder,
,GameSessionPlacement> SdkPojo
- Enclosing class:
GameSessionPlacement
-
Method Summary
Modifier and TypeMethodDescriptionThe DNS identifier assigned to the instance that is running the game session.Time stamp indicating when this request was completed, canceled, or timed out.gameProperties
(Collection<GameProperty> gameProperties) A set of key-value pairs that can store custom data in a game session.gameProperties
(Consumer<GameProperty.Builder>... gameProperties) A set of key-value pairs that can store custom data in a game session.gameProperties
(GameProperty... gameProperties) A set of key-value pairs that can store custom data in a game session.gameSessionArn
(String gameSessionArn) Identifier for the game session created by this placement request.gameSessionData
(String gameSessionData) A set of custom game session properties, formatted as a single string value.gameSessionId
(String gameSessionId) A unique identifier for the game session.gameSessionName
(String gameSessionName) A descriptive label that is associated with a game session.gameSessionQueueName
(String gameSessionQueueName) A descriptive label that is associated with game session queue.gameSessionRegion
(String gameSessionRegion) Name of the Region where the game session created by this placement request is running.The IP address of the game session.matchmakerData
(String matchmakerData) Information on the matchmaking process for this game.maximumPlayerSessionCount
(Integer maximumPlayerSessionCount) The maximum number of players that can be connected simultaneously to the game session.placedPlayerSessions
(Collection<PlacedPlayerSession> placedPlayerSessions) A collection of information on player sessions created in response to the game session placement request.placedPlayerSessions
(Consumer<PlacedPlayerSession.Builder>... placedPlayerSessions) A collection of information on player sessions created in response to the game session placement request.placedPlayerSessions
(PlacedPlayerSession... placedPlayerSessions) A collection of information on player sessions created in response to the game session placement request.placementId
(String placementId) A unique identifier for a game session placement.playerLatencies
(Collection<PlayerLatency> playerLatencies) A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.playerLatencies
(Consumer<PlayerLatency.Builder>... playerLatencies) A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.playerLatencies
(PlayerLatency... playerLatencies) A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.The port number for the game session.Time stamp indicating when this request was placed in the queue.Current status of the game session placement request.status
(GameSessionPlacementState status) Current status of the game session placement request.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, sdkFields
-
Method Details
-
placementId
A unique identifier for a game session placement.
- Parameters:
placementId
- A unique identifier for a game session placement.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameSessionQueueName
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
- Parameters:
gameSessionQueueName
- A descriptive label that is associated with game session queue. Queue names must be unique within each Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
Current status of the game session placement request.
-
PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.
-
FULFILLED -- A new game session has been successfully placed. Game session properties are now final.
-
CANCELLED -- The placement request was canceled.
-
TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
-
FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
- Parameters:
status
- Current status of the game session placement request.-
PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.
-
FULFILLED -- A new game session has been successfully placed. Game session properties are now final.
-
CANCELLED -- The placement request was canceled.
-
TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
-
FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
status
Current status of the game session placement request.
-
PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.
-
FULFILLED -- A new game session has been successfully placed. Game session properties are now final.
-
CANCELLED -- The placement request was canceled.
-
TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
-
FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
- Parameters:
status
- Current status of the game session placement request.-
PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.
-
FULFILLED -- A new game session has been successfully placed. Game session properties are now final.
-
CANCELLED -- The placement request was canceled.
-
TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
-
FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
gameProperties
A set of key-value pairs that can store custom data in a game session. For example:
{"Key": "difficulty", "Value": "novice"}
.- Parameters:
gameProperties
- A set of key-value pairs that can store custom data in a game session. For example:{"Key": "difficulty", "Value": "novice"}
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameProperties
A set of key-value pairs that can store custom data in a game session. For example:
{"Key": "difficulty", "Value": "novice"}
.- Parameters:
gameProperties
- A set of key-value pairs that can store custom data in a game session. For example:{"Key": "difficulty", "Value": "novice"}
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameProperties
A set of key-value pairs that can store custom data in a game session. For example:
This is a convenience method that creates an instance of the{"Key": "difficulty", "Value": "novice"}
.GameProperty.Builder
avoiding the need to create one manually viaGameProperty.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togameProperties(List<GameProperty>)
.- Parameters:
gameProperties
- a consumer that will call methods onGameProperty.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maximumPlayerSessionCount
The maximum number of players that can be connected simultaneously to the game session.
- Parameters:
maximumPlayerSessionCount
- The maximum number of players that can be connected simultaneously to the game session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameSessionName
A descriptive label that is associated with a game session. Session names do not need to be unique.
- Parameters:
gameSessionName
- A descriptive label that is associated with a game session. Session names do not need to be unique.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameSessionId
A unique identifier for the game session. This value isn't final until placement status is
FULFILLED
.- Parameters:
gameSessionId
- A unique identifier for the game session. This value isn't final until placement status isFULFILLED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameSessionArn
Identifier for the game session created by this placement request. This identifier is unique across all Regions. This value isn't final until placement status is
FULFILLED
.- Parameters:
gameSessionArn
- Identifier for the game session created by this placement request. This identifier is unique across all Regions. This value isn't final until placement status isFULFILLED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameSessionRegion
Name of the Region where the game session created by this placement request is running. This value isn't final until placement status is
FULFILLED
.- Parameters:
gameSessionRegion
- Name of the Region where the game session created by this placement request is running. This value isn't final until placement status isFULFILLED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playerLatencies
A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
- Parameters:
playerLatencies
- A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playerLatencies
A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
- Parameters:
playerLatencies
- A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playerLatencies
A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
This is a convenience method that creates an instance of thePlayerLatency.Builder
avoiding the need to create one manually viaPlayerLatency.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplayerLatencies(List<PlayerLatency>)
.- Parameters:
playerLatencies
- a consumer that will call methods onPlayerLatency.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
startTime
Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example
"1469498468.057"
).- Parameters:
startTime
- Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example"1469498468.057"
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
Time stamp indicating when this request was completed, canceled, or timed out.
- Parameters:
endTime
- Time stamp indicating when this request was completed, canceled, or timed out.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipAddress
The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status is
FULFILLED
.- Parameters:
ipAddress
- The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status isFULFILLED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status is
FULFILLED
.- Parameters:
port
- The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status isFULFILLED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placedPlayerSessions
GameSessionPlacement.Builder placedPlayerSessions(Collection<PlacedPlayerSession> placedPlayerSessions) A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is
FULFILLED
). This information includes the player ID, provided in the placement request, and a corresponding player session ID.- Parameters:
placedPlayerSessions
- A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status isFULFILLED
). This information includes the player ID, provided in the placement request, and a corresponding player session ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placedPlayerSessions
A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is
FULFILLED
). This information includes the player ID, provided in the placement request, and a corresponding player session ID.- Parameters:
placedPlayerSessions
- A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status isFULFILLED
). This information includes the player ID, provided in the placement request, and a corresponding player session ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placedPlayerSessions
GameSessionPlacement.Builder placedPlayerSessions(Consumer<PlacedPlayerSession.Builder>... placedPlayerSessions) A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is
This is a convenience method that creates an instance of theFULFILLED
). This information includes the player ID, provided in the placement request, and a corresponding player session ID.PlacedPlayerSession.Builder
avoiding the need to create one manually viaPlacedPlayerSession.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplacedPlayerSessions(List<PlacedPlayerSession>)
.- Parameters:
placedPlayerSessions
- a consumer that will call methods onPlacedPlayerSession.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
gameSessionData
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the
GameSession
object with a request to start a new game session (see Start a Game Session).- Parameters:
gameSessionData
- A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in theGameSession
object with a request to start a new game session (see Start a Game Session).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
matchmakerData
Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
- Parameters:
matchmakerData
- Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-