Package io.camunda.client.api.command

Interface CommandWithCommunicationApiStep<T>

All Known Subinterfaces:
ActivateJobsCommandStep1, AssignProcessInstanceBusinessIdCommandStep1, BroadcastSignalCommandStep1, CancelProcessInstanceCommandStep1, CompleteJobCommandStep1, CreateProcessInstanceCommandStep1, CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1, DeleteResourceCommandStep1, DeployResourceCommandStep1, DeployResourceCommandStep1.DeployResourceCommandStep2, EvaluateConditionalCommandStep1, EvaluateDecisionCommandStep1, FailJobCommandStep1, MigrateProcessInstanceCommandStep1, ModifyProcessInstanceCommandStep1, PublishMessageCommandStep1, ResolveIncidentCommandStep1, SetVariablesCommandStep1, ThrowErrorCommandStep1, TopologyRequestStep1, UpdateJobPriorityCommandStep1, UpdateRetriesJobCommandStep1, UpdateTimeoutJobCommandStep1
All Known Implementing Classes:
ActivateJobsCommandImpl, AssignProcessInstanceBusinessIdCommandImpl, BroadcastSignalCommandImpl, CancelProcessInstanceCommandImpl, CompleteJobCommandImpl, CreateProcessInstanceCommandImpl, CreateProcessInstanceWithResultCommandImpl, DeleteResourceCommandImpl, DeployResourceCommandImpl, EvaluateConditionalCommandImpl, EvaluateDecisionCommandImpl, FailJobCommandImpl, JobUpdatePriorityCommandImpl, JobUpdateRetriesCommandImpl, JobUpdateTimeoutCommandImpl, MigrateProcessInstanceCommandImpl, ModifyProcessInstanceCommandImpl, PublishMessageCommandImpl, ResolveIncidentCommandImpl, SetVariablesCommandImpl, ThrowErrorCommandImpl, TopologyRequestImpl
public interface CommandWithCommunicationApiStep<T>

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    useGrpc()
    Sets gRPC as the communication API for this command.
    T
    useRest()
    Sets REST as the communication API for this command.

  • Method Details

    • useRest

      T useRest()
      Sets REST as the communication API for this command. If this command doesn't support communication over REST, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).
      Returns:
      the configured command

    • useGrpc

      T useGrpc()
      Sets gRPC as the communication API for this command. If this command doesn't support communication over gRPC, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).
      Returns:
      the configured command