Package io.camunda.zeebe.client.api.command

Interface FinalCommandStep<T>

All Known Subinterfaces:
ActivateJobsCommandStep1.ActivateJobsCommandStep3, CancelProcessInstanceCommandStep1, CompleteJobCommandStep1, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3, CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1, DeployProcessCommandStep1.DeployProcessCommandBuilderStep2, DeployResourceCommandStep1.DeployResourceCommandStep2, FailJobCommandStep1.FailJobCommandStep2, PublishMessageCommandStep1.PublishMessageCommandStep3, ResolveIncidentCommandStep1, SetVariablesCommandStep1.SetVariablesCommandStep2, ThrowErrorCommandStep1.ThrowErrorCommandStep2, TopologyRequestStep1, UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2
All Known Implementing Classes:
ActivateJobsCommandImpl, CancelProcessInstanceCommandImpl, CompleteJobCommandImpl, CreateProcessInstanceCommandImpl, CreateProcessInstanceWithResultCommandImpl, DeployProcessCommandImpl, DeployResourceCommandImpl, FailJobCommandImpl, JobUpdateRetriesCommandImpl, PublishMessageCommandImpl, ResolveIncidentCommandImpl, SetVariablesCommandImpl, ThrowErrorCommandImpl, TopologyRequestImpl
public interface FinalCommandStep<T>

  • Method Details

    • requestTimeout

      FinalCommandStep<T> requestTimeout(Duration requestTimeout)
      Sets the request timeout for the command. The default request timeout can be configured using ZeebeClientBuilder.defaultRequestTimeout(Duration).
      Parameters:
      requestTimeout - the request timeout
      Returns:
      the configured command

    • send

      ZeebeFuture<T> send()
      Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.

      Call ZeebeFuture.join() to wait until the response is available. 

       Future<JobEvent&#62 future = command.send();
 JobEvent event = future.join();
      Returns:
      a future tracking state of success/failure of the command.