com.amazonaws.services.gamelift.model

Class UpdateGameServerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.UpdateGameServerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateGameServerRequest
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
UpdateGameServerRequest()

Method Summary

Modifier and Type	Method and Description
UpdateGameServerRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
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() The identifier for the game server to be updated.
String	getHealthCheck() Indicates health status of the game server.
String	getUtilizationStatus() Indicates whether the game server is available or is currently hosting gameplay.
int	hashCode()
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) The identifier for the game server to be updated.
void	setHealthCheck(String healthCheck) Indicates health status of the game server.
void	setUtilizationStatus(String utilizationStatus) Indicates whether the game server is available or is currently hosting gameplay.
String	toString() Returns a string representation of this object.
UpdateGameServerRequest	withCustomSortKey(String customSortKey) A game server tag that can be used to request sorted lists of game servers using ListGameServers.
UpdateGameServerRequest	withGameServerData(String gameServerData) A set of custom game server properties, formatted as a single string value.
UpdateGameServerRequest	withGameServerGroupName(String gameServerGroupName) An identifier for the game server group where the game server is running.
UpdateGameServerRequest	withGameServerId(String gameServerId) The identifier for the game server to be updated.
UpdateGameServerRequest	withHealthCheck(GameServerHealthCheck healthCheck) Indicates health status of the game server.
UpdateGameServerRequest	withHealthCheck(String healthCheck) Indicates health status of the game server.
UpdateGameServerRequest	withUtilizationStatus(GameServerUtilizationStatus utilizationStatus) Indicates whether the game server is available or is currently hosting gameplay.
UpdateGameServerRequest	withUtilizationStatus(String utilizationStatus) Indicates whether the game server is available or is currently hosting gameplay.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateGameServerRequest

public UpdateGameServerRequest()

Method Detail

setGameServerGroupName

public void setGameServerGroupName(String gameServerGroupName)

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

Parameters:

gameServerGroupName - An identifier for the game server group where the game server is running. 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. 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.

withGameServerGroupName

public UpdateGameServerRequest withGameServerGroupName(String gameServerGroupName)

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

Parameters:

gameServerGroupName - An identifier for the game server group where the game server is running. 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)

The identifier for the game server to be updated.

Parameters:

gameServerId - The identifier for the game server to be updated.

getGameServerId

public String getGameServerId()

The identifier for the game server to be updated.

Returns:

The identifier for the game server to be updated.

withGameServerId

public UpdateGameServerRequest withGameServerId(String gameServerId)

The identifier for the game server to be updated.

Parameters:

gameServerId - The identifier for the game server to be updated.

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

withGameServerData

public UpdateGameServerRequest 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 DescribeGameServer 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 DescribeGameServer 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 UpdateGameServerRequest 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.

setUtilizationStatus

public void setUtilizationStatus(String utilizationStatus)

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

Parameters:

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

See Also:

GameServerUtilizationStatus

getUtilizationStatus

public String getUtilizationStatus()

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

Returns:

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

See Also:

GameServerUtilizationStatus

withUtilizationStatus

public UpdateGameServerRequest withUtilizationStatus(String utilizationStatus)

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

Parameters:

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

Returns:

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

See Also:

GameServerUtilizationStatus

withUtilizationStatus

public UpdateGameServerRequest withUtilizationStatus(GameServerUtilizationStatus utilizationStatus)

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

Parameters:

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

Returns:

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

See Also:

GameServerUtilizationStatus

setHealthCheck

public void setHealthCheck(String healthCheck)

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

Parameters:

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

getHealthCheck

public String getHealthCheck()

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

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

withHealthCheck

public UpdateGameServerRequest withHealthCheck(String healthCheck)

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

Parameters:

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

Returns:

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

See Also:

GameServerHealthCheck

withHealthCheck

public UpdateGameServerRequest withHealthCheck(GameServerHealthCheck healthCheck)

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

Parameters:

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

Returns:

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

See Also:

GameServerHealthCheck

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 UpdateGameServerRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()