Documentation
¶
Overview ¶
Package delete_dq_job_run implements the dq_delete_job_run MCP tool — permanently delete a COMPLETED Collibra data-quality job run and all of its per-run results.
It accepts EITHER a jobRunId or a jobName and converges on the public delete call:
By jobRunId : GET /rest/dq/1.0/jobRuns/{jobRunId} -> if the run is still in progress, refuse;
otherwise show the run (confirm_required) or, with confirm=true, delete it.
By jobName : GET /rest/dq/1.0/jobRuns?nameMatchMode=CONTAINS&status=<terminal...> to find the
job's deletable runs -> none: error; exactly one: show it (confirm_required);
several: return them (needs_input) so the caller re-calls with the chosen jobRunId.
Delete : DELETE /rest/dq/1.0/jobRuns/{jobRunId}.
Deletion is irreversible, so — unlike dq_cancel_job_run — there IS a confirm checkpoint, and the delete NEVER fires on a jobName: resolving by name always ends in confirm_required/needs_input, so a run can only be deleted once its details have been shown and the caller re-calls with its jobRunId and confirm=true. Permissions are enforced by the server — a 403 is surfaced as a meaningful error, along with 400/401/404/409/500.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Input ¶
type Input struct {
JobRunID string `json:"jobRunId,omitempty" jsonschema:"The id of the completed run to delete. Provide this OR jobName."`
JobName string `` /* 230-byte string literal not displayed */
Confirm bool `` /* 227-byte string literal not displayed */
}
Input — supply EITHER jobRunId OR jobName (exactly one).
type Output ¶
type Output struct {
Status Status `json:"status" jsonschema:"deleted | confirm_required | needs_input | error."`
Message string `json:"message" jsonschema:"Human-readable outcome and what to do next."`
JobRunID string `json:"jobRunId,omitempty" jsonschema:"The run id that was deleted (or, on confirm_required, the one to confirm)."`
JobName string `json:"jobName,omitempty" jsonschema:"The job the run belongs to, when known."`
RunState string `json:"runState,omitempty" jsonschema:"On an in-progress error: the run's current, non-deletable state."`
Run *RunSummary `` /* 135-byte string literal not displayed */
CandidateRuns []RunSummary `` /* 146-byte string literal not displayed */
JobDetailsLink string `` /* 135-byte string literal not displayed */
Guidance string `json:"guidance,omitempty" jsonschema:"On confirm_required/needs_input/error, what to do next."`
}
type RunSummary ¶
type RunSummary struct {
JobRunID string `json:"jobRunId" jsonschema:"Re-call the tool with this jobRunId and confirm=true to delete this run."`
JobName string `json:"jobName,omitempty" jsonschema:"The job this run belongs to."`
Status string `json:"status,omitempty" jsonschema:"The run's terminal state (finished/cancelled/failed)."`
RunDate string `json:"runDate,omitempty" jsonschema:"The run's date (UTC), if known."`
StartTime string `json:"startTime,omitempty" jsonschema:"When the run started (UTC), if known."`
EndTime string `json:"endTime,omitempty" jsonschema:"When the run finished (UTC), if known."`
}
RunSummary describes one run — either the run about to be deleted, or one of several candidates offered when jobName matched more than one.
Source Files