Package io.camunda.client.impl.command

Class TenantScopedCreateClusterVariableImpl

java.lang.Object

io.camunda.client.impl.command.TenantScopedCreateClusterVariableImpl

All Implemented Interfaces:

FinalCommandStep<CreateClusterVariableResponse>, TenantScopedClusterVariableCreationCommandStep1

public class TenantScopedCreateClusterVariableImpl
extends Object
implements TenantScopedClusterVariableCreationCommandStep1

Constructor Summary

Constructors

Constructor	Description
TenantScopedCreateClusterVariableImpl(HttpClient httpClient, JsonMapper jsonMapper, String tenantId)

Method Summary

Modifier and Type	Method	Description
TenantScopedClusterVariableCreationCommandStep1	create(String name, Object value)	Sets the name and value of the cluster variable.
TenantScopedClusterVariableCreationCommandStep1	kind(ClusterVariableKind kind)	Sets the kind of the cluster variable (optional, defaults to JSON).
TenantScopedClusterVariableCreationCommandStep1	metadata(Map<String,Object> metadata)	Sets the metadata bag of the cluster variable (optional).
TenantScopedClusterVariableCreationCommandStep1	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<CreateClusterVariableResponse>	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

TenantScopedCreateClusterVariableImpl

public TenantScopedCreateClusterVariableImpl(HttpClient httpClient,
 JsonMapper jsonMapper,
 String tenantId)

Method Details

create

public TenantScopedClusterVariableCreationCommandStep1 create(String name,
 Object value)

Description copied from interface: TenantScopedClusterVariableCreationCommandStep1

Sets the name and value of the cluster variable.

The variable value will be serialized to JSON format.

   camundaClient
       .newTenantScopedClusterVariableCreateRequest("my-tenant-id")
       .create("myVariable", "myValue")  // for string values
       .send();
 

Specified by:

create in interface TenantScopedClusterVariableCreationCommandStep1

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

public TenantScopedClusterVariableCreationCommandStep1 kind(ClusterVariableKind kind)

Description copied from interface: TenantScopedClusterVariableCreationCommandStep1

Sets the kind of the cluster variable (optional, defaults to JSON).

Specified by:

kind in interface TenantScopedClusterVariableCreationCommandStep1

Parameters:

kind - the kind (JSON or SECRET_REFERENCE)

Returns:

this builder for method chaining

metadata

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

Description copied from interface: TenantScopedClusterVariableCreationCommandStep1

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

Specified by:

metadata in interface TenantScopedClusterVariableCreationCommandStep1

Parameters:

metadata - a map of metadata key to value

Returns:

this builder for method chaining

requestTimeout

public TenantScopedClusterVariableCreationCommandStep1 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<CreateClusterVariableResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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