Interface StartGameSessionPlacementRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>, GameLiftRequest.Builder, SdkBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartGameSessionPlacementRequest
@Mutable @NotThreadSafe public static interface StartGameSessionPlacementRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>

  • Method Details

    • placementId

      StartGameSessionPlacementRequest.Builder placementId(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.

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

    • gameSessionQueueName

      StartGameSessionPlacementRequest.Builder gameSessionQueueName(String gameSessionQueueName)

      Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

      Parameters:
      gameSessionQueueName - Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameProperties

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

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

      StartGameSessionPlacementRequest.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<GameProperty>).

      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:

    • maximumPlayerSessionCount

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

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

    • playerLatencies

      StartGameSessionPlacementRequest.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. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

      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. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playerLatencies

      StartGameSessionPlacementRequest.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. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

      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. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playerLatencies

      StartGameSessionPlacementRequest.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 information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

      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<PlayerLatency>).

      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:

    • desiredPlayerSessions

      StartGameSessionPlacementRequest.Builder desiredPlayerSessions(Collection<DesiredPlayerSession> desiredPlayerSessions)

      Set of information on each player to create a player session for.

      Parameters:
      desiredPlayerSessions - Set of information on each player to create a player session for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredPlayerSessions

      StartGameSessionPlacementRequest.Builder desiredPlayerSessions(DesiredPlayerSession... desiredPlayerSessions)

      Set of information on each player to create a player session for.

      Parameters:
      desiredPlayerSessions - Set of information on each player to create a player session for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredPlayerSessions

      StartGameSessionPlacementRequest.Builder desiredPlayerSessions(Consumer<DesiredPlayerSession.Builder>... desiredPlayerSessions)

      Set of information on each player to create a player session for.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to desiredPlayerSessions(List<DesiredPlayerSession>).

      Parameters:
      desiredPlayerSessions - a consumer that will call methods on DesiredPlayerSession.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • gameSessionData

      StartGameSessionPlacementRequest.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 with a request to start a new game session. For more information, 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 with a request to start a new game session. For more information, see Start a game session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priorityConfigurationOverride

      StartGameSessionPlacementRequest.Builder priorityConfigurationOverride(PriorityConfigurationOverride priorityConfigurationOverride)

      A prioritized list of locations to use for the game session placement and instructions on how to use it. This list overrides a queue's prioritized location list for this game session placement request only. You can include Amazon Web Services Regions, local zones, and custom locations (for Anywhere fleets). You can choose to limit placements to locations on the override list only, or you can prioritize locations on the override list first and then fall back to the queue's other locations if needed. Choose a fallback strategy to use in the event that Amazon GameLift Servers fails to place a game session in any of the locations on the priority override list.

      Parameters:
      priorityConfigurationOverride - A prioritized list of locations to use for the game session placement and instructions on how to use it. This list overrides a queue's prioritized location list for this game session placement request only. You can include Amazon Web Services Regions, local zones, and custom locations (for Anywhere fleets). You can choose to limit placements to locations on the override list only, or you can prioritize locations on the override list first and then fall back to the queue's other locations if needed. Choose a fallback strategy to use in the event that Amazon GameLift Servers fails to place a game session in any of the locations on the priority override list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priorityConfigurationOverride

      default StartGameSessionPlacementRequest.Builder priorityConfigurationOverride(Consumer<PriorityConfigurationOverride.Builder> priorityConfigurationOverride)

      A prioritized list of locations to use for the game session placement and instructions on how to use it. This list overrides a queue's prioritized location list for this game session placement request only. You can include Amazon Web Services Regions, local zones, and custom locations (for Anywhere fleets). You can choose to limit placements to locations on the override list only, or you can prioritize locations on the override list first and then fall back to the queue's other locations if needed. Choose a fallback strategy to use in the event that Amazon GameLift Servers fails to place a game session in any of the locations on the priority override list.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to priorityConfigurationOverride(PriorityConfigurationOverride).

      Parameters:
      priorityConfigurationOverride - a consumer that will call methods on PriorityConfigurationOverride.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      StartGameSessionPlacementRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartGameSessionPlacementRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.