Skip to content

PhysicalDeduplicationPreviewResponseDto

Endpoints · All schemas

FieldRequiredDescription
appliesYesRecently applied plans, newest first ()
applyingYesWhether a reviewed plan is being applied ()
enabledYesThe saved `physicalDeduplication.enabled`
planYesThe latest plan, or null when none has run
runningYesWhether a deduplication preview is queued or active
savedMasterUserIdYesThe saved `physicalDeduplication.masterUserId`

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: PhysicalDeduplicationApplyDto, PhysicalDeduplicationPlanDto

{
  "properties": {
    "applies": {
      "description": "Recently applied plans, newest first ()",
      "items": {
        "$ref": "#/components/schemas/PhysicalDeduplicationApplyDto"
      },
      "type": "array"
    },
    "applying": {
      "description": "Whether a reviewed plan is being applied ()",
      "type": "boolean"
    },
    "enabled": {
      "description": "The saved `physicalDeduplication.enabled`",
      "type": "boolean"
    },
    "plan": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PhysicalDeduplicationPlanDto"
        }
      ],
      "description": "The latest plan, or null when none has run",
      "nullable": true
    },
    "running": {
      "description": "Whether a deduplication preview is queued or active",
      "type": "boolean"
    },
    "savedMasterUserId": {
      "description": "The saved `physicalDeduplication.masterUserId`",
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "applies",
    "applying",
    "enabled",
    "plan",
    "running",
    "savedMasterUserId"
  ],
  "type": "object"
}