Skip to content

MediaHealthOperationDto

Endpoints · All schemas

FieldRequiredDescription
autoRetriesYesinteger
cancelRequestedAtYesstring
createdAtYesstring
errorYesstring
finishedAtYesstring
idYesMedia operation ID
modeYesSee definition below
pauseRequestedAtYesstring
processedUnitsYesinteger
progressYesnumber
statusYesSee definition below
totalUnitsYesinteger
updatedAtYesstring

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: MediaHealthOperationMode, MediaOperationStatus

{
  "properties": {
    "autoRetries": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "cancelRequestedAt": {
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "error": {
      "nullable": true,
      "type": "string"
    },
    "finishedAt": {
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "id": {
      "description": "Media operation ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "mode": {
      "$ref": "#/components/schemas/MediaHealthOperationMode"
    },
    "pauseRequestedAt": {
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "processedUnits": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "progress": {
      "format": "double",
      "type": "number"
    },
    "status": {
      "$ref": "#/components/schemas/MediaOperationStatus"
    },
    "totalUnits": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "autoRetries",
    "cancelRequestedAt",
    "createdAt",
    "error",
    "finishedAt",
    "id",
    "mode",
    "pauseRequestedAt",
    "processedUnits",
    "progress",
    "status",
    "totalUnits",
    "updatedAt"
  ],
  "type": "object"
}