PurgeInstanceCriteria Class

Package:

com.microsoft.durabletask

Maven Artifact:

com.microsoft:durabletask-client:1.0.0

• java.lang.Object
• • com.microsoft.durabletask.PurgeInstanceCriteria

public final class PurgeInstanceCriteria

Class used for constructing orchestration instance purge selection criteria.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
java.time.Instant	getCreatedTimeFrom() Gets the configured minimum orchestration creation time or null if none was configured.
java.time.Instant	getCreatedTimeTo() Gets the configured maximum orchestration creation time or null if none was configured.
java.util.List<OrchestrationRuntimeStatus>	getRuntimeStatusList() Gets the configured runtime status selection criteria.
java.time.Duration	getTimeout() Gets the configured timeout duration or null if none was configured.
PurgeInstanceCriteria	setCreatedTimeFrom(Instant createdTimeFrom) Purge orchestration instances that were created after the specified instant.
PurgeInstanceCriteria	setCreatedTimeTo(Instant createdTimeTo) Purge orchestration instances that were created before the specified instant.
PurgeInstanceCriteria	setRuntimeStatusList(List<OrchestrationRuntimeStatus> runtimeStatusList) Sets the list of runtime status values to use as a selection criteria.
PurgeInstanceCriteria	setTimeout(Duration timeout) Sets a timeout duration for the purge operation.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

PurgeInstanceCriteria

public PurgeInstanceCriteria()

Creates a new, default instance of the PurgeInstanceCriteria class.

Method Details

getCreatedTimeFrom

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

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 getRuntimeStatusList()

Gets the configured runtime status selection criteria.

Returns:

the configured runtime status filter as a list of values

getTimeout

public Duration getTimeout()

Gets the configured timeout duration or null if none was configured.

Returns:

the configured timeout

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 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