Class CreateBackfillTicketOptions
Parameter class for making matchmaker backfill ticket requests.
Inheritance
Inherited Members
Namespace: Unity.Services.Matchmaker
Syntax
public class CreateBackfillTicketOptionsConstructors
CreateBackfillTicketOptions()
Default constructor.
Declaration
public CreateBackfillTicketOptions()CreateBackfillTicketOptions(String, String, Dictionary<String, Object>, BackfillTicketProperties, String, String)
Parameterized constructor.
Declaration
public CreateBackfillTicketOptions(string queueName, string connection, Dictionary<string, object> attributes = null, BackfillTicketProperties properties = null, string poolId = null, string matchId = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | queueName | Name of the queue to target the backfill request. See QueueName. |
| System.String | connection | The IP address and port of the server creating the backfill (using the format ip:port). See Connection. |
| System.Collections.Generic.Dictionary<System.String, System.Object> | attributes | A dictionary of attributes (number or string), indexed by the attribute name. See Attributes. |
| BackfillTicketProperties | properties | Properties object containing match information. See Properties. |
| System.String | poolId | The ID of the pool to create the backfill ticket in. See PoolId. |
| System.String | matchId | The ID of the match that this backfill ticket is targeting. See MatchId. |
Properties
Attributes
A dictionary of attributes (number or string), indexed by the attribute name. The attributes are compared against the corresponding filters defined in the matchmaking config and used to segment the ticket population into pools. Example attributes include map, mode, platform, and build number. (Optional)
Declaration
public Dictionary<string, object> Attributes { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.String, System.Object> |
Connection
The IP address and port of the server creating the backfill (using the format ip:port). This property is used to assign the server the matching tickets
Declaration
public string Connection { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
MatchId
The ID of the match that this backfill ticket is targeting. The match ID is contained in the allocation payload.
Declaration
public string MatchId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PoolId
The ID of the pool to create the backfill ticket in. Cannot be used if the attributes field is present. The allocation payload contains the pool ID of the match it was created in.
Declaration
public string PoolId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Properties
Properties object containing match information.
Declaration
public BackfillTicketProperties Properties { get; set; }Property Value
| Type | Description |
|---|---|
| BackfillTicketProperties |
QueueName
Name of the queue to target the backfill request.
Declaration
public string QueueName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |