Package com.microsoft.durabletask

Class PurgeInstanceCriteria

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

    • Constructor Detail

      • PurgeInstanceCriteria

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

    • Method Detail

      • setCreatedTimeFrom

        public PurgeInstanceCriteria setCreatedTimeFrom​(java.time.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​(java.time.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​(java.util.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​(java.time.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 java.time.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 java.time.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 java.util.List<OrchestrationRuntimeStatus> getRuntimeStatusList()
        Gets the configured runtime status selection criteria.
        Returns:
        the configured runtime status filter as a list of values

      • getTimeout

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