# Index (dapr-sdk-workflows 0.10.0 API)

A B C D F G I P R S T V W
All Classes All Packages

## A

ActivityWrapper<T extends WorkflowActivity> - Class in io.dapr.workflows.runtime
  Wrapper for Durable Task Framework task activity factory.
ActivityWrapper(Class<T>) - Constructor for class io.dapr.workflows.runtime.ActivityWrapper
  Constructor for ActivityWrapper.
allOf(List<Task<V>>) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Returns a new `Task` that is completed when all the given `Task`s complete.
allOf(List<Task<V>>) - Method in interface io.dapr.workflows.WorkflowContext
  Returns a new `Task` that is completed when all the given `Task`s complete.
anyOf(Task<?>...) - Method in interface io.dapr.workflows.WorkflowContext
  Returns a new `Task` that is completed when any of the given `Task`s complete.
anyOf(List<Task<?>>) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Returns a new `Task` that is completed when any of the tasks in `tasks` completes.
anyOf(List<Task<?>>) - Method in interface io.dapr.workflows.WorkflowContext
  Returns a new `Task` that is completed when any of the tasks in `tasks` completes.

## B

build() - Method in class io.dapr.workflows.runtime.WorkflowRuntimeBuilder
  Returns a WorkflowRuntime object.

## C

callActivity(String) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes an activity by name and returns a new `Task` that completes when the activity completes.
callActivity(String, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes an activity by name and returns a new `Task` that completes when the activity completes.
callActivity(String, Object) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes an activity by name and with the specified input value and returns a new `Task` that completes when the activity completes.
callActivity(String, Object, TaskOptions) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes an activity by name and with the specified input value and returns a new `Task` that completes when the activity completes.
callActivity(String, Object, TaskOptions, Class<V>) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Asynchronously invokes an activity by name and with the specified input value and returns a new `Task` that completes when the activity completes.
callActivity(String, Object, TaskOptions, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes an activity by name and with the specified input value and returns a new `Task` that completes when the activity completes.
callActivity(String, Object, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes an activity by name and with the specified input value and returns a new `Task` that completes when the activity completes.If the activity completes successfully, the returned `Task`'s value will be the activity's output.
callSubWorkflow(String) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes another workflow as a sub-workflow and returns a `Task` that completes when the sub-workflow completes.
callSubWorkflow(String, Object) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes another workflow as a sub-workflow and returns a `Task` that completes when the sub-workflow completes.
callSubWorkflow(String, Object, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes another workflow as a sub-workflow and returns a `Task` that completes when the sub-workflow completes.
callSubWorkflow(String, Object, String, TaskOptions) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes another workflow as a sub-workflow and returns a `Task` that completes when the sub-workflow completes.
callSubWorkflow(String, Object, String, TaskOptions, Class<V>) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Asynchronously invokes another workflow as a sub-workflow and returns a `Task` that completes when the sub-workflow completes.
callSubWorkflow(String, Object, String, TaskOptions, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes another workflow as a sub-workflow and returns a `Task` that completes when the sub-workflow completes.
callSubWorkflow(String, Object, String, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext
  Asynchronously invokes another workflow as a sub-workflow and returns a `Task` that completes when the sub-workflow completes.
CANCELED - io.dapr.workflows.runtime.WorkflowRuntimeStatus
  The workflow was abruptly cancelled via a management API call.
close() - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Closes the inner DurableTask client and shutdown the GRPC channel.
close() - Method in class io.dapr.workflows.runtime.WorkflowRuntime
complete(Object) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Completes the current workflow.
complete(Object) - Method in interface io.dapr.workflows.WorkflowContext
  Completes the current workflow.
COMPLETED - io.dapr.workflows.runtime.WorkflowRuntimeStatus
  The workflow completed normally.
continueAsNew(Object) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Restarts the orchestration with a new input and clears its history.
continueAsNew(Object) - Method in interface io.dapr.workflows.WorkflowContext
  Restarts the orchestration with a new input and clears its history.
continueAsNew(Object, boolean) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Restarts the orchestration with a new input and clears its history.
continueAsNew(Object, boolean) - Method in interface io.dapr.workflows.WorkflowContext
  Restarts the orchestration with a new input and clears its history.
CONTINUED_AS_NEW - io.dapr.workflows.runtime.WorkflowRuntimeStatus
  The workflow is continued as new.
create() - Method in class io.dapr.workflows.runtime.ActivityWrapper
create() - Method in class io.dapr.workflows.Workflow
  Executes the workflow logic.
createTaskHub(boolean) - Method in class io.dapr.workflows.client.DaprWorkflowClient
createTimer(Duration) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Creates a durable timer that expires after the specified delay.
createTimer(Duration) - Method in interface io.dapr.workflows.WorkflowContext
  Creates a durable timer that expires after the specified delay.
createTimer(ZonedDateTime) - Method in interface io.dapr.workflows.WorkflowContext
  Creates a durable timer that expires after the specified timestamp with specific zone.

## D

DaprWorkflowClient - Class in io.dapr.workflows.client
  Defines client operations for managing Dapr Workflow instances.
DaprWorkflowClient() - Constructor for class io.dapr.workflows.client.DaprWorkflowClient
  Public constructor for DaprWorkflowClient.
DaprWorkflowContextImpl - Class in io.dapr.workflows
DaprWorkflowContextImpl(TaskOrchestrationContext) - Constructor for class io.dapr.workflows.DaprWorkflowContextImpl
  Constructor for DaprWorkflowContextImpl.
DaprWorkflowContextImpl(TaskOrchestrationContext, Logger) - Constructor for class io.dapr.workflows.DaprWorkflowContextImpl
  Constructor for DaprWorkflowContextImpl.
deleteTaskHub() - Method in class io.dapr.workflows.client.DaprWorkflowClient

## F

FAILED - io.dapr.workflows.runtime.WorkflowRuntimeStatus
  The workflow completed with an unhandled exception.
fromOrchestrationRuntimeStatus(OrchestrationRuntimeStatus) - Static method in enum io.dapr.workflows.runtime.WorkflowRuntimeStatus
  Convert runtime OrchestrationRuntimeStatus to WorkflowRuntimeStatus.

## G

getCreatedAt() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets the workflow instance's creation time in UTC.
getCurrentInstant() - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Gets the current orchestration time in UTC.
getCurrentInstant() - Method in interface io.dapr.workflows.WorkflowContext
  Gets the current orchestration time in UTC.
getErrorMessage() - Method in class io.dapr.workflows.client.WorkflowFailureDetails
  Gets the error message.
getErrorType() - Method in class io.dapr.workflows.client.WorkflowFailureDetails
  Gets the error type, which is the namespace-qualified exception type name.
getFailureDetails() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets the failure details, if any, for the failed workflow instance.
getInput(Class<T>) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Gets the deserialized input of the current task orchestration.
getInput(Class<T>) - Method in class io.dapr.workflows.runtime.WorkflowActivityContext
  Gets the input of the current activity.
getInput(Class<V>) - Method in interface io.dapr.workflows.WorkflowContext
  Gets the deserialized input of the current task orchestration.
getInstanceId() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets the unique ID of the workflow instance.
getInstanceId() - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Gets the instance ID of the current workflow.
getInstanceId() - Method in interface io.dapr.workflows.WorkflowContext
  Gets the instance ID of the current workflow.
getInstanceState(String, boolean) - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Fetches workflow instance metadata from the configured durable store.
getLastUpdatedAt() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets the workflow instance's last updated time in UTC.
getLogger() - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Get a logger only when `isReplaying` is false.
getLogger() - Method in interface io.dapr.workflows.WorkflowContext
  Get a logger only when `isReplaying` is false.
getName() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets the name of the workflow.
getName() - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Gets the name of the current workflow.
getName() - Method in class io.dapr.workflows.runtime.ActivityWrapper
getName() - Method in class io.dapr.workflows.runtime.WorkflowActivityContext
  Gets the name of the current activity.
getName() - Method in interface io.dapr.workflows.WorkflowContext
  Gets the name of the current workflow.
getRuntimeStatus() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets the current runtime status of the workflow instance at the time this object was fetched.
getSerializedInput() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets the workflow instance's serialized input, if any, as a string value.
getSerializedOutput() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets the workflow instance's serialized output, if any, as a string value.
getStackTrace() - Method in class io.dapr.workflows.client.WorkflowFailureDetails
  Gets the stack trace.

## I

io.dapr.workflows - package io.dapr.workflows
io.dapr.workflows.client - package io.dapr.workflows.client
io.dapr.workflows.runtime - package io.dapr.workflows.runtime
isCompleted() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets a value indicating whether the workflow instance was completed at the time this object was fetched.
isReplaying() - Method in class io.dapr.workflows.DaprWorkflowContextImpl
isReplaying() - Method in interface io.dapr.workflows.WorkflowContext
  Gets a value indicating whether the workflow is currently replaying a previous execution.
isRunning() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Gets a value indicating whether the workflow instance was running at the time this object was fetched.

## P

PENDING - io.dapr.workflows.runtime.WorkflowRuntimeStatus
  The workflow was scheduled but hasn't started running.
purgeInstance(String) - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Purges workflow instance state from the workflow state store.

## R

raiseEvent(String, String, Object) - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Sends an event notification message to awaiting workflow instance.
readInputAs(Class<T>) - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Deserializes the workflow's input into an object of the specified type.
readOutputAs(Class<T>) - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Deserializes the workflow's output into an object of the specified type.
registerActivity(Class<T>) - Method in class io.dapr.workflows.runtime.WorkflowRuntimeBuilder
  Registers an Activity object.
registerWorkflow(Class<T>) - Method in class io.dapr.workflows.runtime.WorkflowRuntimeBuilder
  Registers a Workflow object.
run(WorkflowActivityContext) - Method in interface io.dapr.workflows.runtime.WorkflowActivity
  Executes the activity logic and returns a value which will be serialized and returned to the calling orchestrator.
run(WorkflowContext) - Method in class io.dapr.workflows.Workflow
  Executes the workflow logic.
run(WorkflowContext) - Method in interface io.dapr.workflows.WorkflowStub
RUNNING - io.dapr.workflows.runtime.WorkflowRuntimeStatus
  The workflow started running.

## S

scheduleNewWorkflow(Class<T>) - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Schedules a new workflow using DurableTask client.
scheduleNewWorkflow(Class<T>, Object) - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Schedules a new workflow using DurableTask client.
scheduleNewWorkflow(Class<T>, Object, String) - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Schedules a new workflow using DurableTask client.
start() - Method in class io.dapr.workflows.runtime.WorkflowRuntime
  Start the Workflow runtime processing items and block.
start(boolean) - Method in class io.dapr.workflows.runtime.WorkflowRuntime
  Start the Workflow runtime processing items.
SUSPENDED - io.dapr.workflows.runtime.WorkflowRuntimeStatus
  The workflow was suspended.

## T

TERMINATED - io.dapr.workflows.runtime.WorkflowRuntimeStatus
  The workflow was abruptly terminated via a management API call.
terminateWorkflow(String, Object) - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Terminates the workflow associated with the provided instance id.
toOrchestrationRuntimeStatus(WorkflowRuntimeStatus) - Static method in enum io.dapr.workflows.runtime.WorkflowRuntimeStatus
  Convert runtime WorkflowRuntimeStatus to OrchestrationRuntimeStatus.
toOrchestrationRuntimeStatus(List<WorkflowRuntimeStatus>) - Static method in enum io.dapr.workflows.runtime.WorkflowRuntimeStatus
  Convert runtime WorkflowRuntimeStatus to OrchestrationRuntimeStatus.
toString() - Method in class io.dapr.workflows.client.WorkflowFailureDetails
toString() - Method in class io.dapr.workflows.client.WorkflowInstanceStatus
  Generates a user-friendly string representation of the current metadata object.

## V

valueOf(String) - Static method in enum io.dapr.workflows.runtime.WorkflowRuntimeStatus
  Returns the enum constant of this type with the specified name.
values() - Static method in enum io.dapr.workflows.runtime.WorkflowRuntimeStatus
  Returns an array containing the constants of this enum type, in the order they are declared.

## W

waitForExternalEvent(String) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Waits for an event to be raised named `name` and returns a `Task` that completes when the event is received.
waitForExternalEvent(String) - Method in interface io.dapr.workflows.WorkflowContext
  Waits for an event to be raised named `name` and returns a `Task` that completes when the event is received.
waitForExternalEvent(String, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext
  Waits for an event to be raised named `name` and returns a `Task` that completes when the event is received.
waitForExternalEvent(String, Duration) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Waits for an event to be raised named `name` and returns a `Task` that completes when the event is received or is canceled when `timeout` expires.
waitForExternalEvent(String, Duration) - Method in interface io.dapr.workflows.WorkflowContext
  Waits for an event to be raised named `name` and returns a `Task` that completes when the event is received or is canceled when `timeout` expires.
waitForExternalEvent(String, Duration, Class<V>) - Method in class io.dapr.workflows.DaprWorkflowContextImpl
  Waits for an event to be raised named `name` and returns a `Task` that completes when the event is received or is canceled when `timeout` expires.
waitForExternalEvent(String, Duration, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext
  Waits for an event to be raised named `name` and returns a `Task` that completes when the event is received or is canceled when `timeout` expires.
waitForInstanceCompletion(String, Duration, boolean) - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Waits for an workflow to complete and returns an `WorkflowInstanceStatus` object that contains metadata about the completed instance.
waitForInstanceStart(String, Duration, boolean) - Method in class io.dapr.workflows.client.DaprWorkflowClient
  Waits for an workflow to start running and returns an `WorkflowInstanceStatus` object that contains metadata about the started instance and optionally its input, output, and custom status payloads.
Workflow - Class in io.dapr.workflows
  Common interface for workflow implementations.
Workflow() - Constructor for class io.dapr.workflows.Workflow
WorkflowActivity - Interface in io.dapr.workflows.runtime
  Common interface for task activity implementations.
WorkflowActivityContext - Class in io.dapr.workflows.runtime
  Wrapper for Durable Task Framework `TaskActivityContext`.
WorkflowActivityContext(TaskActivityContext) - Constructor for class io.dapr.workflows.runtime.WorkflowActivityContext
  Constructor for WorkflowActivityContext.
WorkflowContext - Interface in io.dapr.workflows
  Context object used by workflow implementations to perform actions such as scheduling activities, durable timers, waiting for external events, and for getting basic information about the current workflow instance.
WorkflowFailureDetails - Class in io.dapr.workflows.client
  Represents a workflow failure details.
WorkflowFailureDetails(FailureDetails) - Constructor for class io.dapr.workflows.client.WorkflowFailureDetails
  Class constructor.
WorkflowInstanceStatus - Class in io.dapr.workflows.client
  Represents a snapshot of a workflow instance's current state, including metadata.
WorkflowInstanceStatus(OrchestrationMetadata) - Constructor for class io.dapr.workflows.client.WorkflowInstanceStatus
  Class constructor.
WorkflowRuntime - Class in io.dapr.workflows.runtime
  Contains methods to register workflows and activities.
WorkflowRuntime(DurableTaskGrpcWorker) - Constructor for class io.dapr.workflows.runtime.WorkflowRuntime
WorkflowRuntimeBuilder - Class in io.dapr.workflows.runtime
WorkflowRuntimeBuilder() - Constructor for class io.dapr.workflows.runtime.WorkflowRuntimeBuilder
WorkflowRuntimeStatus - Enum in io.dapr.workflows.runtime
  Enum describing the runtime status of a workflow.
WorkflowStub - Interface in io.dapr.workflows

A B C D F G I P R S T V W
All Classes All Packages