public static interface GameSession.Builder extends CopyableBuilder<GameSession.Builder,GameSession>
Modifier and Type | Method and Description |
---|---|
GameSession.Builder |
creationTime(Instant creationTime)
Time stamp indicating when this data object was created.
|
GameSession.Builder |
creatorId(String creatorId)
Unique identifier for a player.
|
GameSession.Builder |
currentPlayerSessionCount(Integer currentPlayerSessionCount)
Number of players currently in the game session.
|
GameSession.Builder |
fleetId(String fleetId)
Unique identifier for a fleet that the game session is running on.
|
GameSession.Builder |
gameProperties(Collection<GameProperty> gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
GameSession.Builder |
gameProperties(Consumer<GameProperty.Builder>... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
GameSession.Builder |
gameProperties(GameProperty... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
GameSession.Builder |
gameSessionData(String gameSessionData)
Set of developer-defined game session properties, formatted as a single string value.
|
GameSession.Builder |
gameSessionId(String gameSessionId)
Unique identifier for the game session.
|
GameSession.Builder |
ipAddress(String ipAddress)
IP address of the game session.
|
GameSession.Builder |
maximumPlayerSessionCount(Integer maximumPlayerSessionCount)
Maximum number of players that can be connected simultaneously to the game session.
|
GameSession.Builder |
name(String name)
Descriptive label that is associated with a game session.
|
GameSession.Builder |
playerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy)
Indicates whether or not the game session is accepting new players.
|
GameSession.Builder |
playerSessionCreationPolicy(String playerSessionCreationPolicy)
Indicates whether or not the game session is accepting new players.
|
GameSession.Builder |
port(Integer port)
Port number for the game session.
|
GameSession.Builder |
status(GameSessionStatus status)
Current status of the game session.
|
GameSession.Builder |
status(String status)
Current status of the game session.
|
GameSession.Builder |
terminationTime(Instant terminationTime)
Time stamp indicating when this data object was terminated.
|
copy
applyMutation, build
GameSession.Builder gameSessionId(String gameSessionId)
Unique identifier for the game session. A game session ARN has the following format:
arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
.
gameSessionId
- Unique identifier for the game session. A game session ARN has the following format:
arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
.GameSession.Builder name(String name)
Descriptive label that is associated with a game session. Session names do not need to be unique.
name
- Descriptive label that is associated with a game session. Session names do not need to be unique.GameSession.Builder fleetId(String fleetId)
Unique identifier for a fleet that the game session is running on.
fleetId
- Unique identifier for a fleet that the game session is running on.GameSession.Builder creationTime(Instant creationTime)
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
creationTime
- Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057").GameSession.Builder terminationTime(Instant terminationTime)
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
terminationTime
- Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time
as milliseconds (for example "1469498468.057").GameSession.Builder currentPlayerSessionCount(Integer currentPlayerSessionCount)
Number of players currently in the game session.
currentPlayerSessionCount
- Number of players currently in the game session.GameSession.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.GameSession.Builder status(String status)
Current status of the game session. A game session must have an ACTIVE
status to have player
sessions.
status
- Current status of the game session. A game session must have an ACTIVE
status to have
player sessions.GameSessionStatus
,
GameSessionStatus
GameSession.Builder status(GameSessionStatus status)
Current status of the game session. A game session must have an ACTIVE
status to have player
sessions.
status
- Current status of the game session. A game session must have an ACTIVE
status to have
player sessions.GameSessionStatus
,
GameSessionStatus
GameSession.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).GameSession.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).GameSession.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)
GameSession.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.
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.GameSession.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.
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.GameSession.Builder playerSessionCreationPolicy(String playerSessionCreationPolicy)
Indicates whether or not the game session is accepting new players.
playerSessionCreationPolicy
- Indicates whether or not the game session is accepting new players.PlayerSessionCreationPolicy
,
PlayerSessionCreationPolicy
GameSession.Builder playerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy)
Indicates whether or not the game session is accepting new players.
playerSessionCreationPolicy
- Indicates whether or not the game session is accepting new players.PlayerSessionCreationPolicy
,
PlayerSessionCreationPolicy
GameSession.Builder creatorId(String creatorId)
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
creatorId
- Unique identifier for a player. This ID is used to enforce a resource protection policy (if one
exists), that limits the number of game sessions a player can create.GameSession.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.