Package io.camunda.client.api.command

Interface GloballyScopedClusterVariableCreationCommandStep1

All Superinterfaces:
FinalCommandStep<CreateClusterVariableResponse>
All Known Implementing Classes:
GloballyScopedCreateClusterVariableImpl
public interface GloballyScopedClusterVariableCreationCommandStep1 extends FinalCommandStep<CreateClusterVariableResponse>
Represents a request to create a globally-scoped cluster variable.

Usage example: 

   CreateClusterVariableResponse response = camundaClient
       .newGloballyScopedClusterVariableCreateRequest()
       .create("myVariable", "myValue")
       .send()
       .join();

  • Method Details

    • create

      GloballyScopedClusterVariableCreationCommandStep1 create(String name, Object value)
      Sets the name and value of the cluster variable.

      The variable value will be serialized to JSON format. 

         camundaClient
       .newGloballyScopedClusterVariableCreateRequest()
       .create("myVariable", "myValue")  // for string values
       .send();
      Parameters:
      name - the name of the variable. Must not be null or empty.
      value - the value of the variable. Must not be null. Will be serialized to JSON.
      Returns:
      this builder for method chaining

    • kind

      GloballyScopedClusterVariableCreationCommandStep1 kind(ClusterVariableKind kind)
      Sets the kind of the cluster variable (optional, defaults to JSON).
      Parameters:
      kind - the kind (JSON or SECRET_REFERENCE)
      Returns:
      this builder for method chaining

    • metadata

      GloballyScopedClusterVariableCreationCommandStep1 metadata(Map<String,Object> metadata)
      Sets the metadata bag of the cluster variable (optional). Values must be strings or numbers.
      Parameters:
      metadata - a map of metadata key to value
      Returns:
      this builder for method chaining