software.amazon.awssdk.services.gamelift.model

Class RegisterGameServerRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterGameServerRequest.Builder,RegisterGameServerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterGameServerRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RegisterGameServerRequest.Builder	builder()
String	connectionInfo() Information needed to make inbound client connections to the game server.
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() A custom string that uniquely identifies the new game server.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	instanceId() The unique identifier for the instance where the game server is running.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterGameServerRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of labels to assign to the new game server resource.
RegisterGameServerRequest.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 where the game server is running. You can use either the GameServerGroup name or ARN value.

Returns:

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

gameServerId

public String gameServerId()

A custom string that uniquely identifies the new game server. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.

Returns:

A custom string that uniquely identifies the new game server. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.

instanceId

public String instanceId()

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata.

Returns:

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata.

connectionInfo

public String connectionInfo()

Information needed to make inbound client connections to the game server. This might include IP address and port, DNS name, etc.

Returns:

Information needed to make inbound client connections to the game server. This might include IP address and port, DNS name, etc.

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

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public List<Tag> tags()

A list of labels to assign to the new game server resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

A list of labels to assign to the new game server resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

toBuilder

public RegisterGameServerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterGameServerRequest.Builder,RegisterGameServerRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static RegisterGameServerRequest.Builder builder()

serializableBuilderClass

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