Package io.dapr.durabletask

Class OrchestrationStatusQuery

java.lang.Object
io.dapr.durabletask.OrchestrationStatusQuery
public final class OrchestrationStatusQuery extends Object
Class used for constructing orchestration metadata queries.

  • Constructor Details

    • OrchestrationStatusQuery

      public OrchestrationStatusQuery()
      Sole constructor.

  • Method Details

    • setRuntimeStatusList

      public OrchestrationStatusQuery setRuntimeStatusList(@Nullable List<OrchestrationRuntimeStatus> runtimeStatusList)
      Sets the list of runtime status values to use as a filter. Only orchestration instances that have a matching runtime status will be returned. The default null value will disable runtime status filtering.
      Parameters:
      runtimeStatusList - the list of runtime status values to use as a filter
      Returns:
      this query object

    • setCreatedTimeFrom

      public OrchestrationStatusQuery setCreatedTimeFrom(@Nullable Instant createdTimeFrom)
      Include orchestration instances that were created after the specified instant.
      Parameters:
      createdTimeFrom - the minimum orchestration creation time to use as a filter or null to disable this filter
      Returns:
      this query object

    • setCreatedTimeTo

      public OrchestrationStatusQuery setCreatedTimeTo(@Nullable Instant createdTimeTo)
      Include orchestration instances that were created before the specified instant.
      Parameters:
      createdTimeTo - the maximum orchestration creation time to use as a filter or null to disable this filter
      Returns:
      this query object

    • setMaxInstanceCount

      public OrchestrationStatusQuery setMaxInstanceCount(int maxInstanceCount)
      Sets the maximum number of records that can be returned by the query. The default value is 100.

      Requests may return fewer records than the specified page size, even if there are more records. Always check the continuation token to determine whether there are more records.

      Parameters:
      maxInstanceCount - the maximum number of orchestration metadata records to return
      Returns:
      this query object

    • setTaskHubNames

      public OrchestrationStatusQuery setTaskHubNames(@Nullable List<String> taskHubNames)
      Include orchestration metadata records that have a matching task hub name.
      Parameters:
      taskHubNames - the task hub name to match or null to disable this filter
      Returns:
      this query object

    • setContinuationToken

      public OrchestrationStatusQuery setContinuationToken(@Nullable String continuationToken)
      Sets the continuation token used to continue paging through orchestration metadata results.

      This should always be the continuation token value from the previous query's OrchestrationStatusQueryResult result.

      Parameters:
      continuationToken - the continuation token from the previous query
      Returns:
      this query object

    • setInstanceIdPrefix

      public OrchestrationStatusQuery setInstanceIdPrefix(@Nullable String instanceIdPrefix)
      Include orchestration metadata records with the specified instance ID prefix.

      For example, if there are three orchestration instances in the metadata store with IDs "Foo", "Bar", and "Baz", specifying a prefix value of "B" will exclude "Foo" since its ID doesn't start with "B".

      Parameters:
      instanceIdPrefix - the instance ID prefix filter value
      Returns:
      this query object

    • setFetchInputsAndOutputs

      public OrchestrationStatusQuery setFetchInputsAndOutputs(boolean fetchInputsAndOutputs)
      Sets whether to fetch orchestration inputs, outputs, and custom status values. The default value is false.
      Parameters:
      fetchInputsAndOutputs - true to fetch orchestration inputs, outputs, and custom status values, otherwise false
      Returns:
      this query object

    • getRuntimeStatusList

      public List<OrchestrationRuntimeStatus> getRuntimeStatusList()
      Gets the configured runtime status filter or null if none was configured.
      Returns:
      the configured runtime status filter as a list of values or null if none was configured

    • 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

    • getMaxInstanceCount

      public int getMaxInstanceCount()
      Gets the configured maximum number of records that can be returned by the query.
      Returns:
      the configured maximum number of records that can be returned by the query

    • getTaskHubNames

      public List<String> getTaskHubNames()
      Gets the configured task hub names to match or null if none were configured.
      Returns:
      the configured task hub names to match or null if none were configured

    • getContinuationToken

      @Nullable public String getContinuationToken()
      Gets the configured continuation token value or null if none was configured.
      Returns:
      the configured continuation token value or null if none was configured

    • getInstanceIdPrefix

      @Nullable public String getInstanceIdPrefix()
      Gets the configured instance ID prefix filter value or null if none was configured.
      Returns:
      the configured instance ID prefix filter value or null if none was configured.

    • isFetchInputsAndOutputs

      public boolean isFetchInputsAndOutputs()
      Gets the configured value that determines whether to fetch orchestration inputs, outputs, and custom status values.
      Returns:
      the configured value that determines whether to fetch orchestration inputs, outputs, and custom status values