MatchmakingRuleSet (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.MatchmakingRuleSet

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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 your player matches. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches.

A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch rule set.
- 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, teams, or entire matches. For example, a rule might require each player to meet a certain skill level, each team to have at least one player in a certain role, or the match to have a minimum average 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 when 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.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MatchmakingRuleSet()

Constructors
Constructor and Description
`MatchmakingRuleSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MatchmakingRuleSet`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` A time stamp indicating when this data object was created.
`String`	`getRuleSetArn()` The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
`String`	`getRuleSetBody()` A collection of matchmaking rules, formatted as a JSON string.
`String`	`getRuleSetName()` A unique identifier for the matchmaking rule set
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` A time stamp indicating when this data object was created.
`void`	`setRuleSetArn(String ruleSetArn)` The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
`void`	`setRuleSetBody(String ruleSetBody)` A collection of matchmaking rules, formatted as a JSON string.
`void`	`setRuleSetName(String ruleSetName)` A unique identifier for the matchmaking rule set
`String`	`toString()` Returns a string representation of this object.
`MatchmakingRuleSet`	`withCreationTime(Date creationTime)` A time stamp indicating when this data object was created.
`MatchmakingRuleSet`	`withRuleSetArn(String ruleSetArn)` The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
`MatchmakingRuleSet`	`withRuleSetBody(String ruleSetBody)` A collection of matchmaking rules, formatted as a JSON string.
`MatchmakingRuleSet`	`withRuleSetName(String ruleSetName)` A unique identifier for the matchmaking rule set

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MatchmakingRuleSet
```
public MatchmakingRuleSet()
```
- Method Detail
  - setRuleSetName
```
public void setRuleSetName(String ruleSetName)
```
    A unique identifier for the matchmaking rule set
    
    Parameters:
    
    ruleSetName - A unique identifier for the matchmaking rule set
  - getRuleSetName
```
public String getRuleSetName()
```
    A unique identifier for the matchmaking rule set
    
    Returns:
    
    A unique identifier for the matchmaking rule set
  - withRuleSetName
```
public MatchmakingRuleSet withRuleSetName(String ruleSetName)
```
    A unique identifier for the matchmaking rule set
    
    Parameters:
    
    ruleSetName - A unique identifier for the matchmaking rule set
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleSetArn
```
public void setRuleSetArn(String ruleSetArn)
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.
    
    Parameters:
    
    ruleSetArn - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.
  - getRuleSetArn
```
public String getRuleSetArn()
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.
    
    Returns:
    
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.
  - withRuleSetArn
```
public MatchmakingRuleSet withRuleSetArn(String ruleSetArn)
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.
    
    Parameters:
    
    ruleSetArn - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleSetBody
```
public void setRuleSetBody(String ruleSetBody)
```
    A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
    
    Parameters:
    
    ruleSetBody - A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
  - getRuleSetBody
```
public String getRuleSetBody()
```
    A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
    
    Returns:
    
    A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
  - withRuleSetBody
```
public MatchmakingRuleSet withRuleSetBody(String ruleSetBody)
```
    A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
    
    Parameters:
    
    ruleSetBody - A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - getCreationTime
```
public Date getCreationTime()
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - withCreationTime
```
public MatchmakingRuleSet withCreationTime(Date creationTime)
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    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 MatchmakingRuleSet clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class MatchmakingRuleSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MatchmakingRuleSet

Method Detail

setRuleSetName

getRuleSetName

withRuleSetName

setRuleSetArn

getRuleSetArn

withRuleSetArn

setRuleSetBody

getRuleSetBody

withRuleSetBody

setCreationTime

getCreationTime

withCreationTime

toString

equals

hashCode

clone

marshall