Package io.camunda.client.protocol.rest

Class VariableSearchResult

java.lang.Object

io.camunda.client.protocol.rest.VariableSearchResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-06-04T12:01:10.435788262Z[GMT]",
           comments="Generator version: 7.12.0")
public class VariableSearchResult
extends Object

Variable search response item.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_IS_TRUNCATED
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_SCOPE_KEY
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_VALUE
static final String	JSON_PROPERTY_VARIABLE_KEY

Constructor Summary

Constructors

Constructor	Description
VariableSearchResult()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Boolean	getIsTruncated()	Whether the value is truncated or not.
String	getName()	Name of this variable.
String	getProcessInstanceKey()	The key of the process instance of this variable.
String	getScopeKey()	The key of the scope of this variable.
String	getTenantId()	Tenant ID of this variable.
String	getValue()	Value of this variable.
String	getVariableKey()	The key for this variable.
int	hashCode()
VariableSearchResult	isTruncated(Boolean isTruncated)
VariableSearchResult	name(String name)
VariableSearchResult	processInstanceKey(String processInstanceKey)
VariableSearchResult	scopeKey(String scopeKey)
void	setIsTruncated(Boolean isTruncated)
void	setName(String name)
void	setProcessInstanceKey(String processInstanceKey)
void	setScopeKey(String scopeKey)
void	setTenantId(String tenantId)
void	setValue(String value)
void	setVariableKey(String variableKey)
VariableSearchResult	tenantId(String tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
VariableSearchResult	value(String value)
VariableSearchResult	variableKey(String variableKey)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

• Constant Field Values

JSON_PROPERTY_IS_TRUNCATED

public static final String JSON_PROPERTY_IS_TRUNCATED

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLE_KEY

public static final String JSON_PROPERTY_VARIABLE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_SCOPE_KEY

public static final String JSON_PROPERTY_SCOPE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

Constructor Details

VariableSearchResult

public VariableSearchResult()

Method Details

value

public VariableSearchResult value(@Nullable
 String value)

getValue

@Nullable
public String getValue()

Value of this variable. Can be truncated.

Returns:

value

setValue

public void setValue(@Nullable
 String value)

isTruncated

public VariableSearchResult isTruncated(@Nullable
 Boolean isTruncated)

getIsTruncated

@Nullable
public Boolean getIsTruncated()

Whether the value is truncated or not.

Returns:

isTruncated

setIsTruncated

public void setIsTruncated(@Nullable
 Boolean isTruncated)

name

public VariableSearchResult name(@Nullable
 String name)

getName

@Nullable
public String getName()

Name of this variable.

Returns:

name

setName

public void setName(@Nullable
 String name)

tenantId

public VariableSearchResult tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

Tenant ID of this variable.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

variableKey

public VariableSearchResult variableKey(@Nullable
 String variableKey)

getVariableKey

@Nullable
public String getVariableKey()

The key for this variable.

Returns:

variableKey

setVariableKey

public void setVariableKey(@Nullable
 String variableKey)

scopeKey

public VariableSearchResult scopeKey(@Nullable
 String scopeKey)

getScopeKey

@Nullable
public String getScopeKey()

The key of the scope of this variable.

Returns:

scopeKey

setScopeKey

public void setScopeKey(@Nullable
 String scopeKey)

processInstanceKey

public VariableSearchResult processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The key of the process instance of this variable.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string