Package io.camunda.client.impl.fetch

Class GloballyScopedClusterVariableGetRequestImpl

java.lang.Object

io.camunda.client.impl.fetch.GloballyScopedClusterVariableGetRequestImpl

All Implemented Interfaces:

FinalCommandStep<ClusterVariable>, GloballyScopedClusterVariableGetRequest

public class GloballyScopedClusterVariableGetRequestImpl
extends Object
implements GloballyScopedClusterVariableGetRequest

Constructor Summary

Constructors

Constructor	Description
GloballyScopedClusterVariableGetRequestImpl(HttpClient httpClient)

Method Summary

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

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

GloballyScopedClusterVariableGetRequestImpl

public GloballyScopedClusterVariableGetRequestImpl(HttpClient httpClient)

Method Details

requestTimeout

public GloballyScopedClusterVariableGetRequest 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<ClusterVariable>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

withName

public GloballyScopedClusterVariableGetRequest withName(String name)

Description copied from interface: GloballyScopedClusterVariableGetRequest

Specifies the name of the cluster variable to fetch.

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

Specified by:

withName in interface GloballyScopedClusterVariableGetRequest

Parameters:

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

Returns:

this builder for method chaining