Package io.camunda.client.impl.command

Class GloballyScopedDeleteClusterVariableImpl

java.lang.Object

io.camunda.client.impl.command.GloballyScopedDeleteClusterVariableImpl

All Implemented Interfaces:

FinalCommandStep<DeleteClusterVariableResponse>, GloballyScopedClusterVariableDeletionCommandStep1

public class GloballyScopedDeleteClusterVariableImpl
extends Object
implements GloballyScopedClusterVariableDeletionCommandStep1

Constructor Summary

Constructors

Constructor	Description
GloballyScopedDeleteClusterVariableImpl(HttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
GloballyScopedClusterVariableDeletionCommandStep1	delete(String name)	Specifies the name of the cluster variable to delete.
GloballyScopedClusterVariableDeletionCommandStep1	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<DeleteClusterVariableResponse>	send()	Sends the command to the Camunda gateway.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

execute

Constructor Details

GloballyScopedDeleteClusterVariableImpl

public GloballyScopedDeleteClusterVariableImpl(HttpClient httpClient)

Method Details

delete

public GloballyScopedClusterVariableDeletionCommandStep1 delete(String name)

Description copied from interface: GloballyScopedClusterVariableDeletionCommandStep1

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();
 

Specified by:

delete in interface GloballyScopedClusterVariableDeletionCommandStep1

Parameters:

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

Returns:

this builder for method chaining

requestTimeout

public GloballyScopedClusterVariableDeletionCommandStep1 requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using CamundaClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<DeleteClusterVariableResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<DeleteClusterVariableResponse> send()

Description copied from interface: FinalCommandStep

Sends the command to the Camunda gateway. This operation is asynchronous. In case of success, the future returns the event that was generated by the Camunda gateway in response to the command.

Call CamundaFuture.join() to wait until the response is available.

 Future<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<DeleteClusterVariableResponse>

Returns:

a future tracking state of success/failure of the command.