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

Interface UpdateGameSessionRequest.Builder

    • Method Detail

      • gameSessionId

        UpdateGameSessionRequest.Builder gameSessionId​(String gameSessionId)

        A unique identifier for the game session to update.

        Parameters:
        gameSessionId - A unique identifier for the game session to update.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maximumPlayerSessionCount

        UpdateGameSessionRequest.Builder maximumPlayerSessionCount​(Integer maximumPlayerSessionCount)

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

        Parameters:
        maximumPlayerSessionCount - The maximum number of players that can be connected simultaneously to the game session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        UpdateGameSessionRequest.Builder name​(String name)

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

        Parameters:
        name - A descriptive label that is associated with a game session. Session names do not need to be unique.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • playerSessionCreationPolicy

        UpdateGameSessionRequest.Builder playerSessionCreationPolicy​(String playerSessionCreationPolicy)

        A policy that determines whether the game session is accepting new players.

        Parameters:
        playerSessionCreationPolicy - A policy that determines whether the game session is accepting new players.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PlayerSessionCreationPolicy, PlayerSessionCreationPolicy

      • protectionPolicy

        UpdateGameSessionRequest.Builder protectionPolicy​(String protectionPolicy)

        Game session protection policy to apply to this game session only.

        • NoProtection -- The game session can be terminated during a scale-down event.

        • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

        Parameters:
        protectionPolicy - Game session protection policy to apply to this game session only.

        • NoProtection -- The game session can be terminated during a scale-down event.

        • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProtectionPolicy, ProtectionPolicy

      • protectionPolicy

        UpdateGameSessionRequest.Builder protectionPolicy​(ProtectionPolicy protectionPolicy)

        Game session protection policy to apply to this game session only.

        • NoProtection -- The game session can be terminated during a scale-down event.

        • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

        Parameters:
        protectionPolicy - Game session protection policy to apply to this game session only.

        • NoProtection -- The game session can be terminated during a scale-down event.

        • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProtectionPolicy, ProtectionPolicy

      • gameProperties

        UpdateGameSessionRequest.Builder gameProperties​(Collection<GameProperty> gameProperties)

        A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.

        Parameters:
        gameProperties - A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gameProperties

        UpdateGameSessionRequest.Builder gameProperties​(GameProperty... gameProperties)

        A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.

        Parameters:
        gameProperties - A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gameProperties

        UpdateGameSessionRequest.Builder gameProperties​(Consumer<GameProperty.Builder>... gameProperties)

        A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.

        This is a convenience method that creates an instance of the GameProperty.Builder avoiding the need to create one manually via GameProperty.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #gameProperties(List).

        Parameters:
        gameProperties - a consumer that will call methods on GameProperty.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #gameProperties(java.util.Collection)