delete-datafeed.asciidoc 1.1 KB

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