delete-expired-data.asciidoc 1.0 KB

1234567891011121314151617181920212223242526272829303132333435
  1. --
  2. :api: delete-expired-data
  3. :request: DeleteExpiredRequest
  4. :response: DeleteExpiredResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete Expired Data API
  9. Delete expired {ml} data.
  10. The API accepts a +{request}+ and responds
  11. with a +{response}+ object.
  12. [id="{upid}-{api}-request"]
  13. ==== Delete Expired Data Request
  14. A `DeleteExpiredDataRequest` object does not require any arguments.
  15. ["source","java",subs="attributes,callouts,macros"]
  16. ---------------------------------------------------
  17. include-tagged::{doc-tests-file}[{api}-request]
  18. ---------------------------------------------------
  19. <1> Constructing a new request.
  20. [id="{upid}-{api}-response"]
  21. ==== Delete Expired Data Response
  22. The returned +{response}+ object indicates the acknowledgement of the request:
  23. ["source","java",subs="attributes,callouts,macros"]
  24. ---------------------------------------------------
  25. include-tagged::{doc-tests-file}[{api}-response]
  26. ---------------------------------------------------
  27. <1> `getDeleted` acknowledges the deletion request.
  28. include::../execution.asciidoc[]