software.amazon.awssdk.services.gamelift.model

Interface GameServer.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GameServer.Builder,GameServer>, SdkBuilder<GameServer.Builder,GameServer>, SdkPojo

Enclosing class:

GameServer

public static interface GameServer.Builder
extends SdkPojo, CopyableBuilder<GameServer.Builder,GameServer>

Method Summary

Modifier and Type	Method and Description
GameServer.Builder	claimStatus(GameServerClaimStatus claimStatus) Indicates when an available game server has been reserved but has not yet started hosting a game.
GameServer.Builder	claimStatus(String claimStatus) Indicates when an available game server has been reserved but has not yet started hosting a game.
GameServer.Builder	connectionInfo(String connectionInfo) The port and IP address that must be used to establish a client connection to the game server.
GameServer.Builder	customSortKey(String customSortKey) A game server tag that can be used to request sorted lists of game servers when calling ListGameServers.
GameServer.Builder	gameServerData(String gameServerData) A set of custom game server properties, formatted as a single string value.
GameServer.Builder	gameServerGroupArn(String gameServerGroupArn) The ARN identifier for the game server group where the game server is located.
GameServer.Builder	gameServerGroupName(String gameServerGroupName) The name identifier for the game server group where the game server is located.
GameServer.Builder	gameServerId(String gameServerId) A custom string that uniquely identifies the game server.
GameServer.Builder	instanceId(String instanceId) The unique identifier for the instance where the game server is located.
GameServer.Builder	lastClaimTime(Instant lastClaimTime) Time stamp indicating the last time the game server was claimed with a ClaimGameServer request.
GameServer.Builder	lastHealthCheckTime(Instant lastHealthCheckTime) Time stamp indicating the last time the game server was updated with health status using an UpdateGameServer request.
GameServer.Builder	registrationTime(Instant registrationTime) Time stamp indicating when the game server resource was created with a RegisterGameServer request.
GameServer.Builder	utilizationStatus(GameServerUtilizationStatus utilizationStatus) Indicates whether the game server is currently available for new games or is busy.
GameServer.Builder	utilizationStatus(String utilizationStatus) Indicates whether the game server is currently available for new games or is busy.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

gameServerGroupName

GameServer.Builder gameServerGroupName(String gameServerGroupName)

The name identifier for the game server group where the game server is located.

Parameters:

gameServerGroupName - The name identifier for the game server group where the game server is located.

Returns:

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

gameServerGroupArn

GameServer.Builder gameServerGroupArn(String gameServerGroupArn)

The ARN identifier for the game server group where the game server is located.

Parameters:

gameServerGroupArn - The ARN identifier for the game server group where the game server is located.

Returns:

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

gameServerId

GameServer.Builder gameServerId(String gameServerId)

A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

Parameters:

gameServerId - A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

Returns:

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

instanceId

GameServer.Builder instanceId(String instanceId)

The unique identifier for the instance where the game server is located.

Parameters:

instanceId - The unique identifier for the instance where the game server is located.

Returns:

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

connectionInfo

GameServer.Builder connectionInfo(String connectionInfo)

The port and IP address that must be used to establish a client connection to the game server.

Parameters:

connectionInfo - The port and IP address that must be used to establish a client connection to the game server.

Returns:

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

gameServerData

GameServer.Builder gameServerData(String gameServerData)

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service in response to requests ListGameServers or ClaimGameServer. This property can be updated using UpdateGameServer.

Parameters:

gameServerData - A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service in response to requests ListGameServers or ClaimGameServer. This property can be updated using UpdateGameServer.

Returns:

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

customSortKey

GameServer.Builder customSortKey(String customSortKey)

A game server tag that can be used to request sorted lists of game servers when calling ListGameServers. Custom sort keys are developer-defined. This property can be updated using UpdateGameServer.

Parameters:

customSortKey - A game server tag that can be used to request sorted lists of game servers when calling ListGameServers. Custom sort keys are developer-defined. This property can be updated using UpdateGameServer.

Returns:

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

claimStatus

GameServer.Builder claimStatus(String claimStatus)

Indicates when an available game server has been reserved but has not yet started hosting a game. Once it is claimed, game server remains in CLAIMED status for a maximum of one minute. During this time, game clients must connect to the game server and start the game, which triggers the game server to update its utilization status. After one minute, the game server claim status reverts to null.

Parameters:

claimStatus - Indicates when an available game server has been reserved but has not yet started hosting a game. Once it is claimed, game server remains in CLAIMED status for a maximum of one minute. During this time, game clients must connect to the game server and start the game, which triggers the game server to update its utilization status. After one minute, the game server claim status reverts to null.

Returns:

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

See Also:

GameServerClaimStatus, GameServerClaimStatus

claimStatus

GameServer.Builder claimStatus(GameServerClaimStatus claimStatus)

Indicates when an available game server has been reserved but has not yet started hosting a game. Once it is claimed, game server remains in CLAIMED status for a maximum of one minute. During this time, game clients must connect to the game server and start the game, which triggers the game server to update its utilization status. After one minute, the game server claim status reverts to null.

Parameters:

claimStatus - Indicates when an available game server has been reserved but has not yet started hosting a game. Once it is claimed, game server remains in CLAIMED status for a maximum of one minute. During this time, game clients must connect to the game server and start the game, which triggers the game server to update its utilization status. After one minute, the game server claim status reverts to null.

Returns:

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

See Also:

GameServerClaimStatus, GameServerClaimStatus

utilizationStatus

GameServer.Builder utilizationStatus(String utilizationStatus)

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

• AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

• IN_USE - The game server is currently hosting a game session with players.

Parameters:

utilizationStatus - Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

• AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

• IN_USE - The game server is currently hosting a game session with players.

Returns:

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

See Also:

GameServerUtilizationStatus, GameServerUtilizationStatus

utilizationStatus

GameServer.Builder utilizationStatus(GameServerUtilizationStatus utilizationStatus)

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

• AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

• IN_USE - The game server is currently hosting a game session with players.

Parameters:

utilizationStatus - Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

• AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

• IN_USE - The game server is currently hosting a game session with players.

Returns:

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

See Also:

GameServerUtilizationStatus, GameServerUtilizationStatus

registrationTime

GameServer.Builder registrationTime(Instant registrationTime)

Time stamp indicating when the game server resource was created with a RegisterGameServer request. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

registrationTime - Time stamp indicating when the game server resource was created with a RegisterGameServer request. 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.

lastClaimTime

GameServer.Builder lastClaimTime(Instant lastClaimTime)

Time stamp indicating the last time the game server was claimed with a ClaimGameServer request. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when the game server's claim status.

Parameters:

lastClaimTime - Time stamp indicating the last time the game server was claimed with a ClaimGameServer request. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when the game server's claim status.

Returns:

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

lastHealthCheckTime

GameServer.Builder lastHealthCheckTime(Instant lastHealthCheckTime)

Time stamp indicating the last time the game server was updated with health status using an UpdateGameServer request. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

Parameters:

lastHealthCheckTime - Time stamp indicating the last time the game server was updated with health status using an UpdateGameServer request. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

Returns:

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