com.amazonaws.services.gamelift.model

Class UpdateMatchmakingConfigurationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.UpdateMatchmakingConfigurationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateMatchmakingConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for a request action.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateMatchmakingConfigurationRequest()

Method Summary

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 or not 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	getCustomEventData() Information to attached to all events related to the matchmaking configuration.
String	getDescription() Descriptive label that is associated with matchmaking configuration.
List<GameProperty>	getGameProperties() Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
String	getGameSessionData() Set of developer-defined 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 or not a match that was created with this configuration must be accepted by the matched players.
void	setAcceptanceRequired(Boolean acceptanceRequired) Flag that determines whether or not 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	setCustomEventData(String customEventData) Information to attached 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 developer-defined properties for a game session, formatted as a set of type:value pairs.
void	setGameSessionData(String gameSessionData) Set of developer-defined 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; useful for testing and debugging.
UpdateMatchmakingConfigurationRequest	withAcceptanceRequired(Boolean acceptanceRequired) Flag that determines whether or not 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	withCustomEventData(String customEventData) Information to attached 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 developer-defined properties for a game session, formatted as a set of type:value pairs.
UpdateMatchmakingConfigurationRequest	withGameProperties(GameProperty... gameProperties) Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
UpdateMatchmakingConfigurationRequest	withGameSessionData(String gameSessionData) Set of developer-defined 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateMatchmakingConfigurationRequest

public UpdateMatchmakingConfigurationRequest()

Method Detail

setName

public void setName(String name)

Unique identifier for a matchmaking configuration to update.

Parameters:

name - Unique identifier for a matchmaking configuration to update.

getName

public String getName()

Unique identifier for a matchmaking configuration to update.

Returns:

Unique identifier for a matchmaking configuration to update.

withName

public UpdateMatchmakingConfigurationRequest withName(String name)

Unique identifier for a matchmaking configuration to update.

Parameters:

name - Unique identifier for a matchmaking configuration to update.

Returns:

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

setDescription

public void setDescription(String description)

Descriptive label that is associated with matchmaking configuration.

Parameters:

description - Descriptive label that is associated with matchmaking configuration.

getDescription

public String getDescription()

Descriptive label that is associated with matchmaking configuration.

Returns:

Descriptive label that is associated with matchmaking configuration.

withDescription

public UpdateMatchmakingConfigurationRequest withDescription(String description)

Descriptive label that is associated with matchmaking configuration.

Parameters:

description - Descriptive label that is associated with matchmaking configuration.

Returns:

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

getGameSessionQueueArns

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>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Returns:

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

setGameSessionQueueArns

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>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Parameters:

gameSessionQueueArns - Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

withGameSessionQueueArns

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>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. 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.

Parameters:

gameSessionQueueArns - Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Returns:

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

withGameSessionQueueArns

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>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Parameters:

gameSessionQueueArns - Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Returns:

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

setRequestTimeoutSeconds

public void setRequestTimeoutSeconds(Integer requestTimeoutSeconds)

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

Parameters:

requestTimeoutSeconds - Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

getRequestTimeoutSeconds

public Integer getRequestTimeoutSeconds()

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

Returns:

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

withRequestTimeoutSeconds

public UpdateMatchmakingConfigurationRequest withRequestTimeoutSeconds(Integer requestTimeoutSeconds)

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

Parameters:

requestTimeoutSeconds - Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

Returns:

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

setAcceptanceTimeoutSeconds

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.

Parameters:

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.

getAcceptanceTimeoutSeconds

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.

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.

withAcceptanceTimeoutSeconds

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.

Parameters:

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:

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

setAcceptanceRequired

public void setAcceptanceRequired(Boolean acceptanceRequired)

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

Parameters:

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

getAcceptanceRequired

public Boolean getAcceptanceRequired()

Flag that determines whether or not 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 or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

withAcceptanceRequired

public UpdateMatchmakingConfigurationRequest withAcceptanceRequired(Boolean acceptanceRequired)

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

Parameters:

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

Returns:

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

isAcceptanceRequired

public Boolean isAcceptanceRequired()

Flag that determines whether or not 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 or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

setRuleSetName

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.

Parameters:

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.

getRuleSetName

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.

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.

withRuleSetName

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.

Parameters:

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:

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

setNotificationTarget

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.

Parameters:

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

getNotificationTarget

public String getNotificationTarget()

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.

withNotificationTarget

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.

Parameters:

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

Returns:

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

setAdditionalPlayerCount

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.

Parameters:

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.

getAdditionalPlayerCount

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.

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.

withAdditionalPlayerCount

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.

Parameters:

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:

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

setCustomEventData

public void setCustomEventData(String customEventData)

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

Parameters:

customEventData - Information to attached to all events related to the matchmaking configuration.

getCustomEventData

public String getCustomEventData()

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

Returns:

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

withCustomEventData

public UpdateMatchmakingConfigurationRequest withCustomEventData(String customEventData)

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

Parameters:

customEventData - Information to attached to all events related to the matchmaking configuration.

Returns:

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

getGameProperties

public List<GameProperty> getGameProperties()

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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 developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

setGameProperties

public void setGameProperties(Collection<GameProperty> gameProperties)

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

Parameters:

gameProperties - Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

withGameProperties

public UpdateMatchmakingConfigurationRequest withGameProperties(GameProperty... gameProperties)

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

Parameters:

gameProperties - Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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:

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

withGameProperties

public UpdateMatchmakingConfigurationRequest withGameProperties(Collection<GameProperty> gameProperties)

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

Parameters:

gameProperties - Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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:

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

setGameSessionData

public void setGameSessionData(String gameSessionData)

Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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.

Parameters:

gameSessionData - Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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.

getGameSessionData

public String getGameSessionData()

Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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 developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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.

withGameSessionData

public UpdateMatchmakingConfigurationRequest withGameSessionData(String gameSessionData)

Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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.

Parameters:

gameSessionData - Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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:

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateMatchmakingConfigurationRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()