software.amazon.awssdk.services.gamelift.model

Class UpdateMatchmakingConfigurationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateMatchmakingConfigurationRequest.Builder,UpdateMatchmakingConfigurationRequest>

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

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateMatchmakingConfigurationRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	acceptanceRequired() Flag that determines whether a match that was created with this configuration must be accepted by the matched players.
Integer	acceptanceTimeoutSeconds() Length of time (in seconds) to wait for players to accept a proposed match.
Integer	additionalPlayerCount() Number of player slots in a match to keep open for future players.
BackfillMode	backfillMode() Method used to backfill game sessions created with this matchmaking configuration.
String	backfillModeAsString() Method used to backfill game sessions created with this matchmaking configuration.
static UpdateMatchmakingConfigurationRequest.Builder	builder()
String	customEventData() Information to add to all events related to the matchmaking configuration.
String	description() Descriptive label that is associated with matchmaking configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<GameProperty>	gameProperties() Set of custom properties for a game session, formatted as key:value pairs.
String	gameSessionData() Set of custom game session properties, formatted as a single string value.
List<String>	gameSessionQueueArns() Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() Unique identifier for a matchmaking configuration to update.
String	notificationTarget() SNS topic ARN that is set up to receive matchmaking notifications.
Integer	requestTimeoutSeconds() Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
String	ruleSetName() Unique identifier for a matchmaking rule set to use with this configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateMatchmakingConfigurationRequest.Builder>	serializableBuilderClass()
UpdateMatchmakingConfigurationRequest.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

name

public String name()

Unique identifier for a matchmaking configuration to update.

Returns:

Unique identifier for a matchmaking configuration to update.

description

public String description()

Descriptive label that is associated with matchmaking configuration.

Returns:

Descriptive label that is associated with matchmaking configuration.

gameSessionQueueArns

public List<String> gameSessionQueueArns()

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

requestTimeoutSeconds

public Integer requestTimeoutSeconds()

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

Returns:

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

acceptanceTimeoutSeconds

public Integer acceptanceTimeoutSeconds()

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

Returns:

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

acceptanceRequired

public Boolean acceptanceRequired()

Flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

Returns:

Flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

ruleSetName

public String ruleSetName()

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

Returns:

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

notificationTarget

public String notificationTarget()

SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

Returns:

SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

additionalPlayerCount

public Integer additionalPlayerCount()

Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

Returns:

Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

customEventData

public String customEventData()

Information to add to all events related to the matchmaking configuration.

Returns:

Information to add to all events related to the matchmaking configuration.

gameProperties

public List<GameProperty> gameProperties()

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 (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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 (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

gameSessionData

public String gameSessionData()

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). This information is added to the new GameSession object that is created for a successful match.

Returns:

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). This information is added to the new GameSession object that is created for a successful match.

backfillMode

public BackfillMode backfillMode()

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

If the service returns an enum value that is not available in the current SDK version, backfillMode will return BackfillMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backfillModeAsString().

Returns:

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

See Also:

BackfillMode

backfillModeAsString

public String backfillModeAsString()

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

If the service returns an enum value that is not available in the current SDK version, backfillMode will return BackfillMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backfillModeAsString().

Returns:

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

See Also:

BackfillMode

toBuilder

public UpdateMatchmakingConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateMatchmakingConfigurationRequest.Builder,UpdateMatchmakingConfigurationRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static UpdateMatchmakingConfigurationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateMatchmakingConfigurationRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo