com.microsoft.durabletask.PurgeInstanceCriteria Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of durabletask-client Show documentation
This package contains classes and interfaces for building Durable Task orchestrations in Java.
There is a newer version: 1.5.0
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.microsoft.durabletask;

import javax.annotation.Nullable;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.List;

/**
 * Class used for constructing orchestration instance purge selection criteria.
 */
public final class PurgeInstanceCriteria {

    private Instant createdTimeFrom;
    private Instant createdTimeTo;
    private List runtimeStatusList = new ArrayList<>();
    private Duration timeout;

    /**
     * Creates a new, default instance of the {@code PurgeInstanceCriteria} class.
     */
    public PurgeInstanceCriteria() {
    }

    /**
     * Purge orchestration instances that were created after the specified instant.
     *
     * @param createdTimeFrom the minimum orchestration creation time to use as a selection criteria or {@code null} to
     *                        disable this selection criteria
     * @return this criteria object
     */
    public PurgeInstanceCriteria setCreatedTimeFrom(Instant createdTimeFrom) {
        this.createdTimeFrom = createdTimeFrom;
        return this;
    }

    /**
     * Purge orchestration instances that were created before the specified instant.
     *
     * @param createdTimeTo the maximum orchestration creation time to use as a selection criteria or {@code null} to
     *                      disable this selection criteria
     * @return this criteria object
     */
    public PurgeInstanceCriteria setCreatedTimeTo(Instant createdTimeTo) {
        this.createdTimeTo = createdTimeTo;
        return this;
    }

    /**
     * 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.
     *
     * @param runtimeStatusList the list of runtime status values to use as a selection criteria
     * @return this criteria object
     */
    public PurgeInstanceCriteria setRuntimeStatusList(List runtimeStatusList) {
        this.runtimeStatusList = runtimeStatusList;
        return this;
    }

    /**
     * Sets a timeout duration for the purge operation. Setting to {@code null} will reset the timeout to be the default value.
     *
     * @param timeout the amount of time to wait for the purge instance operation to complete
     * @return this criteria object
     */
    public PurgeInstanceCriteria setTimeout(Duration timeout) {
        this.timeout = timeout;
        return this;
    }

    /**
     * Gets the configured minimum orchestration creation time or {@code null} if none was configured.
     * @return the configured minimum orchestration creation time or {@code null} if none was configured
     */
    @Nullable
    public Instant getCreatedTimeFrom() {
        return this.createdTimeFrom;
    }

    /**
     * Gets the configured maximum orchestration creation time or {@code null} if none was configured.
     * @return the configured maximum orchestration creation time or {@code null} if none was configured
     */
    @Nullable
    public Instant getCreatedTimeTo() {
        return this.createdTimeTo;
    }

    /**
     * Gets the configured runtime status selection criteria.
     * @return the configured runtime status filter as a list of values
     */
    public List getRuntimeStatusList() {
        return this.runtimeStatusList;
    }

    /**
     * Gets the configured timeout duration or {@code null} if none was configured.
     * @return the configured timeout
     */
    @Nullable
    public Duration getTimeout() {
        return this.timeout;
    }

}