Package io.camunda.client.api.command

Interface GloballyScopedClusterVariableDeletionCommandStep1

All Superinterfaces:

FinalCommandStep<DeleteClusterVariableResponse>

All Known Implementing Classes:

GloballyScopedDeleteClusterVariableImpl

public interface GloballyScopedClusterVariableDeletionCommandStep1
extends FinalCommandStep<DeleteClusterVariableResponse>

Represents a request to delete a globally-scoped cluster variable.

Usage example:

   camundaClient
       .newGloballyScopedClusterVariableDeleteRequest()
       .delete("myVariable")
       .send()
       .join();
 

Method Summary

Modifier and Type	Method	Description
GloballyScopedClusterVariableDeletionCommandStep1	delete(String name)	Specifies the name of the cluster variable to delete.

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute, requestTimeout, send

Method Details

delete

GloballyScopedClusterVariableDeletionCommandStep1 delete(String name)

Specifies the name of the cluster variable to delete.

The variable will be deleted only if it exists with the specified name and global scope. If the variable does not exist, a 404 error will be returned.

   camundaClient
       .newGloballyScopedClusterVariableDeleteRequest()
       .delete("myVariable")
       .send()
       .join();
 

Parameters:

name - the name of the variable to delete. Must not be null or empty.

Returns:

this builder for method chaining