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

Interface CommandWithCommunicationApiStep<T>

All Known Subinterfaces:
TopologyRequestStep1
All Known Implementing Classes:
TopologyRequestImpl
public interface CommandWithCommunicationApiStep<T>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final List<String>
    AVAILABLE_COMMUNICATION_API
     
    static final String
    DEFAULT_COMMUNICATION_API
    The communication API for commands to use if no communication API is explicitly set.
    static final String
    GRPC
     
    static final String
    REST
     

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    useGrpc()
    Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
    T
    useRest()
    Experimental: This method is under development, and as such using it may have no effect on the command builder when called.

  • Field Details

  • Method Details

    • useRest

      @ExperimentalApi("https://github.com/camunda/zeebe/issues/16166") T useRest()
      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.defaultCommunicationApi(String).

      Returns:
      the configured command

    • useGrpc

      @ExperimentalApi("https://github.com/camunda/zeebe/issues/16166") T useGrpc()
      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.defaultCommunicationApi(String).

      Returns:
      the configured command