com.amazonaws.services.gamelift.model

Class RegisterGameServerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.RegisterGameServerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterGameServerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterGameServerRequest()

Method Summary

Modifier and Type	Method and Description
RegisterGameServerRequest	clone()
boolean	equals(Object obj)
String	getConnectionInfo() Information needed to make inbound client connections to the game server.
String	getCustomSortKey() A game server tag that can be used to request sorted lists of game servers using ListGameServers.
String	getGameServerData() A set of custom game server properties, formatted as a single string value.
String	getGameServerGroupName() An identifier for the game server group where the game server is running.
String	getGameServerId() A custom string that uniquely identifies the new game server.
String	getInstanceId() The unique identifier for the instance where the game server is running.
List<Tag>	getTags() A list of labels to assign to the new game server resource.
int	hashCode()
void	setConnectionInfo(String connectionInfo) Information needed to make inbound client connections to the game server.
void	setCustomSortKey(String customSortKey) A game server tag that can be used to request sorted lists of game servers using ListGameServers.
void	setGameServerData(String gameServerData) A set of custom game server properties, formatted as a single string value.
void	setGameServerGroupName(String gameServerGroupName) An identifier for the game server group where the game server is running.
void	setGameServerId(String gameServerId) A custom string that uniquely identifies the new game server.
void	setInstanceId(String instanceId) The unique identifier for the instance where the game server is running.
void	setTags(Collection<Tag> tags) A list of labels to assign to the new game server resource.
String	toString() Returns a string representation of this object.
RegisterGameServerRequest	withConnectionInfo(String connectionInfo) Information needed to make inbound client connections to the game server.
RegisterGameServerRequest	withCustomSortKey(String customSortKey) A game server tag that can be used to request sorted lists of game servers using ListGameServers.
RegisterGameServerRequest	withGameServerData(String gameServerData) A set of custom game server properties, formatted as a single string value.
RegisterGameServerRequest	withGameServerGroupName(String gameServerGroupName) An identifier for the game server group where the game server is running.
RegisterGameServerRequest	withGameServerId(String gameServerId) A custom string that uniquely identifies the new game server.
RegisterGameServerRequest	withInstanceId(String instanceId) The unique identifier for the instance where the game server is running.
RegisterGameServerRequest	withTags(Collection<Tag> tags) A list of labels to assign to the new game server resource.
RegisterGameServerRequest	withTags(Tag... tags) A list of labels to assign to the new game server resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterGameServerRequest

public RegisterGameServerRequest()

Method Detail

setGameServerGroupName

public void setGameServerGroupName(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.

Parameters:

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

getGameServerGroupName

public String getGameServerGroupName()

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.

withGameServerGroupName

public RegisterGameServerRequest withGameServerGroupName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setGameServerId

public void setGameServerId(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.

Parameters:

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.

getGameServerId

public String getGameServerId()

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.

withGameServerId

public RegisterGameServerRequest withGameServerId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setInstanceId

public void setInstanceId(String instanceId)

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

Parameters:

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

getInstanceId

public String getInstanceId()

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.

withInstanceId

public RegisterGameServerRequest withInstanceId(String instanceId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setConnectionInfo

public void setConnectionInfo(String connectionInfo)

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

Parameters:

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

getConnectionInfo

public String getConnectionInfo()

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.

withConnectionInfo

public RegisterGameServerRequest withConnectionInfo(String connectionInfo)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setGameServerData

public void setGameServerData(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.

Parameters:

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.

getGameServerData

public String getGameServerData()

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.

withGameServerData

public RegisterGameServerRequest withGameServerData(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setCustomSortKey

public void setCustomSortKey(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.

Parameters:

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.

getCustomSortKey

public String getCustomSortKey()

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.

withCustomSortKey

public RegisterGameServerRequest withCustomSortKey(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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.

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.

setTags

public void setTags(Collection<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.

Parameters:

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.

withTags

public RegisterGameServerRequest withTags(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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public RegisterGameServerRequest withTags(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RegisterGameServerRequest clone()

Overrides:

clone in class AmazonWebServiceRequest