public static interface GameSessionPlacement.Builder extends CopyableBuilder<GameSessionPlacement.Builder,GameSessionPlacement>
Modifier and Type | Method and Description |
---|---|
GameSessionPlacement.Builder |
endTime(Instant 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, formatted as a set of type:value pairs.
|
GameSessionPlacement.Builder |
gameProperties(Consumer<GameProperty.Builder>... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
GameSessionPlacement.Builder |
gameProperties(GameProperty... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
GameSessionPlacement.Builder |
gameSessionArn(String gameSessionArn)
Identifier for the game session created by this placement request.
|
GameSessionPlacement.Builder |
gameSessionData(String gameSessionData)
Set of developer-defined game session properties, formatted as a single string value.
|
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 game session 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(Consumer<PlacedPlayerSession.Builder>... 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 a player experiences when
connected to AWS regions.
|
GameSessionPlacement.Builder |
playerLatencies(Consumer<PlayerLatency.Builder>... playerLatencies)
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when
connected to AWS regions.
|
GameSessionPlacement.Builder |
playerLatencies(PlayerLatency... playerLatencies)
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when
connected to AWS regions.
|
GameSessionPlacement.Builder |
port(Integer port)
Port number for the game session.
|
GameSessionPlacement.Builder |
startTime(Instant startTime)
Time stamp indicating when this request was placed in the queue.
|
GameSessionPlacement.Builder |
status(GameSessionPlacementState status)
Current status of the game session placement request.
|
GameSessionPlacement.Builder |
status(String status)
Current status of the game session placement request.
|
copy
applyMutation, build
GameSessionPlacement.Builder placementId(String placementId)
Unique identifier for a game session placement.
placementId
- Unique identifier for a game session placement.GameSessionPlacement.Builder gameSessionQueueName(String gameSessionQueueName)
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
gameSessionQueueName
- Descriptive label that is associated with game session queue. Queue names must be unique within each
region.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.
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.
GameSessionPlacementState
,
GameSessionPlacementState
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.
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.
GameSessionPlacementState
,
GameSessionPlacementState
GameSessionPlacement.Builder gameProperties(Collection<GameProperty> gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
gameProperties
- Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These
properties are included in the GameSession object, which is passed to the game server with a
request to start a new game session (see Start a Game Session).GameSessionPlacement.Builder gameProperties(GameProperty... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
gameProperties
- Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These
properties are included in the GameSession object, which is passed to the game server with a
request to start a new game session (see Start a Game Session).GameSessionPlacement.Builder gameProperties(Consumer<GameProperty.Builder>... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #gameProperties(List)
.gameProperties
- a consumer that will call methods on List.Builder
#gameProperties(List)
GameSessionPlacement.Builder maximumPlayerSessionCount(Integer maximumPlayerSessionCount)
Maximum number of players that can be connected simultaneously to the game session.
maximumPlayerSessionCount
- Maximum number of players that can be connected simultaneously to the game session.GameSessionPlacement.Builder gameSessionName(String gameSessionName)
Descriptive label that is associated with a game session. Session names do not need to be unique.
gameSessionName
- Descriptive label that is associated with a game session. Session names do not need to be unique.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
).
gameSessionId
- Unique identifier for the game session. This value is set once the new game session is placed
(placement status is FULFILLED
).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.
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.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
).
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
).GameSessionPlacement.Builder playerLatencies(Collection<PlayerLatency> playerLatencies)
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
playerLatencies
- Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences
when connected to AWS regions.GameSessionPlacement.Builder playerLatencies(PlayerLatency... playerLatencies)
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
playerLatencies
- Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences
when connected to AWS regions.GameSessionPlacement.Builder playerLatencies(Consumer<PlayerLatency.Builder>... playerLatencies)
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
This is a convenience that creates an instance of theList.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #playerLatencies(List)
.playerLatencies
- a consumer that will call methods on List.Builder
#playerLatencies(List)
GameSessionPlacement.Builder startTime(Instant 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").
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").GameSessionPlacement.Builder endTime(Instant endTime)
Time stamp indicating when this request was completed, canceled, or timed out.
endTime
- Time stamp indicating when this request was completed, canceled, or timed out.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
).
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
).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
).
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
).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.
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.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.
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.GameSessionPlacement.Builder placedPlayerSessions(Consumer<PlacedPlayerSession.Builder>... 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.
List.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #placedPlayerSessions(List)
.placedPlayerSessions
- a consumer that will call methods on List.Builder
#placedPlayerSessions(List)
GameSessionPlacement.Builder gameSessionData(String gameSessionData)
Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
gameSessionData
- Set of developer-defined game session properties, formatted as a single string value. This data is
included in the GameSession object, which is passed to the game server with a request to start
a new game session (see Start a Game Session).Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.