delete-model-snapshot.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233
  1. --
  2. :api: delete-model-snapshot
  3. :request: DeleteModelSnapshotRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete model snapshots API
  9. Deletes an existing model snapshot.
  10. [id="{upid}-{api}-request"]
  11. ==== Delete model snapshots request
  12. A +{request}+ object requires both a non-null `jobId` and a non-null `snapshotId`.
  13. ["source","java",subs="attributes,callouts,macros"]
  14. ---------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. ---------------------------------------------------
  17. <1> Constructing a new request referencing existing `jobId` and `snapshotId`.
  18. include::../execution.asciidoc[]
  19. [id="{upid}-{api}-response"]
  20. ==== Delete model snapshots response
  21. The returned +{response}+ object indicates the acknowledgement of the request:
  22. ["source","java",subs="attributes,callouts,macros"]
  23. ---------------------------------------------------
  24. include-tagged::{doc-tests-file}[{api}-response]
  25. ---------------------------------------------------
  26. <1> `isAcknowledged` was the deletion request acknowledged or not