@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class MatchmakingRuleSet extends Object implements Serializable, Cloneable, StructuredPojo
Set of rule statements, used with FlexMatch, that determine how to build a certain kind of player match. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.
A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Create Matchmaking Rules for Your Game.
Teams -- Required. A rule set must define one or multiple teams for the match and set minimum and maximum team sizes. For example, a rule set might describe a 4x4 match that requires all eight slots to be filled.
Player attributes -- Optional. These attributes specify a set of player characteristics to evaluate when looking for a match. Matchmaking requests that use a rule set with player attributes must provide the corresponding attribute values. For example, an attribute might specify a player's skill or level.
Rules -- Optional. Rules define how to evaluate potential players for a match based on player attributes. A rule might specify minimum requirements for individual players--such as each player must meet a certain skill level, or may describe an entire group--such as all teams must be evenly matched or have at least one player in a certain role.
Expansions -- Optional. Expansions allow you to relax the rules after a period of time if no acceptable matches are found. This feature lets you balance getting players into games in a reasonable amount of time instead of making them wait indefinitely for the best possible match. For example, you might use an expansion to increase the maximum skill variance between players after 30 seconds.
| Constructor and Description |
|---|
MatchmakingRuleSet() |
| Modifier and Type | Method and Description |
|---|---|
MatchmakingRuleSet |
clone() |
boolean |
equals(Object obj) |
Date |
getCreationTime()
Time stamp indicating when this data object was created.
|
String |
getRuleSetBody()
Collection of matchmaking rules, formatted as a JSON string.
|
String |
getRuleSetName()
Unique identifier for a matchmaking rule set
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setCreationTime(Date creationTime)
Time stamp indicating when this data object was created.
|
void |
setRuleSetBody(String ruleSetBody)
Collection of matchmaking rules, formatted as a JSON string.
|
void |
setRuleSetName(String ruleSetName)
Unique identifier for a matchmaking rule set
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
MatchmakingRuleSet |
withCreationTime(Date creationTime)
Time stamp indicating when this data object was created.
|
MatchmakingRuleSet |
withRuleSetBody(String ruleSetBody)
Collection of matchmaking rules, formatted as a JSON string.
|
MatchmakingRuleSet |
withRuleSetName(String ruleSetName)
Unique identifier for a matchmaking rule set
|
public void setRuleSetName(String ruleSetName)
Unique identifier for a matchmaking rule set
ruleSetName - Unique identifier for a matchmaking rule setpublic String getRuleSetName()
Unique identifier for a matchmaking rule set
public MatchmakingRuleSet withRuleSetName(String ruleSetName)
Unique identifier for a matchmaking rule set
ruleSetName - Unique identifier for a matchmaking rule setpublic void setRuleSetBody(String ruleSetBody)
Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)
ruleSetBody - Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in
JSON, but most elements support a description field.)public String getRuleSetBody()
Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)
public MatchmakingRuleSet withRuleSetBody(String ruleSetBody)
Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)
ruleSetBody - Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in
JSON, but most elements support a description field.)public void setCreationTime(Date creationTime)
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
creationTime - Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057").public Date getCreationTime()
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
public MatchmakingRuleSet withCreationTime(Date creationTime)
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
creationTime - Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057").public String toString()
toString in class ObjectObject.toString()public MatchmakingRuleSet clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.