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

Class ImmutableCompensationSubscriptionRecordValue

java.lang.Object

io.camunda.zeebe.protocol.record.value.ImmutableCompensationSubscriptionRecordValue

All Implemented Interfaces:

JsonSerializable, RecordValue, CompensationSubscriptionRecordValue

public final class ImmutableCompensationSubscriptionRecordValue
extends Object
implements CompensationSubscriptionRecordValue

Immutable implementation of CompensationSubscriptionRecordValue.

Use the builder to create immutable instances: ImmutableCompensationSubscriptionRecordValue.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableCompensationSubscriptionRecordValue.Builder	Builds instances of type ImmutableCompensationSubscriptionRecordValue.

Method Summary

Modifier and Type	Method	Description
static ImmutableCompensationSubscriptionRecordValue.Builder	builder()	Creates a builder for ImmutableCompensationSubscriptionRecordValue.
static ImmutableCompensationSubscriptionRecordValue	copyOf(CompensationSubscriptionRecordValue instance)	Creates an immutable copy of a CompensationSubscriptionRecordValue value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableCompensationSubscriptionRecordValue that have equal attribute values.
String	getCompensableActivityId()
long	getCompensableActivityInstanceKey()
long	getCompensableActivityScopeKey()
String	getCompensationHandlerId()
long	getCompensationHandlerInstanceKey()
long	getProcessDefinitionKey()
long	getProcessInstanceKey()
String	getTenantId()
String	getThrowEventId()
long	getThrowEventInstanceKey()
Map<String,Object>	getVariables()
int	hashCode()	Returns a lazily computed hash code from attributes: tenantId, processInstanceKey, processDefinitionKey, compensableActivityId, throwEventId, throwEventInstanceKey, compensationHandlerId, compensationHandlerInstanceKey, compensableActivityScopeKey, compensableActivityInstanceKey, variables.
String	toString()	Prints the immutable value CompensationSubscriptionRecordValue with attribute values.
final ImmutableCompensationSubscriptionRecordValue	withCompensableActivityId(String value)	Copy the current immutable object by setting a value for the compensableActivityId attribute.
final ImmutableCompensationSubscriptionRecordValue	withCompensableActivityInstanceKey(long value)	Copy the current immutable object by setting a value for the compensableActivityInstanceKey attribute.
final ImmutableCompensationSubscriptionRecordValue	withCompensableActivityScopeKey(long value)	Copy the current immutable object by setting a value for the compensableActivityScopeKey attribute.
final ImmutableCompensationSubscriptionRecordValue	withCompensationHandlerId(String value)	Copy the current immutable object by setting a value for the compensationHandlerId attribute.
final ImmutableCompensationSubscriptionRecordValue	withCompensationHandlerInstanceKey(long value)	Copy the current immutable object by setting a value for the compensationHandlerInstanceKey attribute.
final ImmutableCompensationSubscriptionRecordValue	withProcessDefinitionKey(long value)	Copy the current immutable object by setting a value for the processDefinitionKey attribute.
final ImmutableCompensationSubscriptionRecordValue	withProcessInstanceKey(long value)	Copy the current immutable object by setting a value for the processInstanceKey attribute.
final ImmutableCompensationSubscriptionRecordValue	withTenantId(String value)	Copy the current immutable object by setting a value for the tenantId attribute.
final ImmutableCompensationSubscriptionRecordValue	withThrowEventId(String value)	Copy the current immutable object by setting a value for the throwEventId attribute.
final ImmutableCompensationSubscriptionRecordValue	withThrowEventInstanceKey(long value)	Copy the current immutable object by setting a value for the throwEventInstanceKey attribute.
final ImmutableCompensationSubscriptionRecordValue	withVariables(Map<String,? extends Object> entries)	Copy the current immutable object by replacing the variables map with the specified map.

Methods inherited from class java.lang.Object

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

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

toJson

Method Details

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface CompensationSubscriptionRecordValue

Returns:

the id of the tenant

getProcessInstanceKey

public long getProcessInstanceKey()

Specified by:

getProcessInstanceKey in interface CompensationSubscriptionRecordValue

Returns:

the key of the process instance

getProcessDefinitionKey

public long getProcessDefinitionKey()

Specified by:

getProcessDefinitionKey in interface CompensationSubscriptionRecordValue

Returns:

the key of the process definition

getCompensableActivityId

public String getCompensableActivityId()

Specified by:

getCompensableActivityId in interface CompensationSubscriptionRecordValue

Returns:

the element id of the activity with the compensation handler

getThrowEventId

public String getThrowEventId()

Specified by:

getThrowEventId in interface CompensationSubscriptionRecordValue

Returns:

the element id of compensation throw event

getThrowEventInstanceKey

public long getThrowEventInstanceKey()

Specified by:

getThrowEventInstanceKey in interface CompensationSubscriptionRecordValue

Returns:

the element instance key of compensation throw event

getCompensationHandlerId

public String getCompensationHandlerId()

Specified by:

getCompensationHandlerId in interface CompensationSubscriptionRecordValue

Returns:

the element id of the compensation handler

getCompensationHandlerInstanceKey

public long getCompensationHandlerInstanceKey()

Specified by:

getCompensationHandlerInstanceKey in interface CompensationSubscriptionRecordValue

Returns:

the instance key of the compensation handler

getCompensableActivityScopeKey

public long getCompensableActivityScopeKey()

Specified by:

getCompensableActivityScopeKey in interface CompensationSubscriptionRecordValue

Returns:

the instance key of the flow scope that contains the activity with the compensation handler

getCompensableActivityInstanceKey

public long getCompensableActivityInstanceKey()

Specified by:

getCompensableActivityInstanceKey in interface CompensationSubscriptionRecordValue

Returns:

the instance key of the activity with the compensation handler

getVariables

public Map<String,Object> getVariables()

Specified by:

getVariables in interface CompensationSubscriptionRecordValue

Returns:

the local variables of activity with compensation handler

withTenantId

public final ImmutableCompensationSubscriptionRecordValue withTenantId(String value)

Copy the current immutable object by setting a value for the tenantId attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for tenantId (can be null)

Returns:

A modified copy of the this object

withProcessInstanceKey

public final ImmutableCompensationSubscriptionRecordValue withProcessInstanceKey(long value)

Copy the current immutable object by setting a value for the processInstanceKey attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for processInstanceKey

Returns:

A modified copy of the this object

withProcessDefinitionKey

public final ImmutableCompensationSubscriptionRecordValue withProcessDefinitionKey(long value)

Copy the current immutable object by setting a value for the processDefinitionKey attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for processDefinitionKey

Returns:

A modified copy of the this object

withCompensableActivityId

public final ImmutableCompensationSubscriptionRecordValue withCompensableActivityId(String value)

Copy the current immutable object by setting a value for the compensableActivityId attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for compensableActivityId (can be null)

Returns:

A modified copy of the this object

withThrowEventId

public final ImmutableCompensationSubscriptionRecordValue withThrowEventId(String value)

Copy the current immutable object by setting a value for the throwEventId attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for throwEventId (can be null)

Returns:

A modified copy of the this object

withThrowEventInstanceKey

public final ImmutableCompensationSubscriptionRecordValue withThrowEventInstanceKey(long value)

Copy the current immutable object by setting a value for the throwEventInstanceKey attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for throwEventInstanceKey

Returns:

A modified copy of the this object

withCompensationHandlerId

public final ImmutableCompensationSubscriptionRecordValue withCompensationHandlerId(String value)

Copy the current immutable object by setting a value for the compensationHandlerId attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for compensationHandlerId (can be null)

Returns:

A modified copy of the this object

withCompensationHandlerInstanceKey

public final ImmutableCompensationSubscriptionRecordValue withCompensationHandlerInstanceKey(long value)

Copy the current immutable object by setting a value for the compensationHandlerInstanceKey attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for compensationHandlerInstanceKey

Returns:

A modified copy of the this object

withCompensableActivityScopeKey

public final ImmutableCompensationSubscriptionRecordValue withCompensableActivityScopeKey(long value)

Copy the current immutable object by setting a value for the compensableActivityScopeKey attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for compensableActivityScopeKey

Returns:

A modified copy of the this object

withCompensableActivityInstanceKey

public final ImmutableCompensationSubscriptionRecordValue withCompensableActivityInstanceKey(long value)

Copy the current immutable object by setting a value for the compensableActivityInstanceKey attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for compensableActivityInstanceKey

Returns:

A modified copy of the this object

withVariables

public final ImmutableCompensationSubscriptionRecordValue withVariables(Map<String,? extends Object> entries)

Copy the current immutable object by replacing the variables map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the variables map

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableCompensationSubscriptionRecordValue that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Returns a lazily computed hash code from attributes: tenantId, processInstanceKey, processDefinitionKey, compensableActivityId, throwEventId, throwEventInstanceKey, compensationHandlerId, compensationHandlerInstanceKey, compensableActivityScopeKey, compensableActivityInstanceKey, variables.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CompensationSubscriptionRecordValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableCompensationSubscriptionRecordValue copyOf(CompensationSubscriptionRecordValue instance)

Creates an immutable copy of a CompensationSubscriptionRecordValue value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable CompensationSubscriptionRecordValue instance

builder

public static ImmutableCompensationSubscriptionRecordValue.Builder builder()

Creates a builder for ImmutableCompensationSubscriptionRecordValue.

 ImmutableCompensationSubscriptionRecordValue.builder()
    .withTenantId(String | null) // nullable tenantId
    .withProcessInstanceKey(long) // optional processInstanceKey
    .withProcessDefinitionKey(long) // optional processDefinitionKey
    .withCompensableActivityId(String | null) // nullable compensableActivityId
    .withThrowEventId(String | null) // nullable throwEventId
    .withThrowEventInstanceKey(long) // optional throwEventInstanceKey
    .withCompensationHandlerId(String | null) // nullable compensationHandlerId
    .withCompensationHandlerInstanceKey(long) // optional compensationHandlerInstanceKey
    .withCompensableActivityScopeKey(long) // optional compensableActivityScopeKey
    .withCompensableActivityInstanceKey(long) // optional compensableActivityInstanceKey
    .putVariable|putAllVariables(String => Object) // variables mappings
    .build();
 

Returns:

A new ImmutableCompensationSubscriptionRecordValue builder