software.amazon.awssdk.services.gamelift.model

Class GameServer

java.lang.Object

software.amazon.awssdk.services.gamelift.model.GameServer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GameServer.Builder,GameServer>

@Generated(value="software.amazon.awssdk:codegen")
public final class GameServer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GameServer.Builder,GameServer>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GameServer.Builder

Method Summary

Modifier and Type	Method and Description
static GameServer.Builder	builder()
GameServerClaimStatus	claimStatus() Indicates when an available game server has been reserved but has not yet started hosting a game.
String	claimStatusAsString() Indicates when an available game server has been reserved but has not yet started hosting a game.
String	connectionInfo() The port and IP address that must be used to establish a client connection to the game server.
String	customSortKey() A game server tag that can be used to request sorted lists of game servers when calling ListGameServers.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameServerData() A set of custom game server properties, formatted as a single string value.
String	gameServerGroupArn() The ARN identifier for the game server group where the game server is located.
String	gameServerGroupName() The name identifier for the game server group where the game server is located.
String	gameServerId() A custom string that uniquely identifies the game server.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId() The unique identifier for the instance where the game server is located.
Instant	lastClaimTime() Time stamp indicating the last time the game server was claimed with a ClaimGameServer request.
Instant	lastHealthCheckTime() Time stamp indicating the last time the game server was updated with health status using an UpdateGameServer request.
Instant	registrationTime() Time stamp indicating when the game server resource was created with a RegisterGameServer request.
List<SdkField<?>>	sdkFields()
static Class<? extends GameServer.Builder>	serializableBuilderClass()
GameServer.Builder	toBuilder()
String	toString() Returns a string representation of this object.
GameServerUtilizationStatus	utilizationStatus() Indicates whether the game server is currently available for new games or is busy.
String	utilizationStatusAsString() Indicates whether the game server is currently available for new games or is busy.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

gameServerGroupName

public String gameServerGroupName()

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

Returns:

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

gameServerGroupArn

public String 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

public 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.

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 AWS account.

instanceId

public String instanceId()

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

Returns:

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

connectionInfo

public String 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

public 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.

Returns:

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.

customSortKey

public 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.

Returns:

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.

claimStatus

public 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.

If the service returns an enum value that is not available in the current SDK version, claimStatus will return GameServerClaimStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from claimStatusAsString().

Returns:

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.

See Also:

GameServerClaimStatus

claimStatusAsString

public String claimStatusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, claimStatus will return GameServerClaimStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from claimStatusAsString().

Returns:

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.

See Also:

GameServerClaimStatus

utilizationStatus

public 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.

If the service returns an enum value that is not available in the current SDK version, utilizationStatus will return GameServerUtilizationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from utilizationStatusAsString().

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.

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

See Also:

GameServerUtilizationStatus

utilizationStatusAsString

public String 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.

• IN_USE - 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 return GameServerUtilizationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from utilizationStatusAsString().

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.

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

See Also:

GameServerUtilizationStatus

registrationTime

public 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").

Returns:

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").

lastClaimTime

public 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.

Returns:

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.

lastHealthCheckTime

public 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.

Returns:

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.

toBuilder

public GameServer.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GameServer.Builder,GameServer>

builder

public static GameServer.Builder builder()

serializableBuilderClass

public static Class<? extends GameServer.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo