Package io.camunda.client.api.fetch

Interface GloballyScopedClusterVariableGetRequest

All Superinterfaces:

FinalCommandStep<ClusterVariable>

All Known Implementing Classes:

GloballyScopedClusterVariableGetRequestImpl

public interface GloballyScopedClusterVariableGetRequest
extends FinalCommandStep<ClusterVariable>

Represents a request to fetch a globally-scoped cluster variable by name.

Usage example:

   ClusterVariable response = camundaClient
       .newGloballyScopedClusterVariableGetRequest()
       .withName("myVariable")
       .send()
       .join();
 

Method Summary

Modifier and Type	Method	Description
GloballyScopedClusterVariableGetRequest	withName(String name)	Specifies the name of the cluster variable to fetch.

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

execute, requestTimeout, send

Method Details

withName

GloballyScopedClusterVariableGetRequest withName(String name)

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.

Parameters:

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

Returns:

this builder for method chaining