Package io.dapr.durabletask

Class PurgeInstanceCriteria

java.lang.Object
io.dapr.durabletask.PurgeInstanceCriteria
public final class PurgeInstanceCriteria extends Object
Class used for constructing orchestration instance purge selection criteria.

  • Constructor Details

    • PurgeInstanceCriteria

      public PurgeInstanceCriteria()
      Creates a new, default instance of the PurgeInstanceCriteria class.

  • Method Details

    • setCreatedTimeFrom

      public PurgeInstanceCriteria setCreatedTimeFrom(Instant createdTimeFrom)
      Purge orchestration instances that were created after the specified instant.
      Parameters:
      createdTimeFrom - the minimum orchestration creation time to use as a selection criteria or null to disable this selection criteria
      Returns:
      this criteria object

    • setCreatedTimeTo

      public PurgeInstanceCriteria setCreatedTimeTo(Instant createdTimeTo)
      Purge orchestration instances that were created before the specified instant.
      Parameters:
      createdTimeTo - the maximum orchestration creation time to use as a selection criteria or null to disable this selection criteria
      Returns:
      this criteria object

    • setRuntimeStatusList

      public PurgeInstanceCriteria setRuntimeStatusList(List<OrchestrationRuntimeStatus> runtimeStatusList)
      Sets the list of runtime status values to use as a selection criteria. Only orchestration instances that have a matching runtime status will be purged. An empty list is the same as selecting for all runtime status values.
      Parameters:
      runtimeStatusList - the list of runtime status values to use as a selection criteria
      Returns:
      this criteria object

    • setTimeout

      public PurgeInstanceCriteria setTimeout(Duration timeout)
      Sets a timeout duration for the purge operation. Setting to null will reset the timeout to be the default value.
      Parameters:
      timeout - the amount of time to wait for the purge instance operation to complete
      Returns:
      this criteria object

    • getCreatedTimeFrom

      @Nullable public Instant getCreatedTimeFrom()
      Gets the configured minimum orchestration creation time or null if none was configured.
      Returns:
      the configured minimum orchestration creation time or null if none was configured

    • getCreatedTimeTo

      @Nullable public Instant getCreatedTimeTo()
      Gets the configured maximum orchestration creation time or null if none was configured.
      Returns:
      the configured maximum orchestration creation time or null if none was configured

    • getRuntimeStatusList

      public List<OrchestrationRuntimeStatus> getRuntimeStatusList()
      Gets the configured runtime status selection criteria.
      Returns:
      the configured runtime status filter as a list of values

    • getTimeout

      @Nullable public Duration getTimeout()
      Gets the configured timeout duration or null if none was configured.
      Returns:
      the configured timeout