delete-model-snapshot.asciidoc 1.0 KB

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