Class NexusOperationOptions.Builder

java.lang.Object
io.temporal.workflow.NexusOperationOptions.Builder
Enclosing class:
NexusOperationOptions
public static final class NexusOperationOptions.Builder extends Object

  • Method Details

    • setScheduleToCloseTimeout

      public NexusOperationOptions.Builder setScheduleToCloseTimeout(Duration scheduleToCloseTimeout)
      Sets the schedule to close timeout for the Nexus operation.
      Parameters:
      scheduleToCloseTimeout - the schedule to close timeout for the Nexus operation
      Returns:
      this

    • setScheduleToStartTimeout

      @Experimental public NexusOperationOptions.Builder setScheduleToStartTimeout(Duration scheduleToStartTimeout)
      Sets the schedule to start timeout for the Nexus operation.

      Maximum time to wait for the operation to be started (or completed if synchronous) by the handler. If the operation is not started within this timeout, it will fail with TIMEOUT_TYPE_SCHEDULE_TO_START.

      Requires Temporal Server 1.31.0 or later.

      Parameters:
      scheduleToStartTimeout - the schedule to start timeout for the Nexus operation
      Returns:
      this

    • setStartToCloseTimeout

      @Experimental public NexusOperationOptions.Builder setStartToCloseTimeout(Duration startToCloseTimeout)
      Sets the start to close timeout for the Nexus operation.

      Maximum time to wait for an asynchronous operation to complete after it has been started. If the operation does not complete within this timeout after starting, it will fail with TIMEOUT_TYPE_START_TO_CLOSE.

      Only applies to asynchronous operations. Synchronous operations ignore this timeout.

      Requires Temporal Server 1.31.0 or later.

      Parameters:
      startToCloseTimeout - the start to close timeout for the Nexus operation
      Returns:
      this

    • setCancellationType

      @Experimental public NexusOperationOptions.Builder setCancellationType(NexusOperationCancellationType cancellationType)
      Sets the cancellation type for the Nexus operation. Defaults to WAIT_COMPLETED.
      Parameters:
      cancellationType - the cancellation type for the Nexus operation
      Returns:
      this

    • setSummary

      @Experimental public NexusOperationOptions.Builder setSummary(String summary)
      Single-line fixed summary for this Nexus operation that will appear in UI/CLI. This can be in single-line Temporal Markdown format.

      Default is none/empty.

    • build

      public NexusOperationOptions build()

    • mergeNexusOperationOptions

      public NexusOperationOptions.Builder mergeNexusOperationOptions(NexusOperationOptions override)