Class UpdateOptions.Builder<T>

java.lang.Object
io.temporal.client.UpdateOptions.Builder<T>
Enclosing class:
UpdateOptions<T>
public static final class UpdateOptions.Builder<T> extends Object

  • Method Details

    • setUpdateName

      public UpdateOptions.Builder<T> setUpdateName(String updateName)
      Name of the update handler. Usually it is a method name.

    • setUpdateId

      public UpdateOptions.Builder<T> setUpdateId(String updateId)
      The update ID is an application-layer identifier for the requested update. It must be unique within the scope of a workflow execution.

      Default value if not set: Random UUID

    • setFirstExecutionRunId

      public UpdateOptions.Builder<T> setFirstExecutionRunId(String firstExecutionRunId)
      The RunID expected to identify the first run in the workflow execution chain. If this expectation does not match then the server will reject the update request with an error.

      Default value if not set: Empty String

    • setWaitForStage

      public UpdateOptions.Builder<T> setWaitForStage(WorkflowUpdateStage waitForStage)
      Specifies at what point in the update request life cycles this request should return. Required to be set to one of the following values:
      • Accepted Wait for the update to be accepted by the workflow.
      • Completed Wait for the update to be completed by the workflow.
      Admitted is not allowed as a value.

    • setResultClass

      public UpdateOptions.Builder<T> setResultClass(Class<T> resultClass)
      The class of the update return value.

    • setResultType

      public UpdateOptions.Builder<T> setResultType(Type resultType)
      The type of the update return value.

      Default value if not set: resultClass

    • build

      public UpdateOptions<T> build()
      Builds StartUpdateOptions with default values.