com.amazonaws.services.gamelift.model

Class CreateGameSessionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.CreateGameSessionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateGameSessionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for a request action.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateGameSessionRequest()

Method Summary

Modifier and Type	Method and Description
CreateGameSessionRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAliasId() Unique identifier for a fleet alias.
String	getCreatorId() Player ID identifying the person or entity creating the game session.
String	getFleetId() Unique identifier for a fleet.
List<GameProperty>	getGameProperties() Set of properties used to administer a game session.
String	getGameSessionId() Custom string to include in the game session ID, with a maximum length of 48 characters.
Integer	getMaximumPlayerSessionCount() Maximum number of players that can be connected simultaneously to the game session.
String	getName() Descriptive label associated with a game session.
int	hashCode()
void	setAliasId(String aliasId) Unique identifier for a fleet alias.
void	setCreatorId(String creatorId) Player ID identifying the person or entity creating the game session.
void	setFleetId(String fleetId) Unique identifier for a fleet.
void	setGameProperties(Collection<GameProperty> gameProperties) Set of properties used to administer a game session.
void	setGameSessionId(String gameSessionId) Custom string to include in the game session ID, with a maximum length of 48 characters.
void	setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount) Maximum number of players that can be connected simultaneously to the game session.
void	setName(String name) Descriptive label associated with a game session.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateGameSessionRequest	withAliasId(String aliasId) Unique identifier for a fleet alias.
CreateGameSessionRequest	withCreatorId(String creatorId) Player ID identifying the person or entity creating the game session.
CreateGameSessionRequest	withFleetId(String fleetId) Unique identifier for a fleet.
CreateGameSessionRequest	withGameProperties(Collection<GameProperty> gameProperties) Set of properties used to administer a game session.
CreateGameSessionRequest	withGameProperties(GameProperty... gameProperties) Set of properties used to administer a game session.
CreateGameSessionRequest	withGameSessionId(String gameSessionId) Custom string to include in the game session ID, with a maximum length of 48 characters.
CreateGameSessionRequest	withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount) Maximum number of players that can be connected simultaneously to the game session.
CreateGameSessionRequest	withName(String name) Descriptive label associated with a game session.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateGameSessionRequest

public CreateGameSessionRequest()

Method Detail

setFleetId

public void setFleetId(String fleetId)

Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

Parameters:

fleetId - Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

getFleetId

public String getFleetId()

Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

withFleetId

public CreateGameSessionRequest withFleetId(String fleetId)

Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

Parameters:

fleetId - Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

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

setAliasId

public void setAliasId(String aliasId)

Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

Parameters:

aliasId - Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

getAliasId

public String getAliasId()

Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

withAliasId

public CreateGameSessionRequest withAliasId(String aliasId)

Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

Parameters:

aliasId - Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

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

setMaximumPlayerSessionCount

public void setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)

Maximum number of players that can be connected simultaneously to the game session.

Parameters:

maximumPlayerSessionCount - Maximum number of players that can be connected simultaneously to the game session.

getMaximumPlayerSessionCount

public Integer getMaximumPlayerSessionCount()

Maximum number of players that can be connected simultaneously to the game session.

Returns:

Maximum number of players that can be connected simultaneously to the game session.

withMaximumPlayerSessionCount

public CreateGameSessionRequest withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)

Maximum number of players that can be connected simultaneously to the game session.

Parameters:

maximumPlayerSessionCount - Maximum number of players that can be connected simultaneously to the game session.

Returns:

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

setName

public void setName(String name)

Descriptive label associated with a game session. Session names do not need to be unique.

Parameters:

name - Descriptive label associated with a game session. Session names do not need to be unique.

getName

public String getName()

Descriptive label associated with a game session. Session names do not need to be unique.

Returns:

Descriptive label associated with a game session. Session names do not need to be unique.

withName

public CreateGameSessionRequest withName(String name)

Descriptive label associated with a game session. Session names do not need to be unique.

Parameters:

name - Descriptive label associated with a game session. Session names do not need to be unique.

Returns:

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

getGameProperties

public List<GameProperty> getGameProperties()

Set of properties used to administer a game session. These properties are passed to the server process hosting it.

Returns:

Set of properties used to administer a game session. These properties are passed to the server process hosting it.

setGameProperties

public void setGameProperties(Collection<GameProperty> gameProperties)

Set of properties used to administer a game session. These properties are passed to the server process hosting it.

Parameters:

gameProperties - Set of properties used to administer a game session. These properties are passed to the server process hosting it.

withGameProperties

public CreateGameSessionRequest withGameProperties(GameProperty... gameProperties)

Set of properties used to administer a game session. These properties are passed to the server process hosting it.

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

Parameters:

gameProperties - Set of properties used to administer a game session. These properties are passed to the server process hosting it.

Returns:

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

withGameProperties

public CreateGameSessionRequest withGameProperties(Collection<GameProperty> gameProperties)

Set of properties used to administer a game session. These properties are passed to the server process hosting it.

Parameters:

gameProperties - Set of properties used to administer a game session. These properties are passed to the server process hosting it.

Returns:

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

setCreatorId

public void setCreatorId(String creatorId)

Player ID identifying the person or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Parameters:

creatorId - Player ID identifying the person or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

getCreatorId

public String getCreatorId()

Player ID identifying the person or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Returns:

Player ID identifying the person or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

withCreatorId

public CreateGameSessionRequest withCreatorId(String creatorId)

Player ID identifying the person or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Parameters:

creatorId - Player ID identifying the person or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Returns:

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

setGameSessionId

public void setGameSessionId(String gameSessionId)

Custom string to include in the game session ID, with a maximum length of 48 characters. If this parameter is set, GameLift creates a game session ID in the following format: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<custom ID string>". For example, this full game session ID: "arn:aws:gamelift:us-west-2::gamesession/fleet-2ec2aae5-c2c7-43ca-b19d-8249fe5fddf2/my-game-session" includes the custom ID string "my-game-session". If this parameter is not set, GameLift creates a game session ID in the same format with an autogenerated ID string.

Parameters:

gameSessionId - Custom string to include in the game session ID, with a maximum length of 48 characters. If this parameter is set, GameLift creates a game session ID in the following format: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<custom ID string>". For example, this full game session ID: "arn:aws:gamelift:us-west-2::gamesession/fleet-2ec2aae5-c2c7-43ca-b19d-8249fe5fddf2/my-game-session" includes the custom ID string "my-game-session". If this parameter is not set, GameLift creates a game session ID in the same format with an autogenerated ID string.

getGameSessionId

public String getGameSessionId()

Custom string to include in the game session ID, with a maximum length of 48 characters. If this parameter is set, GameLift creates a game session ID in the following format: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<custom ID string>". For example, this full game session ID: "arn:aws:gamelift:us-west-2::gamesession/fleet-2ec2aae5-c2c7-43ca-b19d-8249fe5fddf2/my-game-session" includes the custom ID string "my-game-session". If this parameter is not set, GameLift creates a game session ID in the same format with an autogenerated ID string.

Returns:

Custom string to include in the game session ID, with a maximum length of 48 characters. If this parameter is set, GameLift creates a game session ID in the following format: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<custom ID string>". For example, this full game session ID: "arn:aws:gamelift:us-west-2::gamesession/fleet-2ec2aae5-c2c7-43ca-b19d-8249fe5fddf2/my-game-session" includes the custom ID string "my-game-session". If this parameter is not set, GameLift creates a game session ID in the same format with an autogenerated ID string.

withGameSessionId

public CreateGameSessionRequest withGameSessionId(String gameSessionId)

Custom string to include in the game session ID, with a maximum length of 48 characters. If this parameter is set, GameLift creates a game session ID in the following format: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<custom ID string>". For example, this full game session ID: "arn:aws:gamelift:us-west-2::gamesession/fleet-2ec2aae5-c2c7-43ca-b19d-8249fe5fddf2/my-game-session" includes the custom ID string "my-game-session". If this parameter is not set, GameLift creates a game session ID in the same format with an autogenerated ID string.

Parameters:

gameSessionId - Custom string to include in the game session ID, with a maximum length of 48 characters. If this parameter is set, GameLift creates a game session ID in the following format: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<custom ID string>". For example, this full game session ID: "arn:aws:gamelift:us-west-2::gamesession/fleet-2ec2aae5-c2c7-43ca-b19d-8249fe5fddf2/my-game-session" includes the custom ID string "my-game-session". If this parameter is not set, GameLift creates a game session ID in the same format with an autogenerated ID string.

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; useful for testing and debugging.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()