@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GameServer extends Object implements Serializable, Cloneable, StructuredPojo
This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Properties describing a game server resource.
A game server resource is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer.
Constructor and Description |
---|
GameServer() |
Modifier and Type | Method and Description |
---|---|
GameServer |
clone() |
boolean |
equals(Object obj) |
String |
getClaimStatus()
Indicates when an available game server has been reserved but has not yet started hosting a game.
|
String |
getConnectionInfo()
The port and IP address that must be used to establish a client connection to the game server.
|
String |
getCustomSortKey()
A game server tag that can be used to request sorted lists of game servers when calling ListGameServers.
|
String |
getGameServerData()
A set of custom game server properties, formatted as a single string value.
|
String |
getGameServerGroupArn()
The ARN identifier for the game server group where the game server is located.
|
String |
getGameServerGroupName()
The name identifier for the game server group where the game server is located.
|
String |
getGameServerId()
A custom string that uniquely identifies the game server.
|
String |
getInstanceId()
The unique identifier for the instance where the game server is located.
|
Date |
getLastClaimTime()
Time stamp indicating the last time the game server was claimed with a ClaimGameServer request.
|
Date |
getLastHealthCheckTime()
Time stamp indicating the last time the game server was updated with health status using an
UpdateGameServer request.
|
Date |
getRegistrationTime()
Time stamp indicating when the game server resource was created with a RegisterGameServer request.
|
String |
getUtilizationStatus()
Indicates whether the game server is currently available for new games or is busy.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setClaimStatus(String claimStatus)
Indicates when an available game server has been reserved but has not yet started hosting a game.
|
void |
setConnectionInfo(String connectionInfo)
The port and IP address that must be used to establish a client connection to the game server.
|
void |
setCustomSortKey(String customSortKey)
A game server tag that can be used to request sorted lists of game servers when calling ListGameServers.
|
void |
setGameServerData(String gameServerData)
A set of custom game server properties, formatted as a single string value.
|
void |
setGameServerGroupArn(String gameServerGroupArn)
The ARN identifier for the game server group where the game server is located.
|
void |
setGameServerGroupName(String gameServerGroupName)
The name identifier for the game server group where the game server is located.
|
void |
setGameServerId(String gameServerId)
A custom string that uniquely identifies the game server.
|
void |
setInstanceId(String instanceId)
The unique identifier for the instance where the game server is located.
|
void |
setLastClaimTime(Date lastClaimTime)
Time stamp indicating the last time the game server was claimed with a ClaimGameServer request.
|
void |
setLastHealthCheckTime(Date lastHealthCheckTime)
Time stamp indicating the last time the game server was updated with health status using an
UpdateGameServer request.
|
void |
setRegistrationTime(Date registrationTime)
Time stamp indicating when the game server resource was created with a RegisterGameServer request.
|
void |
setUtilizationStatus(String utilizationStatus)
Indicates whether the game server is currently available for new games or is busy.
|
String |
toString()
Returns a string representation of this object.
|
GameServer |
withClaimStatus(GameServerClaimStatus claimStatus)
Indicates when an available game server has been reserved but has not yet started hosting a game.
|
GameServer |
withClaimStatus(String claimStatus)
Indicates when an available game server has been reserved but has not yet started hosting a game.
|
GameServer |
withConnectionInfo(String connectionInfo)
The port and IP address that must be used to establish a client connection to the game server.
|
GameServer |
withCustomSortKey(String customSortKey)
A game server tag that can be used to request sorted lists of game servers when calling ListGameServers.
|
GameServer |
withGameServerData(String gameServerData)
A set of custom game server properties, formatted as a single string value.
|
GameServer |
withGameServerGroupArn(String gameServerGroupArn)
The ARN identifier for the game server group where the game server is located.
|
GameServer |
withGameServerGroupName(String gameServerGroupName)
The name identifier for the game server group where the game server is located.
|
GameServer |
withGameServerId(String gameServerId)
A custom string that uniquely identifies the game server.
|
GameServer |
withInstanceId(String instanceId)
The unique identifier for the instance where the game server is located.
|
GameServer |
withLastClaimTime(Date lastClaimTime)
Time stamp indicating the last time the game server was claimed with a ClaimGameServer request.
|
GameServer |
withLastHealthCheckTime(Date lastHealthCheckTime)
Time stamp indicating the last time the game server was updated with health status using an
UpdateGameServer request.
|
GameServer |
withRegistrationTime(Date registrationTime)
Time stamp indicating when the game server resource was created with a RegisterGameServer request.
|
GameServer |
withUtilizationStatus(GameServerUtilizationStatus utilizationStatus)
Indicates whether the game server is currently available for new games or is busy.
|
GameServer |
withUtilizationStatus(String utilizationStatus)
Indicates whether the game server is currently available for new games or is busy.
|
public void setGameServerGroupName(String gameServerGroupName)
The name identifier for the game server group where the game server is located.
gameServerGroupName
- The name identifier for the game server group where the game server is located.public String getGameServerGroupName()
The name identifier for the game server group where the game server is located.
public GameServer withGameServerGroupName(String gameServerGroupName)
The name identifier for the game server group where the game server is located.
gameServerGroupName
- The name identifier for the game server group where the game server is located.public void setGameServerGroupArn(String gameServerGroupArn)
The ARN identifier for the game server group where the game server is located.
gameServerGroupArn
- The ARN identifier for the game server group where the game server is located.public String getGameServerGroupArn()
The ARN identifier for the game server group where the game server is located.
public GameServer withGameServerGroupArn(String gameServerGroupArn)
The ARN identifier for the game server group where the game server is located.
gameServerGroupArn
- The ARN identifier for the game server group where the game server is located.public void setGameServerId(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.
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.public String getGameServerId()
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.
public GameServer withGameServerId(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.
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.public void setInstanceId(String instanceId)
The unique identifier for the instance where the game server is located.
instanceId
- The unique identifier for the instance where the game server is located.public String getInstanceId()
The unique identifier for the instance where the game server is located.
public GameServer withInstanceId(String instanceId)
The unique identifier for the instance where the game server is located.
instanceId
- The unique identifier for the instance where the game server is located.public void setConnectionInfo(String connectionInfo)
The port and IP address that must be used to establish a client connection to the game server.
connectionInfo
- The port and IP address that must be used to establish a client connection to the game server.public String getConnectionInfo()
The port and IP address that must be used to establish a client connection to the game server.
public GameServer withConnectionInfo(String connectionInfo)
The port and IP address that must be used to establish a client connection to the game server.
connectionInfo
- The port and IP address that must be used to establish a client connection to the game server.public void setGameServerData(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.
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.public String getGameServerData()
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.
public GameServer withGameServerData(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.
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.public void setCustomSortKey(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.
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.public String getCustomSortKey()
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.
public GameServer withCustomSortKey(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.
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.public void setClaimStatus(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.
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.GameServerClaimStatus
public String getClaimStatus()
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.
GameServerClaimStatus
public GameServer withClaimStatus(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.
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.GameServerClaimStatus
public GameServer withClaimStatus(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.
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.GameServerClaimStatus
public void setUtilizationStatus(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.
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.
GameServerUtilizationStatus
public String getUtilizationStatus()
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.
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.
GameServerUtilizationStatus
public GameServer withUtilizationStatus(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.
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.
GameServerUtilizationStatus
public GameServer withUtilizationStatus(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.
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.
GameServerUtilizationStatus
public void setRegistrationTime(Date 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").
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").public Date getRegistrationTime()
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").
public GameServer withRegistrationTime(Date 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").
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").public void setLastClaimTime(Date 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.
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.public Date getLastClaimTime()
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.
public GameServer withLastClaimTime(Date 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.
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.public void setLastHealthCheckTime(Date 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.
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.public Date getLastHealthCheckTime()
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.
public GameServer withLastHealthCheckTime(Date 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.
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.public String toString()
toString
in class Object
Object.toString()
public GameServer clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.