Skip to content

PhysicalDeduplicationApplyDto

Endpoints · All schemas

FieldRequiredDescription
alreadyAppliedYesinteger
appliedYesinteger
createdAtYesstring
errorYesstring
estimatedBytesYesinteger
failedYesinteger
fingerprintYesstring
finishedAtYesstring
mineYesWhether the requesting administrator applied it
operationIdYesThe media operation applying the plan
pauseRequestedYesboolean
planIdYesstring
processedYesinteger
progressYesnumber
reclaimedBytesYesBytes actually removed from disk so far
requestedByIdYesAdministrator who applied the plan; the job is theirs to pause or cancel
requestedByNameYesstring
retryingYesWaiting for its one automatic retry
skippedYesCopies left alone because their evidence changed
statusYesSee definition below
totalYesCopies in the reviewed plan

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: MediaOperationStatus

{
  "properties": {
    "alreadyApplied": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "applied": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "createdAt": {
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "type": "string"
    },
    "error": {
      "nullable": true,
      "type": "string"
    },
    "estimatedBytes": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "failed": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "fingerprint": {
      "type": "string"
    },
    "finishedAt": {
      "format": "date-time",
      "nullable": true,
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "type": "string"
    },
    "mine": {
      "description": "Whether the requesting administrator applied it",
      "type": "boolean"
    },
    "operationId": {
      "description": "The media operation applying the plan",
      "type": "string"
    },
    "pauseRequested": {
      "type": "boolean"
    },
    "planId": {
      "type": "string"
    },
    "processed": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "progress": {
      "format": "double",
      "type": "number"
    },
    "reclaimedBytes": {
      "description": "Bytes actually removed from disk so far",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "requestedById": {
      "description": "Administrator who applied the plan; the job is theirs to pause or cancel",
      "type": "string"
    },
    "requestedByName": {
      "type": "string"
    },
    "retrying": {
      "description": "Waiting for its one automatic retry",
      "type": "boolean"
    },
    "skipped": {
      "description": "Copies left alone because their evidence changed",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "status": {
      "$ref": "#/components/schemas/MediaOperationStatus"
    },
    "total": {
      "description": "Copies in the reviewed plan",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "alreadyApplied",
    "applied",
    "createdAt",
    "error",
    "estimatedBytes",
    "failed",
    "fingerprint",
    "finishedAt",
    "mine",
    "operationId",
    "pauseRequested",
    "planId",
    "processed",
    "progress",
    "reclaimedBytes",
    "requestedById",
    "requestedByName",
    "retrying",
    "skipped",
    "status",
    "total"
  ],
  "type": "object"
}