@Generated(value="software.amazon.awssdk:codegen") public final class CreateGameSessionRequest extends GameLiftRequest implements ToCopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>
Represents the input for a request action.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateGameSessionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
aliasId()
Unique identifier for an alias associated with the fleet to create a game session in.
|
static CreateGameSessionRequest.Builder |
builder() |
String |
creatorId()
Unique identifier for a player or entity creating the game session.
|
boolean |
equals(Object obj) |
String |
fleetId()
Unique identifier for a fleet to create a game session in.
|
List<GameProperty> |
gameProperties()
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
String |
gameSessionData()
Set of developer-defined game session properties, formatted as a single string value.
|
String |
gameSessionId()
This parameter is no longer preferred.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
idempotencyToken()
Custom string that uniquely identifies a request for a new game session.
|
Integer |
maximumPlayerSessionCount()
Maximum number of players that can be connected simultaneously to the game session.
|
String |
name()
Descriptive label that is associated with a game session.
|
static Class<? extends CreateGameSessionRequest.Builder> |
serializableBuilderClass() |
CreateGameSessionRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String fleetId()
Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.
public String aliasId()
Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.
public Integer maximumPlayerSessionCount()
Maximum number of players that can be connected simultaneously to the game session.
public String name()
Descriptive label that is associated with a game session. Session names do not need to be unique.
public List<GameProperty> gameProperties()
Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String creatorId()
Unique identifier for a player 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.
public String gameSessionId()
This parameter is no longer preferred. Please use IdempotencyToken
instead. Custom string
that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided,
this string is included in the new game session's ID. (A game session ARN has the following format:
arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
.)
IdempotencyToken
instead. Custom
string that uniquely identifies a request for a new game session. Maximum token length is 48 characters.
If provided, this string is included in the new game session's ID. (A game session ARN has the following
format:
arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
.)public String idempotencyToken()
Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters.
If provided, this string is included in the new game session's ID. (A game session ARN has the following format:
arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained
for this time period and then deleted.
arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are
retained for this time period and then deleted.public String gameSessionData()
Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
public CreateGameSessionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>
toBuilder
in class GameLiftRequest
public static CreateGameSessionRequest.Builder builder()
public static Class<? extends CreateGameSessionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.