PlaceUpdateStatus — openapi

Container for the status of a game update.

Properties

Name	Type	Required	Description
placeId	integer	false	The placeId of the game update
phase	string	false	Which phase is the update in: BleedOff, Migrate, or Done
startTime	string	false	When the update started
endTime	string	false	When the update is expected to end, or null if it has not ended yet
startPlayersToBeKicked	integer	false	Number of players in the game update initially, before any players are kicked
startInstancesToBeClosed	integer	false	Number of instances that will be closed during the game update
numPlayersToBeKicked	integer	false	How many players are remaining in instances that will be shut down according to the update configuration
instancesToBeClosed	integer	false	Number of places that will be updated
placeVersion	integer	false	The version of the place that is being updated
placeVersionsToBeClosed	array	false	The versions of the place that will be closed during the update

Complete Schema

{
  "type": "object",
  "properties": {
    "placeId": {
      "type": "integer",
      "description": "The placeId of the game update",
      "format": "int64"
    },
    "phase": {
      "type": "string",
      "description": "Which phase is the update in: BleedOff, Migrate, or Done",
      "nullable": true
    },
    "startTime": {
      "type": "string",
      "description": "When the update started",
      "format": "date-time"
    },
    "endTime": {
      "type": "string",
      "description": "When the update is expected to end, or null if it has not ended yet",
      "format": "date-time",
      "nullable": true
    },
    "startPlayersToBeKicked": {
      "type": "integer",
      "description": "Number of players in the game update initially, before any players are kicked",
      "format": "int32"
    },
    "startInstancesToBeClosed": {
      "type": "integer",
      "description": "Number of instances that will be closed during the game update",
      "format": "int32"
    },
    "numPlayersToBeKicked": {
      "type": "integer",
      "description": "How many players are remaining in instances that will be shut down according to the update configuration",
      "format": "int32"
    },
    "instancesToBeClosed": {
      "type": "integer",
      "description": "Number of places that will be updated",
      "format": "int32"
    },
    "placeVersion": {
      "type": "integer",
      "description": "The version of the place that is being updated",
      "format": "int32"
    },
    "placeVersionsToBeClosed": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "The versions of the place that will be closed during the update",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Container for the status of a game update."
}