Package io.camunda.client.impl.command

Class GloballyScopedUpdateClusterVariableImpl

java.lang.Object

io.camunda.client.impl.command.GloballyScopedUpdateClusterVariableImpl

All Implemented Interfaces:

FinalCommandStep<UpdateClusterVariableResponse>, GloballyScopedClusterVariableUpdateCommandStep1

public class GloballyScopedUpdateClusterVariableImpl
extends Object
implements GloballyScopedClusterVariableUpdateCommandStep1

Constructor Summary

Constructors

Constructor	Description
GloballyScopedUpdateClusterVariableImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
GloballyScopedClusterVariableUpdateCommandStep1	metadata(Map<String,Object> metadata)	Sets the metadata bag of the cluster variable (optional).
GloballyScopedClusterVariableUpdateCommandStep1	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<UpdateClusterVariableResponse>	send()	Sends the command to the Camunda gateway.
GloballyScopedClusterVariableUpdateCommandStep1	update(String name, Object value)	Sets the name and new value of the cluster variable to update.

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

GloballyScopedUpdateClusterVariableImpl

public GloballyScopedUpdateClusterVariableImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

update

public GloballyScopedClusterVariableUpdateCommandStep1 update(String name,
 Object value)

Description copied from interface: GloballyScopedClusterVariableUpdateCommandStep1

Sets the name and new value of the cluster variable to update.

The variable value will be serialized to JSON format.

   camundaClient
       .newGloballyScopedClusterVariableUpdateRequest()
       .update("myVariable", "newValue")  // for string values
       .send();
 

Specified by:

update in interface GloballyScopedClusterVariableUpdateCommandStep1

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

public GloballyScopedClusterVariableUpdateCommandStep1 metadata(Map<String,Object> metadata)

Description copied from interface: GloballyScopedClusterVariableUpdateCommandStep1

Sets the metadata bag of the cluster variable (optional). Values must be strings or numbers.

Specified by:

metadata in interface GloballyScopedClusterVariableUpdateCommandStep1

Parameters:

metadata - a map of metadata key to value

Returns:

this builder for method chaining

requestTimeout

public GloballyScopedClusterVariableUpdateCommandStep1 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<UpdateClusterVariableResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<UpdateClusterVariableResponse> 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<UpdateClusterVariableResponse>

Returns:

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