com.amazonaws.services.gamelift.model

Class GameServer

java.lang.Object

com.amazonaws.services.gamelift.model.GameServer

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GameServer
extends Object
implements Serializable, Cloneable, StructuredPojo

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Properties describing a game server that is running on an instance in a game server group.

A game server is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer. A game server is claimed to host a game session by calling ClaimGameServer.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GameServer()

Method Summary

Modifier and Type	Method and Description
GameServer	clone()
boolean	equals(Object obj)
String	getClaimStatus() Indicates when an available game server has been reserved for gameplay 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	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() A unique identifier for the game server group where the game server is running.
String	getGameServerId() A custom string that uniquely identifies the game server.
String	getInstanceId() The unique identifier for the instance where the game server is running.
Date	getLastClaimTime() Timestamp that indicates the last time the game server was claimed.
Date	getLastHealthCheckTime() Timestamp that indicates the last time the game server was updated with health status.
Date	getRegistrationTime() Timestamp that indicates when the game server registered.
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 for gameplay 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	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) A unique identifier for the game server group where the game server is running.
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 running.
void	setLastClaimTime(Date lastClaimTime) Timestamp that indicates the last time the game server was claimed.
void	setLastHealthCheckTime(Date lastHealthCheckTime) Timestamp that indicates the last time the game server was updated with health status.
void	setRegistrationTime(Date registrationTime) Timestamp that indicates when the game server registered.
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 for gameplay but has not yet started hosting a game.
GameServer	withClaimStatus(String claimStatus) Indicates when an available game server has been reserved for gameplay 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	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) A unique identifier for the game server group where the game server is running.
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 running.
GameServer	withLastClaimTime(Date lastClaimTime) Timestamp that indicates the last time the game server was claimed.
GameServer	withLastHealthCheckTime(Date lastHealthCheckTime) Timestamp that indicates the last time the game server was updated with health status.
GameServer	withRegistrationTime(Date registrationTime) Timestamp that indicates when the game server registered.
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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GameServer

public GameServer()

Method Detail

setGameServerGroupName

public void setGameServerGroupName(String gameServerGroupName)

A unique identifier for the game server group where the game server is running.

Parameters:

gameServerGroupName - A unique identifier for the game server group where the game server is running.

getGameServerGroupName

public String getGameServerGroupName()

A unique identifier for the game server group where the game server is running.

Returns:

A unique identifier for the game server group where the game server is running.

withGameServerGroupName

public GameServer withGameServerGroupName(String gameServerGroupName)

A unique identifier for the game server group where the game server is running.

Parameters:

gameServerGroupName - A unique identifier for the game server group where the game server is running.

Returns:

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

setGameServerGroupArn

public void setGameServerGroupArn(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.

getGameServerGroupArn

public String getGameServerGroupArn()

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

Returns:

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

withGameServerGroupArn

public GameServer withGameServerGroupArn(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.

setGameServerId

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 Amazon Web Services 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 Amazon Web Services account.

getGameServerId

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 Amazon Web Services account.

Returns:

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 Amazon Web Services account.

withGameServerId

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 Amazon Web Services 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 Amazon Web Services account.

Returns:

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

setInstanceId

public void setInstanceId(String instanceId)

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Parameters:

instanceId - The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

getInstanceId

public String getInstanceId()

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Returns:

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

withInstanceId

public GameServer withInstanceId(String instanceId)

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Parameters:

instanceId - The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Returns:

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

setConnectionInfo

public void setConnectionInfo(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.

getConnectionInfo

public String getConnectionInfo()

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

Returns:

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

withConnectionInfo

public GameServer withConnectionInfo(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.

setGameServerData

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 when it requests information on game servers.

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 when it requests information on game servers.

getGameServerData

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 when it requests information on game servers.

Returns:

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

withGameServerData

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 when it requests information on game servers.

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 when it requests information on game servers.

Returns:

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

setClaimStatus

public void setClaimStatus(String claimStatus)

Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger 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 for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

See Also:

GameServerClaimStatus

getClaimStatus

public String getClaimStatus()

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

Returns:

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

See Also:

GameServerClaimStatus

withClaimStatus

public GameServer withClaimStatus(String claimStatus)

Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger 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 for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger 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

withClaimStatus

public GameServer withClaimStatus(GameServerClaimStatus claimStatus)

Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger 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 for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger 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

setUtilizationStatus

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.

• UTILIZED - 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.

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

See Also:

GameServerUtilizationStatus

getUtilizationStatus

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.

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

Returns:

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.

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

See Also:

GameServerUtilizationStatus

withUtilizationStatus

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.

• UTILIZED - 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.

• UTILIZED - 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

withUtilizationStatus

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.

• UTILIZED - 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.

• UTILIZED - 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

setRegistrationTime

public void setRegistrationTime(Date registrationTime)

Timestamp that indicates when the game server registered. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

registrationTime - Timestamp that indicates when the game server registered. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

getRegistrationTime

public Date getRegistrationTime()

Timestamp that indicates when the game server registered. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

Timestamp that indicates when the game server registered. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

withRegistrationTime

public GameServer withRegistrationTime(Date registrationTime)

Timestamp that indicates when the game server registered. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

registrationTime - Timestamp that indicates when the game server registered. The 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.

setLastClaimTime

public void setLastClaimTime(Date lastClaimTime)

Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

Parameters:

lastClaimTime - Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

getLastClaimTime

public Date getLastClaimTime()

Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

Returns:

Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

withLastClaimTime

public GameServer withLastClaimTime(Date lastClaimTime)

Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

Parameters:

lastClaimTime - Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

Returns:

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

setLastHealthCheckTime

public void setLastHealthCheckTime(Date lastHealthCheckTime)

Timestamp that indicates the last time the game server was updated with health status. The 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 - Timestamp that indicates the last time the game server was updated with health status. The 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.

getLastHealthCheckTime

public Date getLastHealthCheckTime()

Timestamp that indicates the last time the game server was updated with health status. The 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:

Timestamp that indicates the last time the game server was updated with health status. The 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.

withLastHealthCheckTime

public GameServer withLastHealthCheckTime(Date lastHealthCheckTime)

Timestamp that indicates the last time the game server was updated with health status. The 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 - Timestamp that indicates the last time the game server was updated with health status. The 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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GameServer clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.