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)
String	gameServerData() A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.
String	gameServerGroupName() An identifier for the game server group.
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 String gameServerGroupName()

An identifier for the game server group. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.

Returns:

An identifier for the game server group. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.

gameServerId

public String gameServerId()

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, 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, GameLift FleetIQ searches for an available game server in the specified game server group.

gameServerData

public String gameServerData()

A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.

Returns:

A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.

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