Package software.amazon.awssdk.services.gamelift.model

Class UpdateGameServerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.UpdateGameServerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateGameServerRequest.Builder,UpdateGameServerRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateGameServerRequest
extends GameLiftRequest
implements ToCopyableBuilder<UpdateGameServerRequest.Builder,UpdateGameServerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateGameServerRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateGameServerRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameServerData()	A set of custom game server properties, formatted as a single string value.
String	gameServerGroupName()	A unique identifier for the game server group where the game server is running.
String	gameServerId()	A custom string that uniquely identifies the game server to update.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
GameServerHealthCheck	healthCheck()	Indicates health status of the game server.
String	healthCheckAsString()	Indicates health status of the game server.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateGameServerRequest.Builder>	serializableBuilderClass()
UpdateGameServerRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GameServerUtilizationStatus	utilizationStatus()	Indicates if the game server is available or is currently hosting gameplay.
String	utilizationStatusAsString()	Indicates if the game server is available or is currently hosting gameplay.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

gameServerId

public final String gameServerId()

A custom string that uniquely identifies the game server to update.

Returns:

A custom string that uniquely identifies the game server to update.

gameServerData

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

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.

utilizationStatus

public final GameServerUtilizationStatus utilizationStatus()

Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.

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 if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.

See Also:

GameServerUtilizationStatus

utilizationStatusAsString

public final String utilizationStatusAsString()

Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.

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 if the game server is available or is currently hosting gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't change a the status from UTILIZED to AVAILABLE.

See Also:

GameServerUtilizationStatus

healthCheck

public final GameServerHealthCheck healthCheck()

Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

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

Returns:

Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

See Also:

GameServerHealthCheck

healthCheckAsString

public final String healthCheckAsString()

Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

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

Returns:

Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

See Also:

GameServerHealthCheck

toBuilder

public UpdateGameServerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateGameServerRequest.Builder,UpdateGameServerRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static UpdateGameServerRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo