delete-datafeed.asciidoc 1.1 KB

1234567891011121314151617181920212223242526272829303132
  1. --
  2. :api: delete-datafeed
  3. :request: DeleteDatafeedRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [id="{upid}-delete-datafeed"]
  7. === Delete Datafeed API
  8. [id="{upid}-{api}-request"]
  9. ==== Delete Datafeed Request
  10. A +{request}+ object requires a non-null `datafeedId` and can optionally set `force`.
  11. ["source","java",subs="attributes,callouts,macros"]
  12. ---------------------------------------------------
  13. include-tagged::{doc-tests-file}[{api}-request]
  14. ---------------------------------------------------
  15. <1> Use to forcefully delete a started datafeed;
  16. this method is quicker than stopping and deleting the datafeed.
  17. Defaults to `false`.
  18. include::../execution.asciidoc[]
  19. [id="{upid}-{api}-response"]
  20. ==== Delete Datafeed 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