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

Interface CommandWithCommunicationApiStep<T>

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

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    useGrpc()
    Deprecated.
    since 8.5, to be removed with 8.8
    T
    useRest()
    Deprecated.
    since 8.5, to be removed with 8.8

  • Method Details

    • useRest

      @ExperimentalApi("https://github.com/camunda/camunda/issues/16166") @Deprecated T useRest()
      Deprecated.
      since 8.5, to be removed with 8.8
      Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Zeebe, and already wants to use this API during its development. As support for REST is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

      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 ZeebeClientBuilder.preferRestOverGrpc(boolean).

      Returns:
      the configured command

    • useGrpc

      @ExperimentalApi("https://github.com/camunda/camunda/issues/16166") @Deprecated T useGrpc()
      Deprecated.
      since 8.5, to be removed with 8.8
      Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Zeebe, and already wants to use this API during its development. As support for REST is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

      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 ZeebeClientBuilder.preferRestOverGrpc(boolean).

      Returns:
      the configured command