software.amazon.awssdk.services.gamelift.model

Class StartGameSessionPlacementRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>

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

Represents the input for a request operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartGameSessionPlacementRequest.Builder

Method Summary

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)
boolean	equalsBySdkFields(Object obj)
List<GameProperty>	gameProperties() Set of custom properties for a game session, formatted as key:value pairs.
String	gameSessionData() Set of custom game session properties, formatted as a single string value.
String	gameSessionName() A 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)
boolean	hasDesiredPlayerSessions() Returns true if the DesiredPlayerSessions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasGameProperties() Returns true if the GameProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasPlayerLatencies() Returns true if the PlayerLatencies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	maximumPlayerSessionCount() The maximum number of players that can be connected simultaneously to the game session.
String	placementId() A 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.
List<SdkField<?>>	sdkFields()
static Class<? extends StartGameSessionPlacementRequest.Builder>	serializableBuilderClass()
StartGameSessionPlacementRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

placementId

public String placementId()

A 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:

A 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. You can use either the queue name or ARN value.

Returns:

Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

hasGameProperties

public boolean hasGameProperties()

Returns true if the GameProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

gameProperties

public List<GameProperty> gameProperties()

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

You can use hasGameProperties() to see if a value was sent in this field.

Returns:

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

maximumPlayerSessionCount

public Integer maximumPlayerSessionCount()

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

Returns:

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

gameSessionName

public String gameSessionName()

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

Returns:

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

hasPlayerLatencies

public boolean hasPlayerLatencies()

Returns true if the PlayerLatencies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

playerLatencies

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.

You can use hasPlayerLatencies() to see if a value was sent in this field.

Returns:

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.

hasDesiredPlayerSessions

public boolean hasDesiredPlayerSessions()

Returns true if the DesiredPlayerSessions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

desiredPlayerSessions

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.

You can use hasDesiredPlayerSessions() to see if a value was sent in this field.

Returns:

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

gameSessionData

public String gameSessionData()

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Returns:

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

toBuilder

public StartGameSessionPlacementRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static StartGameSessionPlacementRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo