@Generated(value="software.amazon.awssdk:codegen") public class StartGameSessionPlacementRequest extends GameLiftRequest implements ToCopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>
Represents the input for a request action.
Modifier and Type | Class and Description |
---|---|
static interface |
StartGameSessionPlacementRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static StartGameSessionPlacementRequest.Builder |
builder() |
List<DesiredPlayerSession> |
desiredPlayerSessions()
Set of information on each player to create a player session for.
|
boolean |
equals(Object obj) |
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 |
gameSessionName()
Descriptive label that is associated with a game session.
|
String |
gameSessionQueueName()
Name of the queue to use to place the new game session.
|
<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() |
Integer |
maximumPlayerSessionCount()
Maximum number of players that can be connected simultaneously to the game session.
|
String |
placementId()
Unique identifier to assign to the new game session placement.
|
List<PlayerLatency> |
playerLatencies()
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when
connected to AWS regions.
|
static Class<? extends StartGameSessionPlacementRequest.Builder> |
serializableBuilderClass() |
StartGameSessionPlacementRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String placementId()
Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.
public String gameSessionQueueName()
Name of the queue to use to place the new game session.
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 Integer maximumPlayerSessionCount()
Maximum number of players that can be connected simultaneously to the game session.
public String gameSessionName()
Descriptive label that is associated with a game session. Session names do not need to be unique.
public List<PlayerLatency> playerLatencies()
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<DesiredPlayerSession> desiredPlayerSessions()
Set of information on each player to create a player session for.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 StartGameSessionPlacementRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>
toBuilder
in class GameLiftRequest
public static StartGameSessionPlacementRequest.Builder builder()
public static Class<? extends StartGameSessionPlacementRequest.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.