Class WorkflowClientInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      WorkflowExecution enqueueSignalWithStart​(BatchRequest signalWithStartBatch)
      Schedules a SignalWithStart operation to be performed at a future date via SignalWithStartWorkflowExecutionAsync.
      static <R> WorkflowExecution enqueueStart​(Functions.Func<R> workflow)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​R>
      WorkflowExecution
      enqueueStart​(Functions.Func1<A1,​R> workflow, A1 arg1)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2,​R>
      WorkflowExecution
      enqueueStart​(Functions.Func2<A1,​A2,​R> workflow, A1 arg1, A2 arg2)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2,​A3,​R>
      WorkflowExecution
      enqueueStart​(Functions.Func3<A1,​A2,​A3,​R> workflow, A1 arg1, A2 arg2, A3 arg3)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2,​A3,​A4,​R>
      WorkflowExecution
      enqueueStart​(Functions.Func4<A1,​A2,​A3,​A4,​R> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2,​A3,​A4,​A5,​R>
      WorkflowExecution
      enqueueStart​(Functions.Func5<A1,​A2,​A3,​A4,​A5,​R> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2,​A3,​A4,​A5,​A6,​R>
      WorkflowExecution
      enqueueStart​(Functions.Func6<A1,​A2,​A3,​A4,​A5,​A6,​R> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5, A6 arg6)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static WorkflowExecution enqueueStart​(Functions.Proc workflow)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1> WorkflowExecution enqueueStart​(Functions.Proc1<A1> workflow, A1 arg1)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2>
      WorkflowExecution
      enqueueStart​(Functions.Proc2<A1,​A2> workflow, A1 arg1, A2 arg2)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2,​A3>
      WorkflowExecution
      enqueueStart​(Functions.Proc3<A1,​A2,​A3> workflow, A1 arg1, A2 arg2, A3 arg3)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2,​A3,​A4>
      WorkflowExecution
      enqueueStart​(Functions.Proc4<A1,​A2,​A3,​A4> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2,​A3,​A4,​A5>
      WorkflowExecution
      enqueueStart​(Functions.Proc5<A1,​A2,​A3,​A4,​A5> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <A1,​A2,​A3,​A4,​A5,​A6>
      WorkflowExecution
      enqueueStart​(Functions.Proc6<A1,​A2,​A3,​A4,​A5,​A6> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5, A6 arg6)
      Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync.
      static <R> java.util.concurrent.CompletableFuture<R> execute​(Functions.Func<R> workflow)
      Executes zero argument workflow.
      static <A1,​R>
      java.util.concurrent.CompletableFuture<R>
      execute​(Functions.Func1<A1,​R> workflow, A1 arg1)
      Executes one argument workflow asynchronously.
      static <A1,​A2,​R>
      java.util.concurrent.CompletableFuture<R>
      execute​(Functions.Func2<A1,​A2,​R> workflow, A1 arg1, A2 arg2)
      Executes two argument workflow asynchronously.
      static <A1,​A2,​A3,​R>
      java.util.concurrent.CompletableFuture<R>
      execute​(Functions.Func3<A1,​A2,​A3,​R> workflow, A1 arg1, A2 arg2, A3 arg3)
      Executes three argument workflow asynchronously.
      static <A1,​A2,​A3,​A4,​R>
      java.util.concurrent.CompletableFuture<R>
      execute​(Functions.Func4<A1,​A2,​A3,​A4,​R> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4)
      Executes four argument workflow asynchronously.
      static <A1,​A2,​A3,​A4,​A5,​R>
      java.util.concurrent.CompletableFuture<R>
      execute​(Functions.Func5<A1,​A2,​A3,​A4,​A5,​R> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5)
      Executes five argument workflow asynchronously.
      static <A1,​A2,​A3,​A4,​A5,​A6,​R>
      java.util.concurrent.CompletableFuture<R>
      execute​(Functions.Func6<A1,​A2,​A3,​A4,​A5,​A6,​R> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5, A6 arg6)
      Executes six argument workflow asynchronously.
      static java.util.concurrent.CompletableFuture<java.lang.Void> execute​(Functions.Proc workflow)
      Executes zero argument workflow with void return type
      static <A1> java.util.concurrent.CompletableFuture<java.lang.Void> execute​(Functions.Proc1<A1> workflow, A1 arg1)
      Executes one argument workflow with void return type
      static <A1,​A2>
      java.util.concurrent.CompletableFuture<java.lang.Void>
      execute​(Functions.Proc2<A1,​A2> workflow, A1 arg1, A2 arg2)
      Executes two argument workflow with void return type
      static <A1,​A2,​A3>
      java.util.concurrent.CompletableFuture<java.lang.Void>
      execute​(Functions.Proc3<A1,​A2,​A3> workflow, A1 arg1, A2 arg2, A3 arg3)
      Executes three argument workflow with void return type
      static <A1,​A2,​A3,​A4>
      java.util.concurrent.CompletableFuture<java.lang.Void>
      execute​(Functions.Proc4<A1,​A2,​A3,​A4> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4)
      Executes four argument workflow with void return type
      static <A1,​A2,​A3,​A4,​A5>
      java.util.concurrent.CompletableFuture<java.lang.Void>
      execute​(Functions.Proc5<A1,​A2,​A3,​A4,​A5> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5)
      Executes five argument workflow with void return type
      static <A1,​A2,​A3,​A4,​A5,​A6>
      java.util.concurrent.CompletableFuture<java.lang.Void>
      execute​(Functions.Proc6<A1,​A2,​A3,​A4,​A5,​A6> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5, A6 arg6)
      Executes six argument workflow with void return type
      WorkflowClientOptions getOptions()  
      IWorkflowService getService()  
      ActivityCompletionClient newActivityCompletionClient()
      Creates new ActivityCompletionClient that can be used to complete activities asynchronously.
      static WorkflowClient newInstance​(IWorkflowService service, WorkflowClientOptions options)
      Creates client that connects to an instance of the Cadence Service.
      BatchRequest newSignalWithStartRequest()
      Creates BatchRequest that can be used to signal an existing workflow or start a new one if not running.
      WorkflowStub newUntypedWorkflowStub​(WorkflowExecution execution, java.util.Optional<java.lang.String> workflowType)
      Creates workflow untyped client stub for a known execution.
      WorkflowStub newUntypedWorkflowStub​(java.lang.String workflowType, WorkflowOptions options)
      Creates workflow untyped client stub that can be used to start a single workflow execution.
      WorkflowStub newUntypedWorkflowStub​(java.lang.String workflowId, java.util.Optional<java.lang.String> runId, java.util.Optional<java.lang.String> workflowType)
      Creates workflow untyped client stub for a known execution.
      <T> T newWorkflowStub​(java.lang.Class<T> workflowInterface)
      Creates workflow client stub that can be used to start a single workflow execution.
      <T> T newWorkflowStub​(java.lang.Class<T> workflowInterface, WorkflowOptions options)
      Creates workflow client stub that can be used to start a single workflow execution.
      <T> T newWorkflowStub​(java.lang.Class<T> workflowInterface, java.lang.String workflowId)
      Creates workflow client stub for a known execution.
      <T> T newWorkflowStub​(java.lang.Class<T> workflowInterface, java.lang.String workflowId, java.util.Optional<java.lang.String> runId)
      Creates workflow client stub for a known execution.
      void refreshWorkflowTasks​(RefreshWorkflowTasksRequest refreshWorkflowTasksRequest)
      Refreshes all the tasks of a given workflow.
      WorkflowExecution signalWithStart​(BatchRequest signalWithStartBatch)
      Invoke SignalWithStart operation.
      static <R> WorkflowExecution start​(Functions.Func<R> workflow)
      Executes zero argument workflow.
      static <A1,​R>
      WorkflowExecution
      start​(Functions.Func1<A1,​R> workflow, A1 arg1)
      Executes one argument workflow asynchronously.
      static <A1,​A2,​R>
      WorkflowExecution
      start​(Functions.Func2<A1,​A2,​R> workflow, A1 arg1, A2 arg2)
      Executes two argument workflow asynchronously.
      static <A1,​A2,​A3,​R>
      WorkflowExecution
      start​(Functions.Func3<A1,​A2,​A3,​R> workflow, A1 arg1, A2 arg2, A3 arg3)
      Executes three argument workflow asynchronously.
      static <A1,​A2,​A3,​A4,​R>
      WorkflowExecution
      start​(Functions.Func4<A1,​A2,​A3,​A4,​R> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4)
      Executes four argument workflow asynchronously.
      static <A1,​A2,​A3,​A4,​A5,​R>
      WorkflowExecution
      start​(Functions.Func5<A1,​A2,​A3,​A4,​A5,​R> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5)
      Executes five argument workflow asynchronously.
      static <A1,​A2,​A3,​A4,​A5,​A6,​R>
      WorkflowExecution
      start​(Functions.Func6<A1,​A2,​A3,​A4,​A5,​A6,​R> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5, A6 arg6)
      Executes six argument workflow asynchronously.
      static WorkflowExecution start​(Functions.Proc workflow)
      Executes zero argument workflow with void return type
      static <A1> WorkflowExecution start​(Functions.Proc1<A1> workflow, A1 arg1)
      Executes one argument workflow with void return type
      static <A1,​A2>
      WorkflowExecution
      start​(Functions.Proc2<A1,​A2> workflow, A1 arg1, A2 arg2)
      Executes two argument workflow with void return type
      static <A1,​A2,​A3>
      WorkflowExecution
      start​(Functions.Proc3<A1,​A2,​A3> workflow, A1 arg1, A2 arg2, A3 arg3)
      Executes three argument workflow with void return type
      static <A1,​A2,​A3,​A4>
      WorkflowExecution
      start​(Functions.Proc4<A1,​A2,​A3,​A4> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4)
      Executes four argument workflow with void return type
      static <A1,​A2,​A3,​A4,​A5>
      WorkflowExecution
      start​(Functions.Proc5<A1,​A2,​A3,​A4,​A5> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5)
      Executes five argument workflow with void return type
      static <A1,​A2,​A3,​A4,​A5,​A6>
      WorkflowExecution
      start​(Functions.Proc6<A1,​A2,​A3,​A4,​A5,​A6> workflow, A1 arg1, A2 arg2, A3 arg3, A4 arg4, A5 arg5, A6 arg6)
      Executes six argument workflow with void return type
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • newInstance

        public static WorkflowClient newInstance​(IWorkflowService service,
                                                 WorkflowClientOptions options)
        Creates client that connects to an instance of the Cadence Service.
        Parameters:
        service - client to the Cadence Service endpoint.
        options - Options (like DataConverter override) for configuring client.
      • newWorkflowStub

        public <T> T newWorkflowStub​(java.lang.Class<T> workflowInterface)
        Description copied from interface: WorkflowClient
        Creates workflow client stub that can be used to start a single workflow execution. The first call must be to a method annotated with @WorkflowMethod. After workflow is started it can be also used to send signals or queries to it. IMPORTANT! Stub is per workflow instance. So new stub should be created for each new one.
        Specified by:
        newWorkflowStub in interface WorkflowClient
        Parameters:
        workflowInterface - interface that given workflow implements
        Returns:
        Stub that implements workflowInterface and can be used to start workflow and later to signal or query it.
      • newWorkflowStub

        public <T> T newWorkflowStub​(java.lang.Class<T> workflowInterface,
                                     WorkflowOptions options)
        Description copied from interface: WorkflowClient
        Creates workflow client stub that can be used to start a single workflow execution. The first call must be to a method annotated with @WorkflowMethod. After workflow is started it can be also used to send signals or queries to it. IMPORTANT! Stub is per workflow instance. So new stub should be created for each new one.
        Specified by:
        newWorkflowStub in interface WorkflowClient
        Parameters:
        workflowInterface - interface that given workflow implements
        options - options used to start a workflow through returned stub
        Returns:
        Stub that implements workflowInterface and can be used to start workflow and later to signal or query it.
      • newWorkflowStub

        public <T> T newWorkflowStub​(java.lang.Class<T> workflowInterface,
                                     java.lang.String workflowId)
        Description copied from interface: WorkflowClient
        Creates workflow client stub for a known execution. Use it to send signals or queries to a running workflow. Do not call methods annotated with @WorkflowMethod.
        Specified by:
        newWorkflowStub in interface WorkflowClient
        Parameters:
        workflowInterface - interface that given workflow implements.
        workflowId - Workflow id.
        Returns:
        Stub that implements workflowInterface and can be used to signal or query it.
      • newWorkflowStub

        public <T> T newWorkflowStub​(java.lang.Class<T> workflowInterface,
                                     java.lang.String workflowId,
                                     java.util.Optional<java.lang.String> runId)
        Description copied from interface: WorkflowClient
        Creates workflow client stub for a known execution. Use it to send signals or queries to a running workflow. Do not call methods annotated with @WorkflowMethod.
        Specified by:
        newWorkflowStub in interface WorkflowClient
        Parameters:
        workflowInterface - interface that given workflow implements.
        workflowId - Workflow id.
        runId - Run id of the workflow execution.
        Returns:
        Stub that implements workflowInterface and can be used to signal or query it.
      • newUntypedWorkflowStub

        public WorkflowStub newUntypedWorkflowStub​(java.lang.String workflowType,
                                                   WorkflowOptions options)
        Description copied from interface: WorkflowClient
        Creates workflow untyped client stub that can be used to start a single workflow execution. After workflow is started it can be also used to send signals or queries to it. IMPORTANT! Stub is per workflow instance. So new stub should be created for each new one.
        Specified by:
        newUntypedWorkflowStub in interface WorkflowClient
        Parameters:
        workflowType - name of the workflow type
        options - options used to start a workflow through returned stub
        Returns:
        Stub that can be used to start workflow and later to signal or query it.
      • newUntypedWorkflowStub

        public WorkflowStub newUntypedWorkflowStub​(java.lang.String workflowId,
                                                   java.util.Optional<java.lang.String> runId,
                                                   java.util.Optional<java.lang.String> workflowType)
        Description copied from interface: WorkflowClient
        Creates workflow untyped client stub for a known execution. Use it to send signals or queries to a running workflow. Do not call methods annotated with @WorkflowMethod.
        Specified by:
        newUntypedWorkflowStub in interface WorkflowClient
        Parameters:
        workflowId - workflow id and optional run id for execution
        runId - runId of the workflow execution. If not provided the last workflow with the given workflowId is assumed.
        workflowType - type of the workflow. Optional as it is used for error reporting only.
        Returns:
        Stub that can be used to start workflow and later to signal or query it.
      • newUntypedWorkflowStub

        public WorkflowStub newUntypedWorkflowStub​(WorkflowExecution execution,
                                                   java.util.Optional<java.lang.String> workflowType)
        Description copied from interface: WorkflowClient
        Creates workflow untyped client stub for a known execution. Use it to send signals or queries to a running workflow. Do not call methods annotated with @WorkflowMethod.
        Specified by:
        newUntypedWorkflowStub in interface WorkflowClient
        Parameters:
        execution - workflow id and optional run id for execution
        workflowType - type of the workflow. Optional as it is used for error reporting only.
        Returns:
        Stub that can be used to start workflow and later to signal or query it.
      • enqueueSignalWithStart

        public WorkflowExecution enqueueSignalWithStart​(BatchRequest signalWithStartBatch)
        Description copied from interface: WorkflowClient
        Schedules a SignalWithStart operation to be performed at a future date via SignalWithStartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Specified by:
        enqueueSignalWithStart in interface WorkflowClient
        Parameters:
        signalWithStartBatch - Must be created with WorkflowClient.newSignalWithStartRequest()
        Returns:
        WorkflowExecution containing only the workflowId
      • refreshWorkflowTasks

        public void refreshWorkflowTasks​(RefreshWorkflowTasksRequest refreshWorkflowTasksRequest)
                                  throws org.apache.thrift.TException
        Description copied from interface: WorkflowClient
        Refreshes all the tasks of a given workflow.
        Specified by:
        refreshWorkflowTasks in interface WorkflowClient
        Parameters:
        refreshWorkflowTasksRequest - that contains WorkflowID and RunID of the started workflow.
        Throws:
        org.apache.thrift.TException
      • start

        public static <A1,​A2> WorkflowExecution start​(Functions.Proc2<A1,​A2> workflow,
                                                            A1 arg1,
                                                            A2 arg2)
        Description copied from interface: WorkflowClient
        Executes two argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • start

        public static <A1,​A2,​A3> WorkflowExecution start​(Functions.Proc3<A1,​A2,​A3> workflow,
                                                                     A1 arg1,
                                                                     A2 arg2,
                                                                     A3 arg3)
        Description copied from interface: WorkflowClient
        Executes three argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • start

        public static <A1,​A2,​A3,​A4> WorkflowExecution start​(Functions.Proc4<A1,​A2,​A3,​A4> workflow,
                                                                              A1 arg1,
                                                                              A2 arg2,
                                                                              A3 arg3,
                                                                              A4 arg4)
        Description copied from interface: WorkflowClient
        Executes four argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • start

        public static <A1,​A2,​A3,​A4,​A5> WorkflowExecution start​(Functions.Proc5<A1,​A2,​A3,​A4,​A5> workflow,
                                                                                       A1 arg1,
                                                                                       A2 arg2,
                                                                                       A3 arg3,
                                                                                       A4 arg4,
                                                                                       A5 arg5)
        Description copied from interface: WorkflowClient
        Executes five argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - fifth workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • start

        public static <A1,​A2,​A3,​A4,​A5,​A6> WorkflowExecution start​(Functions.Proc6<A1,​A2,​A3,​A4,​A5,​A6> workflow,
                                                                                                A1 arg1,
                                                                                                A2 arg2,
                                                                                                A3 arg3,
                                                                                                A4 arg4,
                                                                                                A5 arg5,
                                                                                                A6 arg6)
        Description copied from interface: WorkflowClient
        Executes six argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - sixth workflow function parameter
        arg6 - sixth workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • start

        public static <A1,​A2,​R> WorkflowExecution start​(Functions.Func2<A1,​A2,​R> workflow,
                                                                    A1 arg1,
                                                                    A2 arg2)
        Description copied from interface: WorkflowClient
        Executes two argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • start

        public static <A1,​A2,​A3,​R> WorkflowExecution start​(Functions.Func3<A1,​A2,​A3,​R> workflow,
                                                                             A1 arg1,
                                                                             A2 arg2,
                                                                             A3 arg3)
        Description copied from interface: WorkflowClient
        Executes three argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • start

        public static <A1,​A2,​A3,​A4,​R> WorkflowExecution start​(Functions.Func4<A1,​A2,​A3,​A4,​R> workflow,
                                                                                      A1 arg1,
                                                                                      A2 arg2,
                                                                                      A3 arg3,
                                                                                      A4 arg4)
        Description copied from interface: WorkflowClient
        Executes four argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • start

        public static <A1,​A2,​A3,​A4,​A5,​R> WorkflowExecution start​(Functions.Func5<A1,​A2,​A3,​A4,​A5,​R> workflow,
                                                                                               A1 arg1,
                                                                                               A2 arg2,
                                                                                               A3 arg3,
                                                                                               A4 arg4,
                                                                                               A5 arg5)
        Description copied from interface: WorkflowClient
        Executes five argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - sixth workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • start

        public static <A1,​A2,​A3,​A4,​A5,​A6,​R> WorkflowExecution start​(Functions.Func6<A1,​A2,​A3,​A4,​A5,​A6,​R> workflow,
                                                                                                        A1 arg1,
                                                                                                        A2 arg2,
                                                                                                        A3 arg3,
                                                                                                        A4 arg4,
                                                                                                        A5 arg5,
                                                                                                        A6 arg6)
        Description copied from interface: WorkflowClient
        Executes six argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow argument
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - sixth workflow function parameter
        arg6 - sixth workflow function parameter
        Returns:
        WorkflowExecution that contains WorkflowID and RunID of the started workflow.
      • enqueueStart

        public static WorkflowExecution enqueueStart​(Functions.Proc workflow)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1> WorkflowExecution enqueueStart​(Functions.Proc1<A1> workflow,
                                                          A1 arg1)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow argument
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2> WorkflowExecution enqueueStart​(Functions.Proc2<A1,​A2> workflow,
                                                                   A1 arg1,
                                                                   A2 arg2)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow argument
        arg2 - second workflow argument
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2,​A3> WorkflowExecution enqueueStart​(Functions.Proc3<A1,​A2,​A3> workflow,
                                                                            A1 arg1,
                                                                            A2 arg2,
                                                                            A3 arg3)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow argument
        arg2 - second workflow argument
        arg3 - third workflow argument
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2,​A3,​A4> WorkflowExecution enqueueStart​(Functions.Proc4<A1,​A2,​A3,​A4> workflow,
                                                                                     A1 arg1,
                                                                                     A2 arg2,
                                                                                     A3 arg3,
                                                                                     A4 arg4)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2,​A3,​A4,​A5> WorkflowExecution enqueueStart​(Functions.Proc5<A1,​A2,​A3,​A4,​A5> workflow,
                                                                                              A1 arg1,
                                                                                              A2 arg2,
                                                                                              A3 arg3,
                                                                                              A4 arg4,
                                                                                              A5 arg5)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - fifth workflow function parameter
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2,​A3,​A4,​A5,​A6> WorkflowExecution enqueueStart​(Functions.Proc6<A1,​A2,​A3,​A4,​A5,​A6> workflow,
                                                                                                       A1 arg1,
                                                                                                       A2 arg2,
                                                                                                       A3 arg3,
                                                                                                       A4 arg4,
                                                                                                       A5 arg5,
                                                                                                       A6 arg6)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - sixth workflow function parameter
        arg6 - sixth workflow function parameter
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <R> WorkflowExecution enqueueStart​(Functions.Func<R> workflow)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​R> WorkflowExecution enqueueStart​(Functions.Func1<A1,​R> workflow,
                                                                  A1 arg1)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2,​R> WorkflowExecution enqueueStart​(Functions.Func2<A1,​A2,​R> workflow,
                                                                           A1 arg1,
                                                                           A2 arg2)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2,​A3,​R> WorkflowExecution enqueueStart​(Functions.Func3<A1,​A2,​A3,​R> workflow,
                                                                                    A1 arg1,
                                                                                    A2 arg2,
                                                                                    A3 arg3)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2,​A3,​A4,​R> WorkflowExecution enqueueStart​(Functions.Func4<A1,​A2,​A3,​A4,​R> workflow,
                                                                                             A1 arg1,
                                                                                             A2 arg2,
                                                                                             A3 arg3,
                                                                                             A4 arg4)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2,​A3,​A4,​A5,​R> WorkflowExecution enqueueStart​(Functions.Func5<A1,​A2,​A3,​A4,​A5,​R> workflow,
                                                                                                      A1 arg1,
                                                                                                      A2 arg2,
                                                                                                      A3 arg3,
                                                                                                      A4 arg4,
                                                                                                      A5 arg5)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - fifth workflow function parameter
        Returns:
        WorkflowExecution containing only the workflowId
      • enqueueStart

        public static <A1,​A2,​A3,​A4,​A5,​A6,​R> WorkflowExecution enqueueStart​(Functions.Func6<A1,​A2,​A3,​A4,​A5,​A6,​R> workflow,
                                                                                                               A1 arg1,
                                                                                                               A2 arg2,
                                                                                                               A3 arg3,
                                                                                                               A4 arg4,
                                                                                                               A5 arg5,
                                                                                                               A6 arg6)
        Description copied from interface: WorkflowClient
        Schedules a workflow to be started at a future date via StartWorkflowExecutionAsync. This requires that async execution has been enabled for this domain.

        Note that the returned WorkflowExecution will NOT contain a runId, only a workflowId. This is because the runId is only determined at the time the workflow actually starts.

        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - sixth workflow function parameter
        arg6 - sixth workflow function parameter
        Returns:
        WorkflowExecution containing only the workflowId
      • execute

        public static java.util.concurrent.CompletableFuture<java.lang.Void> execute​(Functions.Proc workflow)
        Description copied from interface: WorkflowClient
        Executes zero argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        Returns:
        future becomes ready upon workflow completion with null value or failure
      • execute

        public static <A1> java.util.concurrent.CompletableFuture<java.lang.Void> execute​(Functions.Proc1<A1> workflow,
                                                                                          A1 arg1)
        Description copied from interface: WorkflowClient
        Executes one argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        Returns:
        future becomes ready upon workflow completion with null value or failure
      • execute

        public static <A1,​A2> java.util.concurrent.CompletableFuture<java.lang.Void> execute​(Functions.Proc2<A1,​A2> workflow,
                                                                                                   A1 arg1,
                                                                                                   A2 arg2)
        Description copied from interface: WorkflowClient
        Executes two argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        Returns:
        future becomes ready upon workflow completion with null value or failure
      • execute

        public static <A1,​A2,​A3> java.util.concurrent.CompletableFuture<java.lang.Void> execute​(Functions.Proc3<A1,​A2,​A3> workflow,
                                                                                                            A1 arg1,
                                                                                                            A2 arg2,
                                                                                                            A3 arg3)
        Description copied from interface: WorkflowClient
        Executes three argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        Returns:
        future becomes ready upon workflow completion with null value or failure
      • execute

        public static <A1,​A2,​A3,​A4> java.util.concurrent.CompletableFuture<java.lang.Void> execute​(Functions.Proc4<A1,​A2,​A3,​A4> workflow,
                                                                                                                     A1 arg1,
                                                                                                                     A2 arg2,
                                                                                                                     A3 arg3,
                                                                                                                     A4 arg4)
        Description copied from interface: WorkflowClient
        Executes four argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        Returns:
        future becomes ready upon workflow completion with null value or failure
      • execute

        public static <A1,​A2,​A3,​A4,​A5> java.util.concurrent.CompletableFuture<java.lang.Void> execute​(Functions.Proc5<A1,​A2,​A3,​A4,​A5> workflow,
                                                                                                                              A1 arg1,
                                                                                                                              A2 arg2,
                                                                                                                              A3 arg3,
                                                                                                                              A4 arg4,
                                                                                                                              A5 arg5)
        Description copied from interface: WorkflowClient
        Executes five argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - fifth workflow function parameter
        Returns:
        future becomes ready upon workflow completion with null value or failure
      • execute

        public static <A1,​A2,​A3,​A4,​A5,​A6> java.util.concurrent.CompletableFuture<java.lang.Void> execute​(Functions.Proc6<A1,​A2,​A3,​A4,​A5,​A6> workflow,
                                                                                                                                       A1 arg1,
                                                                                                                                       A2 arg2,
                                                                                                                                       A3 arg3,
                                                                                                                                       A4 arg4,
                                                                                                                                       A5 arg5,
                                                                                                                                       A6 arg6)
        Description copied from interface: WorkflowClient
        Executes six argument workflow with void return type
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - sixth workflow function parameter
        arg6 - sixth workflow function parameter
        Returns:
        future becomes ready upon workflow completion with null value or failure
      • execute

        public static <A1,​R> java.util.concurrent.CompletableFuture<R> execute​(Functions.Func1<A1,​R> workflow,
                                                                                     A1 arg1)
        Description copied from interface: WorkflowClient
        Executes one argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow argument
        Returns:
        future that contains workflow result or failure
      • execute

        public static <A1,​A2,​R> java.util.concurrent.CompletableFuture<R> execute​(Functions.Func2<A1,​A2,​R> workflow,
                                                                                              A1 arg1,
                                                                                              A2 arg2)
        Description copied from interface: WorkflowClient
        Executes two argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        Returns:
        future that contains workflow result or failure
      • execute

        public static <A1,​A2,​A3,​R> java.util.concurrent.CompletableFuture<R> execute​(Functions.Func3<A1,​A2,​A3,​R> workflow,
                                                                                                       A1 arg1,
                                                                                                       A2 arg2,
                                                                                                       A3 arg3)
        Description copied from interface: WorkflowClient
        Executes three argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        Returns:
        future that contains workflow result or failure
      • execute

        public static <A1,​A2,​A3,​A4,​R> java.util.concurrent.CompletableFuture<R> execute​(Functions.Func4<A1,​A2,​A3,​A4,​R> workflow,
                                                                                                                A1 arg1,
                                                                                                                A2 arg2,
                                                                                                                A3 arg3,
                                                                                                                A4 arg4)
        Description copied from interface: WorkflowClient
        Executes four argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        Returns:
        future that contains workflow result or failure
      • execute

        public static <A1,​A2,​A3,​A4,​A5,​R> java.util.concurrent.CompletableFuture<R> execute​(Functions.Func5<A1,​A2,​A3,​A4,​A5,​R> workflow,
                                                                                                                         A1 arg1,
                                                                                                                         A2 arg2,
                                                                                                                         A3 arg3,
                                                                                                                         A4 arg4,
                                                                                                                         A5 arg5)
        Description copied from interface: WorkflowClient
        Executes five argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow function parameter
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - sixth workflow function parameter
        Returns:
        future that contains workflow result or failure
      • execute

        public static <A1,​A2,​A3,​A4,​A5,​A6,​R> java.util.concurrent.CompletableFuture<R> execute​(Functions.Func6<A1,​A2,​A3,​A4,​A5,​A6,​R> workflow,
                                                                                                                                  A1 arg1,
                                                                                                                                  A2 arg2,
                                                                                                                                  A3 arg3,
                                                                                                                                  A4 arg4,
                                                                                                                                  A5 arg5,
                                                                                                                                  A6 arg6)
        Description copied from interface: WorkflowClient
        Executes six argument workflow asynchronously.
        Parameters:
        workflow - The only supported value is method reference to a proxy created through WorkflowClient.newWorkflowStub(Class, WorkflowOptions).
        arg1 - first workflow argument
        arg2 - second workflow function parameter
        arg3 - third workflow function parameter
        arg4 - fourth workflow function parameter
        arg5 - sixth workflow function parameter
        arg6 - sixth workflow function parameter
        Returns:
        future that contains workflow result or failure