Package io.camunda.client.protocol.rest

Class VariableFilter

java.lang.Object

io.camunda.client.protocol.rest.VariableFilter

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

Variable filter request.

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
VariableFilter()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Boolean	getIsTruncated()	Whether the value is truncated or not.
StringFilterProperty	getName()	Name of the variable.
BasicStringFilterProperty	getProcessInstanceKey()	The key of the process instance of this variable.
BasicStringFilterProperty	getScopeKey()	The key of the scope of this variable.
String	getTenantId()	Tenant ID of this variable.
StringFilterProperty	getValue()	The value of the variable.
BasicStringFilterProperty	getVariableKey()	The key for this variable.
int	hashCode()
VariableFilter	isTruncated(Boolean isTruncated)
VariableFilter	name(StringFilterProperty name)
VariableFilter	processInstanceKey(BasicStringFilterProperty processInstanceKey)
VariableFilter	scopeKey(BasicStringFilterProperty scopeKey)
void	setIsTruncated(Boolean isTruncated)
void	setName(StringFilterProperty name)
void	setProcessInstanceKey(BasicStringFilterProperty processInstanceKey)
void	setScopeKey(BasicStringFilterProperty scopeKey)
void	setTenantId(String tenantId)
void	setValue(StringFilterProperty value)
void	setVariableKey(BasicStringFilterProperty variableKey)
VariableFilter	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.
VariableFilter	value(StringFilterProperty value)
VariableFilter	variableKey(BasicStringFilterProperty variableKey)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_IS_TRUNCATED

public static final String JSON_PROPERTY_IS_TRUNCATED

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

VariableFilter

public VariableFilter()

Method Details

name

public VariableFilter name(@Nullable
 StringFilterProperty name)

getName

@Nullable
public StringFilterProperty getName()

Name of the variable.

Returns:

name

setName

public void setName(@Nullable
 StringFilterProperty name)

value

public VariableFilter value(@Nullable
 StringFilterProperty value)

getValue

@Nullable
public StringFilterProperty getValue()

The value of the variable.

Returns:

value

setValue

public void setValue(@Nullable
 StringFilterProperty value)

tenantId

public VariableFilter tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

Tenant ID of this variable.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

isTruncated

public VariableFilter 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)

variableKey

public VariableFilter variableKey(@Nullable
 BasicStringFilterProperty variableKey)

getVariableKey

@Nullable
public BasicStringFilterProperty getVariableKey()

The key for this variable.

Returns:

variableKey

setVariableKey

public void setVariableKey(@Nullable
 BasicStringFilterProperty variableKey)

scopeKey

public VariableFilter scopeKey(@Nullable
 BasicStringFilterProperty scopeKey)

getScopeKey

@Nullable
public BasicStringFilterProperty getScopeKey()

The key of the scope of this variable.

Returns:

scopeKey

setScopeKey

public void setScopeKey(@Nullable
 BasicStringFilterProperty scopeKey)

processInstanceKey

public VariableFilter processInstanceKey(@Nullable
 BasicStringFilterProperty processInstanceKey)

getProcessInstanceKey

@Nullable
public BasicStringFilterProperty getProcessInstanceKey()

The key of the process instance of this variable.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 BasicStringFilterProperty 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