Package io.camunda.client.api.command

Interface TenantScopedClusterVariableUpdateCommandStep1

All Superinterfaces:
FinalCommandStep<UpdateClusterVariableResponse>
All Known Implementing Classes:
TenantScopedUpdateClusterVariableImpl
public interface TenantScopedClusterVariableUpdateCommandStep1 extends FinalCommandStep<UpdateClusterVariableResponse>
Represents a request to update a tenant-scoped cluster variable.

Usage example: 

   UpdateClusterVariableResponse response = camundaClient
       .newTenantScopedClusterVariableUpdateRequest("my-tenant-id")
       .update("myVariable", "newValue")
       .send()
       .join();

  • Method Details

    • update

      TenantScopedClusterVariableUpdateCommandStep1 update(String name, Object value)
      Sets the name and new value of the cluster variable to update.

      The variable value will be serialized to JSON format. 

         camundaClient
       .newTenantScopedClusterVariableUpdateRequest("my-tenant-id")
       .update("myVariable", "newValue")  // for string values
       .send();
      Parameters:
      name - the name of the variable. Must not be null or empty.
      value - the new value of the variable. Must not be null. Will be serialized to JSON.
      Returns:
      this builder for method chaining

    • metadata

      TenantScopedClusterVariableUpdateCommandStep1 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