software.amazon.awssdk.services.gamelift.model

Class ClaimGameServerRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ClaimGameServerRequest.Builder,ClaimGameServerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClaimGameServerRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ClaimGameServerRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ClaimFilterOption	filterOption() Object that restricts how a claimed game server is chosen.
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 claim.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ClaimGameServerRequest.Builder>	serializableBuilderClass()
ClaimGameServerRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

Returns:

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim.

gameServerId

public final String gameServerId()

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift FleetIQ searches for an available game server in the specified game server group.

Returns:

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift FleetIQ searches for an available game server in the specified game server group.

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.

filterOption

public final ClaimFilterOption filterOption()

Object that restricts how a claimed game server is chosen.

Returns:

Object that restricts how a claimed game server is chosen.

toBuilder

public ClaimGameServerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClaimGameServerRequest.Builder,ClaimGameServerRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static ClaimGameServerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ClaimGameServerRequest.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