Index

A B C D F G I N P R S T V W
All Classes and Interfaces|All Packages|Serialized Form

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 Tasks complete.

allOf(List<Task<V>>) - Method in interface io.dapr.workflows.WorkflowContext

Returns a new Task that is completed when all the given Tasks complete.

anyOf(Task<?>...) - Method in interface io.dapr.workflows.WorkflowContext

Returns a new Task that is completed when any of the given Tasks 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.

ApiTokenClientInterceptor - Class in io.dapr.workflows.internal

ApiTokenClientInterceptor() - Constructor for class io.dapr.workflows.internal.ApiTokenClientInterceptor

B

build() - Method in class io.dapr.workflows.runtime.WorkflowRuntimeBuilder

Returns a WorkflowRuntime object.

build() - Method in class io.dapr.workflows.saga.SagaOption.Builder

Build Saga optiion.

Builder() - Constructor for class io.dapr.workflows.saga.SagaOption.Builder

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.

callChildWorkflow(String) - Method in interface io.dapr.workflows.WorkflowContext

Asynchronously invokes another workflow as a child-workflow and returns a Task that completes when the child-workflow completes.

callChildWorkflow(String, Object) - Method in interface io.dapr.workflows.WorkflowContext

Asynchronously invokes another workflow as a child-workflow and returns a Task that completes when the child-workflow completes.

callChildWorkflow(String, Object, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext

Asynchronously invokes another workflow as a child-workflow and returns a Task that completes when the child-workflow completes.

callChildWorkflow(String, Object, String, TaskOptions) - Method in interface io.dapr.workflows.WorkflowContext

Asynchronously invokes another workflow as a child-workflow and returns a Task that completes when the child-workflow completes.

callChildWorkflow(String, Object, String, TaskOptions, Class<V>) - Method in class io.dapr.workflows.DaprWorkflowContextImpl

Asynchronously invokes another workflow as a child-workflow and returns a Task that completes when the child-workflow completes.

callChildWorkflow(String, Object, String, TaskOptions, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext

Asynchronously invokes another workflow as a child-workflow and returns a Task that completes when the child-workflow completes.

callChildWorkflow(String, Object, String, Class<V>) - Method in interface io.dapr.workflows.WorkflowContext

Asynchronously invokes another workflow as a child-workflow and returns a Task that completes when the child-workflow completes.

CANCELED - Enum constant in enum class 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

compensate() - Method in class io.dapr.workflows.saga.DaprSagaContextImpl

compensate() - Method in interface io.dapr.workflows.saga.SagaContext

Compensate all registered activities.

compensate(WorkflowContext) - Method in class io.dapr.workflows.saga.Saga

Compensate all registered activities.

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 - Enum constant in enum class 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 - Enum constant in enum class 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

DaprSagaContextImpl - Class in io.dapr.workflows.saga

Dapr Saga Context implementation.

DaprSagaContextImpl(Saga, WorkflowContext) - Constructor for class io.dapr.workflows.saga.DaprSagaContextImpl

Constructor to build up instance.

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, Saga) - Constructor for class io.dapr.workflows.DaprWorkflowContextImpl

DaprWorkflowContextImpl(TaskOrchestrationContext, Logger) - Constructor for class io.dapr.workflows.DaprWorkflowContextImpl

Constructor for DaprWorkflowContextImpl.

DaprWorkflowContextImpl(TaskOrchestrationContext, Logger, Saga) - Constructor for class io.dapr.workflows.DaprWorkflowContextImpl

Constructor for DaprWorkflowContextImpl.

deleteTaskHub() - Method in class io.dapr.workflows.client.DaprWorkflowClient

F

FAILED - Enum constant in enum class io.dapr.workflows.runtime.WorkflowRuntimeStatus

The workflow completed with an unhandled exception.

fromOrchestrationRuntimeStatus(OrchestrationRuntimeStatus) - Static method in enum class 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() - Method in class io.dapr.workflows.client.NewWorkflowOption

Gets the input of the new workflow.

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

Gets the instance ID of the new workflow.

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.

getMaxParallelThread() - Method in class io.dapr.workflows.saga.SagaOption

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.

getNewOrchestrationInstanceOptions() - Method in class io.dapr.workflows.client.NewWorkflowOption

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.

getSagaContext() - Method in class io.dapr.workflows.DaprWorkflowContextImpl

getSagaContext() - Method in interface io.dapr.workflows.WorkflowContext

get saga context.

getSagaOption() - Method in class io.dapr.workflows.Workflow

get saga configuration.

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.

getStartTime() - Method in class io.dapr.workflows.client.NewWorkflowOption

Gets the configured start time of the new workflow instance.

getVersion() - Method in class io.dapr.workflows.client.NewWorkflowOption

Gets the user-specified version of the new workflow.

I

interceptCall(MethodDescriptor<ReqT, RespT>, CallOptions, Channel) - Method in class io.dapr.workflows.internal.ApiTokenClientInterceptor

io.dapr.workflows - package io.dapr.workflows

io.dapr.workflows.client - package io.dapr.workflows.client

io.dapr.workflows.internal - package io.dapr.workflows.internal

io.dapr.workflows.runtime - package io.dapr.workflows.runtime

io.dapr.workflows.saga - package io.dapr.workflows.saga

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.

isContinueWithError() - Method in class io.dapr.workflows.saga.SagaOption

isParallelCompensation() - Method in class io.dapr.workflows.saga.SagaOption

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.

isSagaEnabled() - Method in class io.dapr.workflows.Workflow

N

newBuilder() - Static method in class io.dapr.workflows.saga.SagaOption

newUuid() - Method in class io.dapr.workflows.DaprWorkflowContextImpl

Create a new UUID that is safe for replay within a workflow.

newUuid() - Method in interface io.dapr.workflows.WorkflowContext

Create a new UUID that is safe for replay within a workflow.

NewWorkflowOption - Class in io.dapr.workflows.client

Options for starting a new instance of a workflow.

NewWorkflowOption() - Constructor for class io.dapr.workflows.client.NewWorkflowOption

P

PENDING - Enum constant in enum class 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.

registerCompensation(String, Object) - Method in class io.dapr.workflows.saga.DaprSagaContextImpl

registerCompensation(String, Object) - Method in class io.dapr.workflows.saga.Saga

Register a compensation activity.

registerCompensation(String, Object) - Method in interface io.dapr.workflows.saga.SagaContext

Register a compensation activity.

registerCompensation(String, Object, TaskOptions) - Method in class io.dapr.workflows.saga.Saga

Register a compensation activity.

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 - Enum constant in enum class io.dapr.workflows.runtime.WorkflowRuntimeStatus

The workflow started running.

S

Saga - Class in io.dapr.workflows.saga

Saga(SagaOption) - Constructor for class io.dapr.workflows.saga.Saga

Build up a Saga with its options.

SagaCompensationException - Exception in io.dapr.workflows.saga

saga compensation exception.

SagaCompensationException(String, Exception) - Constructor for exception io.dapr.workflows.saga.SagaCompensationException

build up a SagaCompensationException.

SagaContext - Interface in io.dapr.workflows.saga

Saga context.

SagaOption - Class in io.dapr.workflows.saga

Saga option.

SagaOption.Builder - Class in io.dapr.workflows.saga

scheduleNewWorkflow(Class<T>) - Method in class io.dapr.workflows.client.DaprWorkflowClient

Schedules a new workflow using DurableTask client.

scheduleNewWorkflow(Class<T>, NewWorkflowOption) - Method in class io.dapr.workflows.client.DaprWorkflowClient

Schedules a new workflow with a specified set of options for execution.

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.

setContinueWithError(boolean) - Method in class io.dapr.workflows.saga.SagaOption.Builder

Set continue with error.

setInput(Object) - Method in class io.dapr.workflows.client.NewWorkflowOption

Sets the input of the workflow to start.

setInstanceId(String) - Method in class io.dapr.workflows.client.NewWorkflowOption

Sets the instance ID of the workflow to start.

setMaxParallelThread(int) - Method in class io.dapr.workflows.saga.SagaOption.Builder

set max parallel thread.

setParallelCompensation(boolean) - Method in class io.dapr.workflows.saga.SagaOption.Builder

Set parallel compensation.

setStartTime(Instant) - Method in class io.dapr.workflows.client.NewWorkflowOption

Sets the start time of the new workflow.

setVersion(String) - Method in class io.dapr.workflows.client.NewWorkflowOption

Sets the version of the workflow to start.

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 - Enum constant in enum class io.dapr.workflows.runtime.WorkflowRuntimeStatus

The workflow was suspended.

T

TERMINATED - Enum constant in enum class 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 class io.dapr.workflows.runtime.WorkflowRuntimeStatus

Convert runtime WorkflowRuntimeStatus to OrchestrationRuntimeStatus.

toOrchestrationRuntimeStatus(List<WorkflowRuntimeStatus>) - Static method in enum class 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 class io.dapr.workflows.runtime.WorkflowRuntimeStatus

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.dapr.workflows.runtime.WorkflowRuntimeStatus

Returns an array containing the constants of this enum class, 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

Constructs the WorkflowRuntimeBuilder.

WorkflowRuntimeStatus - Enum Class 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 N P R S T V W
All Classes and Interfaces|All Packages|Serialized Form