CreateGameSessionRequest (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.CreateGameSessionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>

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

Represents the input for a request operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateGameSessionRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`aliasId()` A unique identifier for the alias associated with the fleet to create a game session in.
`static CreateGameSessionRequest.Builder`	`builder()`
`String`	`creatorId()` A unique identifier for a player or entity creating the game session.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fleetId()` A unique identifier for the fleet to create a game session in.
`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`	`gameSessionId()` This parameter is no longer preferred.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasGameProperties()` For responses, this returns true if the service returned a value for the GameProperties property.
`int`	`hashCode()`
`String`	`idempotencyToken()` Custom string that uniquely identifies the new game session request.
`String`	`location()` A fleet's remote location to place the new game session in.
`Integer`	`maximumPlayerSessionCount()` The maximum number of players that can be connected simultaneously to the game session.
`String`	`name()` A descriptive label that is associated with a game session.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateGameSessionRequest.Builder>`	`serializableBuilderClass()`
`CreateGameSessionRequest.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
  - fleetId
```
public final String fleetId()
```
    A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
    
    Returns:
    
    A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
  - aliasId
```
public final String aliasId()
```
    A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
    
    Returns:
    
    A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
  - 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.
  - name
```
public final String name()
```
    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.
  - 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.
    
    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.
  - creatorId
```
public final String creatorId()
```
    A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.
    
    Returns:
    
    A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.
  - gameSessionId
```
public final 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.
    
    Returns:
    
    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.
  - idempotencyToken
```
public final String idempotencyToken()
```
    Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. 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.
    
    Returns:
    
    Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. 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.
  - 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.
    
    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.
  - location
```
public final String location()
```
    A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an AWS Region code such as us-west-2.
    
    Returns:
    
    A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an AWS Region code such as us-west-2.
  - toBuilder
```
public CreateGameSessionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>
    
    Specified by:
    
    toBuilder in class GameLiftRequest
  - builder
```
public static CreateGameSessionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateGameSessionRequest.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 CreateGameSessionRequest

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

fleetId

aliasId

maximumPlayerSessionCount

name

hasGameProperties

gameProperties

creatorId

gameSessionId

idempotencyToken

gameSessionData

location

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields