com.amazonaws.services.gamelift.model

Class CreateMatchmakingConfigurationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.CreateMatchmakingConfigurationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateMatchmakingConfigurationRequest()

Method Summary

Modifier and Type	Method and Description
CreateMatchmakingConfigurationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAcceptanceRequired() A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
Integer	getAcceptanceTimeoutSeconds() The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
Integer	getAdditionalPlayerCount() The number of player slots in a match to keep open for future players.
String	getBackfillMode() The method used to backfill game sessions that are created with this matchmaking configuration.
String	getCustomEventData() Information to be added to all events related to this matchmaking configuration.
String	getDescription() A human-readable description of the matchmaking configuration.
String	getFlexMatchMode() Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
List<GameProperty>	getGameProperties() A set of custom properties for a game session, formatted as key:value pairs.
String	getGameSessionData() A set of custom game session properties, formatted as a single string value.
List<String>	getGameSessionQueueArns() The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
String	getName() A unique identifier for the matchmaking configuration.
String	getNotificationTarget() An SNS topic ARN that is set up to receive matchmaking notifications.
Integer	getRequestTimeoutSeconds() The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
String	getRuleSetName() A unique identifier for the matchmaking rule set to use with this configuration.
List<Tag>	getTags() A list of labels to assign to the new matchmaking configuration resource.
int	hashCode()
Boolean	isAcceptanceRequired() A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
void	setAcceptanceRequired(Boolean acceptanceRequired) A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
void	setAcceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds) The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
void	setAdditionalPlayerCount(Integer additionalPlayerCount) The number of player slots in a match to keep open for future players.
void	setBackfillMode(String backfillMode) The method used to backfill game sessions that are created with this matchmaking configuration.
void	setCustomEventData(String customEventData) Information to be added to all events related to this matchmaking configuration.
void	setDescription(String description) A human-readable description of the matchmaking configuration.
void	setFlexMatchMode(String flexMatchMode) Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
void	setGameProperties(Collection<GameProperty> gameProperties) A set of custom properties for a game session, formatted as key:value pairs.
void	setGameSessionData(String gameSessionData) A set of custom game session properties, formatted as a single string value.
void	setGameSessionQueueArns(Collection<String> gameSessionQueueArns) The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
void	setName(String name) A unique identifier for the matchmaking configuration.
void	setNotificationTarget(String notificationTarget) An SNS topic ARN that is set up to receive matchmaking notifications.
void	setRequestTimeoutSeconds(Integer requestTimeoutSeconds) The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
void	setRuleSetName(String ruleSetName) A unique identifier for the matchmaking rule set to use with this configuration.
void	setTags(Collection<Tag> tags) A list of labels to assign to the new matchmaking configuration resource.
String	toString() Returns a string representation of this object.
CreateMatchmakingConfigurationRequest	withAcceptanceRequired(Boolean acceptanceRequired) A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
CreateMatchmakingConfigurationRequest	withAcceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds) The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
CreateMatchmakingConfigurationRequest	withAdditionalPlayerCount(Integer additionalPlayerCount) The number of player slots in a match to keep open for future players.
CreateMatchmakingConfigurationRequest	withBackfillMode(BackfillMode backfillMode) The method used to backfill game sessions that are created with this matchmaking configuration.
CreateMatchmakingConfigurationRequest	withBackfillMode(String backfillMode) The method used to backfill game sessions that are created with this matchmaking configuration.
CreateMatchmakingConfigurationRequest	withCustomEventData(String customEventData) Information to be added to all events related to this matchmaking configuration.
CreateMatchmakingConfigurationRequest	withDescription(String description) A human-readable description of the matchmaking configuration.
CreateMatchmakingConfigurationRequest	withFlexMatchMode(FlexMatchMode flexMatchMode) Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
CreateMatchmakingConfigurationRequest	withFlexMatchMode(String flexMatchMode) Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
CreateMatchmakingConfigurationRequest	withGameProperties(Collection<GameProperty> gameProperties) A set of custom properties for a game session, formatted as key:value pairs.
CreateMatchmakingConfigurationRequest	withGameProperties(GameProperty... gameProperties) A set of custom properties for a game session, formatted as key:value pairs.
CreateMatchmakingConfigurationRequest	withGameSessionData(String gameSessionData) A set of custom game session properties, formatted as a single string value.
CreateMatchmakingConfigurationRequest	withGameSessionQueueArns(Collection<String> gameSessionQueueArns) The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
CreateMatchmakingConfigurationRequest	withGameSessionQueueArns(String... gameSessionQueueArns) The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
CreateMatchmakingConfigurationRequest	withName(String name) A unique identifier for the matchmaking configuration.
CreateMatchmakingConfigurationRequest	withNotificationTarget(String notificationTarget) An SNS topic ARN that is set up to receive matchmaking notifications.
CreateMatchmakingConfigurationRequest	withRequestTimeoutSeconds(Integer requestTimeoutSeconds) The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
CreateMatchmakingConfigurationRequest	withRuleSetName(String ruleSetName) A unique identifier for the matchmaking rule set to use with this configuration.
CreateMatchmakingConfigurationRequest	withTags(Collection<Tag> tags) A list of labels to assign to the new matchmaking configuration resource.
CreateMatchmakingConfigurationRequest	withTags(Tag... tags) A list of labels to assign to the new matchmaking configuration resource.

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

CreateMatchmakingConfigurationRequest

public CreateMatchmakingConfigurationRequest()

Method Detail

setName

public void setName(String name)

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

Parameters:

name - A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

getName

public String getName()

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

Returns:

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

withName

public CreateMatchmakingConfigurationRequest withName(String name)

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

Parameters:

name - A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

Returns:

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

setDescription

public void setDescription(String description)

A human-readable description of the matchmaking configuration.

Parameters:

description - A human-readable description of the matchmaking configuration.

getDescription

public String getDescription()

A human-readable description of the matchmaking configuration.

Returns:

A human-readable description of the matchmaking configuration.

withDescription

public CreateMatchmakingConfigurationRequest withDescription(String description)

A human-readable description of the matchmaking configuration.

Parameters:

description - A human-readable description of the matchmaking configuration.

Returns:

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

getGameSessionQueueArns

public List<String> getGameSessionQueueArns()

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

Returns:

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

setGameSessionQueueArns

public void setGameSessionQueueArns(Collection<String> gameSessionQueueArns)

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

Parameters:

gameSessionQueueArns - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

withGameSessionQueueArns

public CreateMatchmakingConfigurationRequest withGameSessionQueueArns(String... gameSessionQueueArns)

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

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 - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

Returns:

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

withGameSessionQueueArns

public CreateMatchmakingConfigurationRequest withGameSessionQueueArns(Collection<String> gameSessionQueueArns)

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

Parameters:

gameSessionQueueArns - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

Returns:

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

setRequestTimeoutSeconds

public void setRequestTimeoutSeconds(Integer requestTimeoutSeconds)

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

Parameters:

requestTimeoutSeconds - The 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.

getRequestTimeoutSeconds

public Integer getRequestTimeoutSeconds()

The 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:

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

withRequestTimeoutSeconds

public CreateMatchmakingConfigurationRequest withRequestTimeoutSeconds(Integer requestTimeoutSeconds)

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

Parameters:

requestTimeoutSeconds - The 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:

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

setAcceptanceTimeoutSeconds

public void setAcceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds)

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

Parameters:

acceptanceTimeoutSeconds - The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

getAcceptanceTimeoutSeconds

public Integer getAcceptanceTimeoutSeconds()

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

Returns:

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

withAcceptanceTimeoutSeconds

public CreateMatchmakingConfigurationRequest withAcceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds)

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

Parameters:

acceptanceTimeoutSeconds - The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

Returns:

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

setAcceptanceRequired

public void setAcceptanceRequired(Boolean acceptanceRequired)

A 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. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

Parameters:

acceptanceRequired - A 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. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

getAcceptanceRequired

public Boolean getAcceptanceRequired()

A 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. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

Returns:

A 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. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

withAcceptanceRequired

public CreateMatchmakingConfigurationRequest withAcceptanceRequired(Boolean acceptanceRequired)

A 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. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

Parameters:

acceptanceRequired - A 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. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

Returns:

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

isAcceptanceRequired

public Boolean isAcceptanceRequired()

A 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. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

Returns:

A 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. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

setRuleSetName

public void setRuleSetName(String ruleSetName)

A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Parameters:

ruleSetName - A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

getRuleSetName

public String getRuleSetName()

A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Returns:

A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

withRuleSetName

public CreateMatchmakingConfigurationRequest withRuleSetName(String ruleSetName)

A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Parameters:

ruleSetName - A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. 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)

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

Parameters:

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

getNotificationTarget

public String getNotificationTarget()

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

Returns:

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

withNotificationTarget

public CreateMatchmakingConfigurationRequest withNotificationTarget(String notificationTarget)

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

Parameters:

notificationTarget - An 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)

The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

Parameters:

additionalPlayerCount - The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

getAdditionalPlayerCount

public Integer getAdditionalPlayerCount()

The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

Returns:

The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

withAdditionalPlayerCount

public CreateMatchmakingConfigurationRequest withAdditionalPlayerCount(Integer additionalPlayerCount)

The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

Parameters:

additionalPlayerCount - The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

Returns:

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

setCustomEventData

public void setCustomEventData(String customEventData)

Information to be added to all events related to this matchmaking configuration.

Parameters:

customEventData - Information to be added to all events related to this matchmaking configuration.

getCustomEventData

public String getCustomEventData()

Information to be added to all events related to this matchmaking configuration.

Returns:

Information to be added to all events related to this matchmaking configuration.

withCustomEventData

public CreateMatchmakingConfigurationRequest withCustomEventData(String customEventData)

Information to be added to all events related to this matchmaking configuration.

Parameters:

customEventData - Information to be added to all events related to this matchmaking configuration.

Returns:

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

getGameProperties

public List<GameProperty> getGameProperties()

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

Returns:

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

setGameProperties

public void setGameProperties(Collection<GameProperty> gameProperties)

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

Parameters:

gameProperties - A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

withGameProperties

public CreateMatchmakingConfigurationRequest withGameProperties(GameProperty... gameProperties)

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

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 - A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

Returns:

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

withGameProperties

public CreateMatchmakingConfigurationRequest withGameProperties(Collection<GameProperty> gameProperties)

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

Parameters:

gameProperties - A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

Returns:

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

setGameSessionData

public void setGameSessionData(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 (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

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

getGameSessionData

public String getGameSessionData()

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

Returns:

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

withGameSessionData

public CreateMatchmakingConfigurationRequest withGameSessionData(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 (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

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

Returns:

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

setBackfillMode

public void setBackfillMode(String backfillMode)

The method used to backfill game sessions that are 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 Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

Parameters:

backfillMode - The method used to backfill game sessions that are 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 Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

See Also:

BackfillMode

getBackfillMode

public String getBackfillMode()

The method used to backfill game sessions that are 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 Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

Returns:

The method used to backfill game sessions that are 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 Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

See Also:

BackfillMode

withBackfillMode

public CreateMatchmakingConfigurationRequest withBackfillMode(String backfillMode)

The method used to backfill game sessions that are 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 Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

Parameters:

backfillMode - The method used to backfill game sessions that are 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 Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

Returns:

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

See Also:

BackfillMode

withBackfillMode

public CreateMatchmakingConfigurationRequest withBackfillMode(BackfillMode backfillMode)

The method used to backfill game sessions that are 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 Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

Parameters:

backfillMode - The method used to backfill game sessions that are 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 Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

Returns:

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

See Also:

BackfillMode

setFlexMatchMode

public void setFlexMatchMode(String flexMatchMode)

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

Parameters:

flexMatchMode - Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

See Also:

FlexMatchMode

getFlexMatchMode

public String getFlexMatchMode()

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

Returns:

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

See Also:

FlexMatchMode

withFlexMatchMode

public CreateMatchmakingConfigurationRequest withFlexMatchMode(String flexMatchMode)

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

Parameters:

flexMatchMode - Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

Returns:

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

See Also:

FlexMatchMode

withFlexMatchMode

public CreateMatchmakingConfigurationRequest withFlexMatchMode(FlexMatchMode flexMatchMode)

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

Parameters:

flexMatchMode - Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

Returns:

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

See Also:

FlexMatchMode

getTags

public List<Tag> getTags()

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

setTags

public void setTags(Collection<Tag> tags)

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Parameters:

tags - A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

withTags

public CreateMatchmakingConfigurationRequest withTags(Tag... tags)

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:

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

withTags

public CreateMatchmakingConfigurationRequest withTags(Collection<Tag> tags)

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Parameters:

tags - A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 CreateMatchmakingConfigurationRequest 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()