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

Interface GameSessionPlacement.Builder

    • Method Detail

      • placementId

        GameSessionPlacement.Builder placementId​(String placementId)

        A unique identifier for a game session placement.

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

      • gameSessionQueueName

        GameSessionPlacement.Builder gameSessionQueueName​(String gameSessionQueueName)

        A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

        Parameters:
        gameSessionQueueName - A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        GameSessionPlacement.Builder status​(String status)

        Current status of the game session placement request.

        • PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.

        • FULFILLED -- A new game session has been successfully placed. Game session properties are now final.

        • CANCELLED -- The placement request was canceled.

        • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

        • FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

        Parameters:
        status - Current status of the game session placement request.

        • PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.

        • FULFILLED -- A new game session has been successfully placed. Game session properties are now final.

        • CANCELLED -- The placement request was canceled.

        • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

        • FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

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

      • status

        GameSessionPlacement.Builder status​(GameSessionPlacementState status)

        Current status of the game session placement request.

        • PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.

        • FULFILLED -- A new game session has been successfully placed. Game session properties are now final.

        • CANCELLED -- The placement request was canceled.

        • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

        • FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

        Parameters:
        status - Current status of the game session placement request.

        • PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.

        • FULFILLED -- A new game session has been successfully placed. Game session properties are now final.

        • CANCELLED -- The placement request was canceled.

        • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

        • FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

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

      • gameProperties

        GameSessionPlacement.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"}.

        Parameters:
        gameProperties - A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gameProperties

        GameSessionPlacement.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"}.

        Parameters:
        gameProperties - A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gameProperties

        GameSessionPlacement.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"}.

        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)

      • maximumPlayerSessionCount

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

      • gameSessionName

        GameSessionPlacement.Builder gameSessionName​(String gameSessionName)

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

        Parameters:
        gameSessionName - 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.

      • gameSessionId

        GameSessionPlacement.Builder gameSessionId​(String gameSessionId)

        A unique identifier for the game session. This value isn't final until placement status is FULFILLED.

        Parameters:
        gameSessionId - A unique identifier for the game session. This value isn't final until placement status is FULFILLED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gameSessionArn

        GameSessionPlacement.Builder gameSessionArn​(String gameSessionArn)

        Identifier for the game session created by this placement request. This identifier is unique across all Regions. This value isn't final until placement status is FULFILLED.

        Parameters:
        gameSessionArn - Identifier for the game session created by this placement request. This identifier is unique across all Regions. This value isn't final until placement status is FULFILLED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gameSessionRegion

        GameSessionPlacement.Builder gameSessionRegion​(String gameSessionRegion)

        Name of the Region where the game session created by this placement request is running. This value isn't final until placement status is FULFILLED.

        Parameters:
        gameSessionRegion - Name of the Region where the game session created by this placement request is running. This value isn't final until placement status is FULFILLED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • playerLatencies

        GameSessionPlacement.Builder playerLatencies​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • playerLatencies

        GameSessionPlacement.Builder playerLatencies​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • playerLatencies

        GameSessionPlacement.Builder playerLatencies​(Consumer<PlayerLatency.Builder>... 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 is a convenience method that creates an instance of the PlayerLatency.Builder avoiding the need to create one manually via PlayerLatency.builder().

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

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

      • startTime

        GameSessionPlacement.Builder startTime​(Instant startTime)

        Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        Parameters:
        startTime - Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endTime

        GameSessionPlacement.Builder endTime​(Instant endTime)

        Time stamp indicating when this request was completed, canceled, or timed out.

        Parameters:
        endTime - Time stamp indicating when this request was completed, canceled, or timed out.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipAddress

        GameSessionPlacement.Builder ipAddress​(String ipAddress)

        The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status is FULFILLED.

        Parameters:
        ipAddress - The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status is FULFILLED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dnsName

        GameSessionPlacement.Builder dnsName​(String dnsName)

        The DNS identifier assigned to the instance that is running the game session. Values have the following format:

        • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

        • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

        When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        Parameters:
        dnsName - The DNS identifier assigned to the instance that is running the game session. Values have the following format:

        • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

        • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

        When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

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

      • port

        GameSessionPlacement.Builder port​(Integer port)

        The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status is FULFILLED.

        Parameters:
        port - The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value isn't final until placement status is FULFILLED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • placedPlayerSessions

        GameSessionPlacement.Builder placedPlayerSessions​(Collection<PlacedPlayerSession> placedPlayerSessions)

        A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID, provided in the placement request, and a corresponding player session ID.

        Parameters:
        placedPlayerSessions - A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID, provided in the placement request, and a corresponding player session ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • placedPlayerSessions

        GameSessionPlacement.Builder placedPlayerSessions​(PlacedPlayerSession... placedPlayerSessions)

        A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID, provided in the placement request, and a corresponding player session ID.

        Parameters:
        placedPlayerSessions - A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID, provided in the placement request, and a corresponding player session ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • placedPlayerSessions

        GameSessionPlacement.Builder placedPlayerSessions​(Consumer<PlacedPlayerSession.Builder>... placedPlayerSessions)

        A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID, provided in the placement request, and a corresponding player session ID.

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

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

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

      • gameSessionData

        GameSessionPlacement.Builder gameSessionData​(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).

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • matchmakerData

        GameSessionPlacement.Builder matchmakerData​(String matchmakerData)

        Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

        Parameters:
        matchmakerData - Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.