@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateMatchmakingConfigurationRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input for a request action.
NOOP
Constructor and Description |
---|
UpdateMatchmakingConfigurationRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateMatchmakingConfigurationRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getAcceptanceRequired()
Flag that determines whether a match that was created with this configuration must be accepted by the matched
players.
|
Integer |
getAcceptanceTimeoutSeconds()
Length of time (in seconds) to wait for players to accept a proposed match.
|
Integer |
getAdditionalPlayerCount()
Number of player slots in a match to keep open for future players.
|
String |
getBackfillMode()
Method used to backfill game sessions created with this matchmaking configuration.
|
String |
getCustomEventData()
Information to add to all events related to the matchmaking configuration.
|
String |
getDescription()
Descriptive label that is associated with matchmaking configuration.
|
List<GameProperty> |
getGameProperties()
Set of custom properties for a game session, formatted as key:value pairs.
|
String |
getGameSessionData()
Set of custom game session properties, formatted as a single string value.
|
List<String> |
getGameSessionQueueArns()
Amazon Resource Name (ARN) that
is assigned to a game session queue and uniquely identifies it.
|
String |
getName()
Unique identifier for a matchmaking configuration to update.
|
String |
getNotificationTarget()
SNS topic ARN that is set up to receive matchmaking notifications.
|
Integer |
getRequestTimeoutSeconds()
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
|
String |
getRuleSetName()
Unique identifier for a matchmaking rule set to use with this configuration.
|
int |
hashCode() |
Boolean |
isAcceptanceRequired()
Flag that determines whether a match that was created with this configuration must be accepted by the matched
players.
|
void |
setAcceptanceRequired(Boolean acceptanceRequired)
Flag that determines whether a match that was created with this configuration must be accepted by the matched
players.
|
void |
setAcceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds)
Length of time (in seconds) to wait for players to accept a proposed match.
|
void |
setAdditionalPlayerCount(Integer additionalPlayerCount)
Number of player slots in a match to keep open for future players.
|
void |
setBackfillMode(String backfillMode)
Method used to backfill game sessions created with this matchmaking configuration.
|
void |
setCustomEventData(String customEventData)
Information to add to all events related to the matchmaking configuration.
|
void |
setDescription(String description)
Descriptive label that is associated with matchmaking configuration.
|
void |
setGameProperties(Collection<GameProperty> gameProperties)
Set of custom properties for a game session, formatted as key:value pairs.
|
void |
setGameSessionData(String gameSessionData)
Set of custom game session properties, formatted as a single string value.
|
void |
setGameSessionQueueArns(Collection<String> gameSessionQueueArns)
Amazon Resource Name (ARN) that
is assigned to a game session queue and uniquely identifies it.
|
void |
setName(String name)
Unique identifier for a matchmaking configuration to update.
|
void |
setNotificationTarget(String notificationTarget)
SNS topic ARN that is set up to receive matchmaking notifications.
|
void |
setRequestTimeoutSeconds(Integer requestTimeoutSeconds)
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
|
void |
setRuleSetName(String ruleSetName)
Unique identifier for a matchmaking rule set to use with this configuration.
|
String |
toString()
Returns a string representation of this object.
|
UpdateMatchmakingConfigurationRequest |
withAcceptanceRequired(Boolean acceptanceRequired)
Flag that determines whether a match that was created with this configuration must be accepted by the matched
players.
|
UpdateMatchmakingConfigurationRequest |
withAcceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds)
Length of time (in seconds) to wait for players to accept a proposed match.
|
UpdateMatchmakingConfigurationRequest |
withAdditionalPlayerCount(Integer additionalPlayerCount)
Number of player slots in a match to keep open for future players.
|
UpdateMatchmakingConfigurationRequest |
withBackfillMode(BackfillMode backfillMode)
Method used to backfill game sessions created with this matchmaking configuration.
|
UpdateMatchmakingConfigurationRequest |
withBackfillMode(String backfillMode)
Method used to backfill game sessions created with this matchmaking configuration.
|
UpdateMatchmakingConfigurationRequest |
withCustomEventData(String customEventData)
Information to add to all events related to the matchmaking configuration.
|
UpdateMatchmakingConfigurationRequest |
withDescription(String description)
Descriptive label that is associated with matchmaking configuration.
|
UpdateMatchmakingConfigurationRequest |
withGameProperties(Collection<GameProperty> gameProperties)
Set of custom properties for a game session, formatted as key:value pairs.
|
UpdateMatchmakingConfigurationRequest |
withGameProperties(GameProperty... gameProperties)
Set of custom properties for a game session, formatted as key:value pairs.
|
UpdateMatchmakingConfigurationRequest |
withGameSessionData(String gameSessionData)
Set of custom game session properties, formatted as a single string value.
|
UpdateMatchmakingConfigurationRequest |
withGameSessionQueueArns(Collection<String> gameSessionQueueArns)
Amazon Resource Name (ARN) that
is assigned to a game session queue and uniquely identifies it.
|
UpdateMatchmakingConfigurationRequest |
withGameSessionQueueArns(String... gameSessionQueueArns)
Amazon Resource Name (ARN) that
is assigned to a game session queue and uniquely identifies it.
|
UpdateMatchmakingConfigurationRequest |
withName(String name)
Unique identifier for a matchmaking configuration to update.
|
UpdateMatchmakingConfigurationRequest |
withNotificationTarget(String notificationTarget)
SNS topic ARN that is set up to receive matchmaking notifications.
|
UpdateMatchmakingConfigurationRequest |
withRequestTimeoutSeconds(Integer requestTimeoutSeconds)
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
|
UpdateMatchmakingConfigurationRequest |
withRuleSetName(String ruleSetName)
Unique identifier for a matchmaking rule set to use with this configuration.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public UpdateMatchmakingConfigurationRequest()
public void setName(String name)
Unique identifier for a matchmaking configuration to update.
name
- Unique identifier for a matchmaking configuration to update.public String getName()
Unique identifier for a matchmaking configuration to update.
public UpdateMatchmakingConfigurationRequest withName(String name)
Unique identifier for a matchmaking configuration to update.
name
- Unique identifier for a matchmaking configuration to update.public void setDescription(String description)
Descriptive label that is associated with matchmaking configuration.
description
- Descriptive label that is associated with matchmaking configuration.public String getDescription()
Descriptive label that is associated with matchmaking configuration.
public UpdateMatchmakingConfigurationRequest withDescription(String description)
Descriptive label that is associated with matchmaking configuration.
description
- Descriptive label that is associated with matchmaking configuration.public List<String> getGameSessionQueueArns()
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.
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.public void setGameSessionQueueArns(Collection<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.
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.public UpdateMatchmakingConfigurationRequest withGameSessionQueueArns(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.
NOTE: This method appends the values to the existing list (if any). Use
setGameSessionQueueArns(java.util.Collection)
or withGameSessionQueueArns(java.util.Collection)
if you want to override the existing values.
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.public UpdateMatchmakingConfigurationRequest withGameSessionQueueArns(Collection<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.
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.public void setRequestTimeoutSeconds(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.
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.public Integer getRequestTimeoutSeconds()
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.
public UpdateMatchmakingConfigurationRequest withRequestTimeoutSeconds(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.
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.public void setAcceptanceTimeoutSeconds(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.
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.public Integer getAcceptanceTimeoutSeconds()
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.
public UpdateMatchmakingConfigurationRequest withAcceptanceTimeoutSeconds(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.
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.public void setAcceptanceRequired(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.
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.public Boolean getAcceptanceRequired()
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.
public UpdateMatchmakingConfigurationRequest withAcceptanceRequired(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.
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.public Boolean isAcceptanceRequired()
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.
public void setRuleSetName(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.
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.public String getRuleSetName()
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.
public UpdateMatchmakingConfigurationRequest withRuleSetName(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.
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.public void setNotificationTarget(String notificationTarget)
SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.
notificationTarget
- SNS topic ARN that is set up to receive matchmaking notifications. See Setting up
Notifications for Matchmaking for more information.public String getNotificationTarget()
SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.
public UpdateMatchmakingConfigurationRequest withNotificationTarget(String notificationTarget)
SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.
notificationTarget
- SNS topic ARN that is set up to receive matchmaking notifications. See Setting up
Notifications for Matchmaking for more information.public void setAdditionalPlayerCount(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.
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.public Integer getAdditionalPlayerCount()
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.
public UpdateMatchmakingConfigurationRequest withAdditionalPlayerCount(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.
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.public void setCustomEventData(String customEventData)
Information to add to all events related to the matchmaking configuration.
customEventData
- Information to add to all events related to the matchmaking configuration.public String getCustomEventData()
Information to add to all events related to the matchmaking configuration.
public UpdateMatchmakingConfigurationRequest withCustomEventData(String customEventData)
Information to add to all events related to the matchmaking configuration.
customEventData
- Information to add to all events related to the matchmaking configuration.public List<GameProperty> getGameProperties()
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.
public void setGameProperties(Collection<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.
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.public UpdateMatchmakingConfigurationRequest withGameProperties(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.
NOTE: This method appends the values to the existing list (if any). Use
setGameProperties(java.util.Collection)
or withGameProperties(java.util.Collection)
if you want
to override the existing values.
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.public UpdateMatchmakingConfigurationRequest withGameProperties(Collection<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.
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.public void setGameSessionData(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.
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.public String getGameSessionData()
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.
public UpdateMatchmakingConfigurationRequest withGameSessionData(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.
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.public void setBackfillMode(String 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.
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.BackfillMode
public String getBackfillMode()
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.
BackfillMode
public UpdateMatchmakingConfigurationRequest withBackfillMode(String 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.
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.BackfillMode
public UpdateMatchmakingConfigurationRequest withBackfillMode(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.
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.BackfillMode
public String toString()
toString
in class Object
Object.toString()
public UpdateMatchmakingConfigurationRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.