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(value="software.amazon.awssdk:codegen")
public final class UpdateGameServerRequest
extends GameLiftRequest
implements ToCopyableBuilder<UpdateGameServerRequest.Builder,UpdateGameServerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateGameServerRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateGameServerRequest.Builder	builder()
String	customSortKey() A game server tag that can be used to request sorted lists of game servers using 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	gameServerGroupName() An identifier for the game server group where the game server is running.
String	gameServerId() The identifier for the game server to be updated.
<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 whether the game server is available or is currently hosting gameplay.
String	utilizationStatusAsString() Indicates whether 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 String gameServerGroupName()

An identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

Returns:

An identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

gameServerId

public String gameServerId()

The identifier for the game server to be updated.

Returns:

The identifier for the game server to be updated.

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 when it requests information on a game servers using DescribeGameServer or ClaimGameServer.

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 a game servers using DescribeGameServer or ClaimGameServer.

customSortKey

public String customSortKey()

A game server tag that can be used to request sorted lists of game servers using ListGameServers. Custom sort keys are developer-defined based on how you want to organize the retrieved game server information.

Returns:

A game server tag that can be used to request sorted lists of game servers using ListGameServers. Custom sort keys are developer-defined based on how you want to organize the retrieved game server information.

utilizationStatus

public GameServerUtilizationStatus utilizationStatus()

Indicates whether the game server is available or is currently hosting gameplay.

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 available or is currently hosting gameplay.

See Also:

GameServerUtilizationStatus

utilizationStatusAsString

public String utilizationStatusAsString()

Indicates whether the game server is available or is currently hosting gameplay.

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 available or is currently hosting gameplay.

See Also:

GameServerUtilizationStatus

healthCheck

public GameServerHealthCheck healthCheck()

Indicates health status of the game server. An update that explicitly includes this parameter updates the game server's LastHealthCheckTime time stamp.

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. An update that explicitly includes this parameter updates the game server's LastHealthCheckTime time stamp.

See Also:

GameServerHealthCheck

healthCheckAsString

public String healthCheckAsString()

Indicates health status of the game server. An update that explicitly includes this parameter updates the game server's LastHealthCheckTime time stamp.

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. An update that explicitly includes this parameter updates the game server's LastHealthCheckTime time stamp.

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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo