Documentation

CreateBackfillTicketRequest

Properties

Optional Attributes

  • attributes: {}

An object that holds 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. The default pool is used if a pool isn't provided.

memberof

CreateBackfillTicketRequest

Type declaration

  • [key: string]: object

Connection

  • connection: string

The IP address and port of the server creating the backfill (using the format ip:port). This property is used to assign the server to the matching tickets.

memberof

CreateBackfillTicketRequest

Optional Match Id

  • matchId: string

The ID of the match that this backfill ticket is targeting. The match ID is contained in the MatchmakingResults in the allocation payload. The allocation payload is retrieved by the game server from the payload proxy as described in the Game Server Hosting Documentation.

memberof

CreateBackfillTicketRequest

Optional Pool Id

  • poolId: string

The ID of the pool to create the backfill ticket in. Cannot be used if the attributes field is present. The MatchmakingResults in the allocation payload contains the pool ID of the match it was created in. The allocation payload is retrieved by the game server from the payload proxy as described in the Game Server Hosting Documentation.

memberof

CreateBackfillTicketRequest

Properties

  • properties: {}

An object that will contain the data representing a Backfill Ticket. The information about the backfill ticket properties is stored in the Data property of that object. Backfill Ticket Properties is serialized in base64 (with padding).

memberof

CreateBackfillTicketRequest

Type declaration

  • [key: string]: string

Optional Queue Name

  • queueName: string

Tickets are logically grouped together for matchmaking. The tickets must match one of the queue names in the matchmaking config. If not, they will be placed in the default queue.

memberof

CreateBackfillTicketRequest