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

Class ImmutableProcessInstanceModificationRecordValue

java.lang.Object

io.camunda.zeebe.protocol.record.value.ImmutableProcessInstanceModificationRecordValue

All Implemented Interfaces:

JsonSerializable, RecordValue, ProcessInstanceModificationRecordValue, ProcessInstanceRelated, TenantOwned

public final class ImmutableProcessInstanceModificationRecordValue
extends Object
implements ProcessInstanceModificationRecordValue

Immutable implementation of ProcessInstanceModificationRecordValue.

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface io.camunda.zeebe.protocol.record.value.ProcessInstanceModificationRecordValue

ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue, ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue, ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue

Field Summary

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

DEFAULT_TENANT_IDENTIFIER

Method Summary

Modifier and Type	Method	Description
static ImmutableProcessInstanceModificationRecordValue.Builder	builder()	Creates a builder for ImmutableProcessInstanceModificationRecordValue.
static ImmutableProcessInstanceModificationRecordValue	copyOf(ProcessInstanceModificationRecordValue instance)	Creates an immutable copy of a ProcessInstanceModificationRecordValue value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableProcessInstanceModificationRecordValue that have equal attribute values.
List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue>	getActivateInstructions()	Returns a list of activate instructions (if available), or an empty list.
Set<Long>	getAncestorScopeKeys()	Deprecated. since 8.1.3, replaced by ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue.getAncestorScopeKeys()
long	getProcessInstanceKey()
String	getTenantId()	Returns the identifier of the tenant that owns this entity.
List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue>	getTerminateInstructions()	Returns a list of terminate instructions (if available), or an empty list.
int	hashCode()	Returns a lazily computed hash code from attributes: processInstanceKey, tenantId, terminateInstructions, activateInstructions, ancestorScopeKeys.
String	toString()	Prints the immutable value ProcessInstanceModificationRecordValue with attribute values.
final ImmutableProcessInstanceModificationRecordValue	withActivateInstructions(ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue... elements)	Copy the current immutable object with elements that replace the content of activateInstructions.
final ImmutableProcessInstanceModificationRecordValue	withActivateInstructions(Iterable<? extends ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue> elements)	Copy the current immutable object with elements that replace the content of activateInstructions.
final ImmutableProcessInstanceModificationRecordValue	withAncestorScopeKeys(Iterable<? extends Long> elements)	Deprecated.
final ImmutableProcessInstanceModificationRecordValue	withAncestorScopeKeys(Long... elements)	Deprecated.
final ImmutableProcessInstanceModificationRecordValue	withProcessInstanceKey(long value)	Copy the current immutable object by setting a value for the processInstanceKey attribute.
final ImmutableProcessInstanceModificationRecordValue	withTenantId(String value)	Copy the current immutable object by setting a value for the tenantId attribute.
final ImmutableProcessInstanceModificationRecordValue	withTerminateInstructions(ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue... elements)	Copy the current immutable object with elements that replace the content of terminateInstructions.
final ImmutableProcessInstanceModificationRecordValue	withTerminateInstructions(Iterable<? extends ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue> elements)	Copy the current immutable object with elements that replace the content of terminateInstructions.

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

getProcessInstanceKey

public long getProcessInstanceKey()

Specified by:

getProcessInstanceKey in interface ProcessInstanceRelated

Returns:

the key of the corresponding process instance

getTenantId

public String getTenantId()

Returns the identifier of the tenant that owns this entity.

Specified by:

getTenantId in interface TenantOwned

getTerminateInstructions

public List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue> getTerminateInstructions()

Returns a list of terminate instructions (if available), or an empty list.

Specified by:

getTerminateInstructions in interface ProcessInstanceModificationRecordValue

getActivateInstructions

public List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue> getActivateInstructions()

Returns a list of activate instructions (if available), or an empty list.

Specified by:

getActivateInstructions in interface ProcessInstanceModificationRecordValue

getAncestorScopeKeys

@Deprecated
public Set<Long> getAncestorScopeKeys()

Deprecated.

since 8.1.3, replaced by ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue.getAncestorScopeKeys()

Returns a list of all ancestor keys of all activate instructions. The property is set in the event only after the modification is applied.

Specified by:

getAncestorScopeKeys in interface ProcessInstanceModificationRecordValue

withProcessInstanceKey

public final ImmutableProcessInstanceModificationRecordValue 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

withTenantId

public final ImmutableProcessInstanceModificationRecordValue 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

withTerminateInstructions

public final ImmutableProcessInstanceModificationRecordValue withTerminateInstructions(ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue... elements)

Copy the current immutable object with elements that replace the content of terminateInstructions.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withTerminateInstructions

public final ImmutableProcessInstanceModificationRecordValue withTerminateInstructions(Iterable<? extends ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue> elements)

Copy the current immutable object with elements that replace the content of terminateInstructions. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of terminateInstructions elements to set

Returns:

A modified copy of this object

withActivateInstructions

public final ImmutableProcessInstanceModificationRecordValue withActivateInstructions(ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue... elements)

Copy the current immutable object with elements that replace the content of activateInstructions.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withActivateInstructions

public final ImmutableProcessInstanceModificationRecordValue withActivateInstructions(Iterable<? extends ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue> elements)

Copy the current immutable object with elements that replace the content of activateInstructions. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of activateInstructions elements to set

Returns:

A modified copy of this object

withAncestorScopeKeys

@Deprecated
public final ImmutableProcessInstanceModificationRecordValue withAncestorScopeKeys(Long... elements)

Deprecated.

Copy the current immutable object with elements that replace the content of ancestorScopeKeys.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withAncestorScopeKeys

@Deprecated
public final ImmutableProcessInstanceModificationRecordValue withAncestorScopeKeys(Iterable<? extends Long> elements)

Deprecated.

Copy the current immutable object with elements that replace the content of ancestorScopeKeys. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of ancestorScopeKeys elements to set

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableProcessInstanceModificationRecordValue 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: processInstanceKey, tenantId, terminateInstructions, activateInstructions, ancestorScopeKeys.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ProcessInstanceModificationRecordValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableProcessInstanceModificationRecordValue copyOf(ProcessInstanceModificationRecordValue instance)

Creates an immutable copy of a ProcessInstanceModificationRecordValue 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 ProcessInstanceModificationRecordValue instance

builder

public static ImmutableProcessInstanceModificationRecordValue.Builder builder()

Creates a builder for ImmutableProcessInstanceModificationRecordValue.

 ImmutableProcessInstanceModificationRecordValue.builder()
    .withProcessInstanceKey(long) // optional processInstanceKey
    .withTenantId(String | null) // nullable tenantId
    .addTerminateInstruction|addAllTerminateInstructions(io.camunda.zeebe.protocol.record.value.ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue) // terminateInstructions elements
    .addActivateInstruction|addAllActivateInstructions(io.camunda.zeebe.protocol.record.value.ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue) // activateInstructions elements
    .addAncestorScopeKey|addAllAncestorScopeKeys(Long) // ancestorScopeKeys elements
    .build();
 

Returns:

A new ImmutableProcessInstanceModificationRecordValue builder