Package io.fluxcapacitor.common.api.search

Class DeleteCollection

java.lang.Object
io.fluxcapacitor.common.api.Request
io.fluxcapacitor.common.api.Command
io.fluxcapacitor.common.api.search.DeleteCollection
All Implemented Interfaces:
JsonType
public class DeleteCollection extends Command
Command to delete an entire search collection, removing all documents within it.

This operation is irreversible and should be used with caution. It is useful in test environments or in cases where all data in a collection has become obsolete and needs to be cleared.

Deletion behavior is governed by the provided Guarantee.

  • Constructor Details

    • DeleteCollection

      public DeleteCollection()

  • Method Details

    • routingKey

      public String routingKey()
      Uses the collection name as the routing key for consistency and traceability.
      Overrides:
      routingKey in class Command
      Returns:
      a routing key string, or null if not specified