StartGameSessionPlacementRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartGameSessionPlacementRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` A set of custom properties for a game session, formatted as key:value pairs.
`String`	`gameSessionData()` A 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()` For responses, this returns true if the service returned a value for the DesiredPlayerSessions property.
`boolean`	`hasGameProperties()` For responses, this returns true if the service returned a value for the GameProperties property.
`int`	`hashCode()`
`boolean`	`hasPlayerLatencies()` For responses, this returns true if the service returned a value for the PlayerLatencies property.
`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()` A set of values, expressed in milliseconds, that indicates 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 final 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 final 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 final boolean hasGameProperties()
```
    For responses, this returns true if the service returned a value for the GameProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - gameProperties
```
public final List<GameProperty> gameProperties()
```
    A 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGameProperties() method.
    
    Returns:
    
    A 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 final 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 final 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 final boolean hasPlayerLatencies()
```
    For responses, this returns true if the service returned a value for the PlayerLatencies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - playerLatencies
```
public final List<PlayerLatency> playerLatencies()
```
    A set of values, expressed in milliseconds, that indicates 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlayerLatencies() method.
    
    Returns:
    
    A set of values, expressed in milliseconds, that indicates 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 final boolean hasDesiredPlayerSessions()
```
    For responses, this returns true if the service returned a value for the DesiredPlayerSessions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - desiredPlayerSessions
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDesiredPlayerSessions() method.
    
    Returns:
    
    Set of information on each player to create a player session for.
  - gameSessionData
```
public final String gameSessionData()
```
    A 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:
    
    A 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartGameSessionPlacementRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

placementId

gameSessionQueueName

hasGameProperties

gameProperties

maximumPlayerSessionCount

gameSessionName

hasPlayerLatencies

playerLatencies

hasDesiredPlayerSessions

desiredPlayerSessions

gameSessionData

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields