delete-model-snapshot.asciidoc 1.0 KB

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