Package 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("software.amazon.awssdk:codegen") public final class StartGameSessionPlacementRequest extends GameLiftRequest implements ToCopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>

  • Method Details

    • 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.

      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.

    • 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 key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

      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 key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

    • 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 Amazon Web Services 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 Amazon Web Services 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()
      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>
      Specified by:
      toBuilder in class GameLiftRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.