Class GameServer
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GameServer.Builder,
GameServer>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GameServer.Builder
builder()
final GameServerClaimStatus
Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game.final String
Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game.final String
The port and IP address that must be used to establish a client connection to the game server.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A set of custom game server properties, formatted as a single string value.final String
The ARN identifier for the game server group where the game server is located.final String
A unique identifier for the game server group where the game server is running.final String
A custom string that uniquely identifies the game server.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The unique identifier for the instance where the game server is running.final Instant
Timestamp that indicates the last time the game server was claimed.final Instant
Timestamp that indicates the last time the game server was updated with health status.final Instant
Timestamp that indicates when the game server registered.static Class
<? extends GameServer.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Indicates whether the game server is currently available for new games or is busy.final String
Indicates whether the game server is currently available for new games or is busy.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
gameServerGroupName
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.
-
gameServerGroupArn
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.
-
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:
- 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.
-
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:
- 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
.
-
connectionInfo
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.
-
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:
- 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.
-
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.If the service returns an enum value that is not available in the current SDK version,
claimStatus
will returnGameServerClaimStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclaimStatusAsString()
.- 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:
-
claimStatusAsString
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.If the service returns an enum value that is not available in the current SDK version,
claimStatus
will returnGameServerClaimStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclaimStatusAsString()
.- 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:
-
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.
If the service returns an enum value that is not available in the current SDK version,
utilizationStatus
will returnGameServerUtilizationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromutilizationStatusAsString()
.- 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:
-
-
utilizationStatusAsString
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.
If the service returns an enum value that is not available in the current SDK version,
utilizationStatus
will returnGameServerUtilizationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromutilizationStatusAsString()
.- 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:
-
-
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:
- Timestamp that indicates when the game server registered. The format is a number expressed in Unix time
as milliseconds (for example
"1469498468.057"
).
-
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:
- 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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GameServer.Builder,
GameServer> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-