Package software.amazon.awssdk.services.gamelift.model

Class StartGameSessionPlacementRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.gamelift.model.StartGameSessionPlacementRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>

@Generated("software.amazon.awssdk:codegen")
public class StartGameSessionPlacementRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartGameSessionPlacementRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	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.
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.
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 players are experiencing 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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

placementId

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.

Returns:

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.

gameSessionQueueName

public String gameSessionQueueName()

Name of the queue to use to place the new game session.

Returns:

Name of the queue to use to place the new game session.

gameProperties

public List<GameProperty> gameProperties()

Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

Returns:

Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

maximumPlayerSessionCount

public Integer maximumPlayerSessionCount()

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.

gameSessionName

public String gameSessionName()

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

Returns:

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

playerLatencies

public List<PlayerLatency> playerLatencies()

Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing 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.

Returns:

Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing 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.

desiredPlayerSessions

public List<DesiredPlayerSession> desiredPlayerSessions()

Set of information on each player to create a player session for.

Returns:

Set of information on each player to create a player session for.

toBuilder

public StartGameSessionPlacementRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>

Returns:

a builder for type T

builder

public static StartGameSessionPlacementRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartGameSessionPlacementRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object