Package software.amazon.awssdk.services.gamelift.model

Interface GameSessionPlacement.Builder

All Superinterfaces:

CopyableBuilder<GameSessionPlacement.Builder,GameSessionPlacement>, SdkBuilder<GameSessionPlacement.Builder,GameSessionPlacement>

Enclosing class:

GameSessionPlacement

public static interface GameSessionPlacement.Builder
extends CopyableBuilder<GameSessionPlacement.Builder,GameSessionPlacement>

Method Summary

Modifier and Type	Method	Description
GameSessionPlacement.Builder	endTime(Date endTime)	Time stamp indicating when this request was completed, canceled, or timed out.
GameSessionPlacement.Builder	gameProperties(Collection<GameProperty> gameProperties)	Set of developer-defined properties for a game session.
GameSessionPlacement.Builder	gameProperties(GameProperty... gameProperties)	Set of developer-defined properties for a game session.
GameSessionPlacement.Builder	gameSessionArn(String gameSessionArn)	Identifier for the game session created by this placement request.
GameSessionPlacement.Builder	gameSessionId(String gameSessionId)	Unique identifier for the game session.
GameSessionPlacement.Builder	gameSessionName(String gameSessionName)	Descriptive label that is associated with a game session.
GameSessionPlacement.Builder	gameSessionQueueName(String gameSessionQueueName)	Descriptive label that is associated with queue.
GameSessionPlacement.Builder	gameSessionRegion(String gameSessionRegion)	Name of the region where the game session created by this placement request is running.
GameSessionPlacement.Builder	ipAddress(String ipAddress)	IP address of the game session.
GameSessionPlacement.Builder	maximumPlayerSessionCount(Integer maximumPlayerSessionCount)	Maximum number of players that can be connected simultaneously to the game session.
GameSessionPlacement.Builder	placedPlayerSessions(Collection<PlacedPlayerSession> placedPlayerSessions)	Collection of information on player sessions created in response to the game session placement request.
GameSessionPlacement.Builder	placedPlayerSessions(PlacedPlayerSession... placedPlayerSessions)	Collection of information on player sessions created in response to the game session placement request.
GameSessionPlacement.Builder	placementId(String placementId)	Unique identifier for a game session placement.
GameSessionPlacement.Builder	playerLatencies(Collection<PlayerLatency> playerLatencies)	Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions.
GameSessionPlacement.Builder	playerLatencies(PlayerLatency... playerLatencies)	Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions.
GameSessionPlacement.Builder	port(Integer port)	Port number for the game session.
GameSessionPlacement.Builder	startTime(Date startTime)	Time stamp indicating when this request was placed in the queue.
GameSessionPlacement.Builder	status(String status)	Current status of the game session placement request.
GameSessionPlacement.Builder	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

apply, build

Method Detail

placementId

GameSessionPlacement.Builder placementId(String placementId)

Unique identifier for a game session placement.

Parameters:

placementId - Unique identifier for a game session placement.

Returns:

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

gameSessionQueueName

GameSessionPlacement.Builder gameSessionQueueName(String gameSessionQueueName)

Descriptive label that is associated with queue. Queue names must be unique within each region.

Parameters:

gameSessionQueueName - Descriptive label that is associated with 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

GameSessionPlacement.Builder status(String status)

Current status of the game session placement request.

• PENDING – The placement request is currently in the queue waiting to be processed.

• FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED – The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

Parameters:

status - Current status of the game session placement request.

• PENDING – The placement request is currently in the queue waiting to be processed.

• FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED – The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

Returns:

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

See Also:

GameSessionPlacementState

status

GameSessionPlacement.Builder status(GameSessionPlacementState status)

Current status of the game session placement request.

• PENDING – The placement request is currently in the queue waiting to be processed.

• FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED – The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

Parameters:

status - Current status of the game session placement request.

• PENDING – The placement request is currently in the queue waiting to be processed.

• FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED – The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

Returns:

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

See Also:

GameSessionPlacementState

gameProperties

GameSessionPlacement.Builder gameProperties(Collection<GameProperty> gameProperties)

Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

Parameters:

gameProperties - Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

Returns:

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

gameProperties

GameSessionPlacement.Builder gameProperties(GameProperty... gameProperties)

Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

NOTE: This method appends the values to the existing list (if any). Use #setGameProperties(java.util.Collection) or #withGameProperties(java.util.Collection) if you want to override the existing values.

Parameters:

gameProperties - Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

Returns:

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

maximumPlayerSessionCount

GameSessionPlacement.Builder maximumPlayerSessionCount(Integer maximumPlayerSessionCount)

Maximum number of players that can be connected simultaneously to the game session.

Parameters:

maximumPlayerSessionCount - 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

GameSessionPlacement.Builder gameSessionName(String gameSessionName)

Descriptive label that is associated with a game session. Session names do not need to be unique.

Parameters:

gameSessionName - 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

GameSessionPlacement.Builder gameSessionId(String gameSessionId)

Unique identifier for the game session. This value is set once the new game session is placed (placement status is Fulfilled).

Parameters:

gameSessionId - Unique identifier for the game session. This value is set once the new game session is placed (placement status is Fulfilled).

Returns:

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

gameSessionArn

GameSessionPlacement.Builder gameSessionArn(String gameSessionArn)

Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is Fulfilled). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.

Parameters:

gameSessionArn - Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is Fulfilled). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.

Returns:

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

gameSessionRegion

GameSessionPlacement.Builder gameSessionRegion(String gameSessionRegion)

Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is Fulfilled).

Parameters:

gameSessionRegion - Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is Fulfilled).

Returns:

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

playerLatencies

GameSessionPlacement.Builder playerLatencies(Collection<PlayerLatency> playerLatencies)

Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions.

Parameters:

playerLatencies - Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions.

Returns:

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

playerLatencies

GameSessionPlacement.Builder playerLatencies(PlayerLatency... playerLatencies)

Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions.

NOTE: This method appends the values to the existing list (if any). Use #setPlayerLatencies(java.util.Collection) or #withPlayerLatencies(java.util.Collection) if you want to override the existing values.

Parameters:

playerLatencies - Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions.

Returns:

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

startTime

GameSessionPlacement.Builder startTime(Date 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

GameSessionPlacement.Builder endTime(Date 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

GameSessionPlacement.Builder ipAddress(String ipAddress)

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 is set once the new game session is placed (placement status is Fulfilled).

Parameters:

ipAddress - 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 is set once the new game session is placed (placement status is Fulfilled).

Returns:

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

port

GameSessionPlacement.Builder port(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. This value is set once the new game session is placed (placement status is Fulfilled).

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. This value is set once the new game session is placed (placement status is Fulfilled).

Returns:

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

placedPlayerSessions

GameSessionPlacement.Builder placedPlayerSessions(Collection<PlacedPlayerSession> placedPlayerSessions)

Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is Fulfilled). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

Parameters:

placedPlayerSessions - Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is Fulfilled). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

Returns:

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

placedPlayerSessions

GameSessionPlacement.Builder placedPlayerSessions(PlacedPlayerSession... placedPlayerSessions)

Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is Fulfilled). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

NOTE: This method appends the values to the existing list (if any). Use #setPlacedPlayerSessions(java.util.Collection) or #withPlacedPlayerSessions(java.util.Collection) if you want to override the existing values.

Parameters:

placedPlayerSessions - Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is Fulfilled). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

Returns:

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