Package io.camunda.zeebe.protocol.record.value

Interface VariableRecordValue

All Superinterfaces:

JsonSerializable, ProcessInstanceRelated, RecordValue, TenantOwned

All Known Implementing Classes:

ImmutableVariableRecordValue

@Immutable
public interface VariableRecordValue
extends RecordValue, ProcessInstanceRelated, TenantOwned

Represents a variable related event.

See VariableIntent for intents.

Field Summary

Fields inherited from interface io.camunda.zeebe.protocol.record.value.TenantOwned

DEFAULT_TENANT_IDENTIFIER

Method Summary

Modifier and Type	Method	Description
String	getBpmnProcessId()
String	getName()
long	getProcessDefinitionKey()
long	getProcessInstanceKey()
long	getScopeKey()
String	getValue()

Methods inherited from interface io.camunda.zeebe.protocol.record.JsonSerializable

toJson

Methods inherited from interface io.camunda.zeebe.protocol.record.value.TenantOwned

getTenantId

Method Details

getName

String getName()

Returns:

the name of the variable.

getValue

String getValue()

Returns:

the value of the variable as JSON string.

getScopeKey

long getScopeKey()

Returns:

the key of the scope the variable belongs to.

getProcessInstanceKey

long getProcessInstanceKey()

Specified by:

getProcessInstanceKey in interface ProcessInstanceRelated

Returns:

the key of the process instance the variable belongs to

getProcessDefinitionKey

long getProcessDefinitionKey()

Returns:

the key of the process the variable belongs to

getBpmnProcessId

String getBpmnProcessId()

Returns:

the BPMN process id this process instance belongs to.