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

Class ImmutableProcessInstanceCreationRecordValue

java.lang.Object

io.camunda.zeebe.protocol.record.value.ImmutableProcessInstanceCreationRecordValue

All Implemented Interfaces:

JsonSerializable, RecordValue, RecordValueWithVariables, ProcessInstanceCreationRecordValue, ProcessInstanceRelated

@ParametersAreNonnullByDefault
@Immutable
public final class ImmutableProcessInstanceCreationRecordValue
extends Object
implements ProcessInstanceCreationRecordValue

Immutable implementation of ProcessInstanceCreationRecordValue.

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

Nested Class Summary

Nested Classes

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

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

ProcessInstanceCreationRecordValue.ProcessInstanceCreationStartInstructionValue

Method Summary

Modifier and Type	Method	Description
static ImmutableProcessInstanceCreationRecordValue.Builder	builder()	Creates a builder for ImmutableProcessInstanceCreationRecordValue.
static ImmutableProcessInstanceCreationRecordValue	copyOf(ProcessInstanceCreationRecordValue instance)	Creates an immutable copy of a ProcessInstanceCreationRecordValue value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableProcessInstanceCreationRecordValue that have equal attribute values.
String	getBpmnProcessId()
long	getProcessDefinitionKey()
long	getProcessInstanceKey()
List<ProcessInstanceCreationRecordValue.ProcessInstanceCreationStartInstructionValue>	getStartInstructions()	Returns a list of start instructions (if available), or an empty list.
Map<String,Object>	getVariables()
int	getVersion()
int	hashCode()	Returns a lazily computed hash code from attributes: variables, processInstanceKey, bpmnProcessId, version, processDefinitionKey, startInstructions.
String	toString()	Prints the immutable value ProcessInstanceCreationRecordValue with attribute values.
final ImmutableProcessInstanceCreationRecordValue	withBpmnProcessId(String value)	Copy the current immutable object by setting a value for the bpmnProcessId attribute.
final ImmutableProcessInstanceCreationRecordValue	withProcessDefinitionKey(long value)	Copy the current immutable object by setting a value for the processDefinitionKey attribute.
final ImmutableProcessInstanceCreationRecordValue	withProcessInstanceKey(long value)	Copy the current immutable object by setting a value for the processInstanceKey attribute.
final ImmutableProcessInstanceCreationRecordValue	withStartInstructions(ProcessInstanceCreationRecordValue.ProcessInstanceCreationStartInstructionValue... elements)	Copy the current immutable object with elements that replace the content of startInstructions.
final ImmutableProcessInstanceCreationRecordValue	withStartInstructions(Iterable<? extends ProcessInstanceCreationRecordValue.ProcessInstanceCreationStartInstructionValue> elements)	Copy the current immutable object with elements that replace the content of startInstructions.
final ImmutableProcessInstanceCreationRecordValue	withVariables(Map<String,? extends Object> entries)	Copy the current immutable object by replacing the variables map with the specified map.
final ImmutableProcessInstanceCreationRecordValue	withVersion(int value)	Copy the current immutable object by setting a value for the version attribute.

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

getVariables

public Map<String,Object> getVariables()

Specified by:

getVariables in interface RecordValueWithVariables

Returns:

the variables of this record. Can be empty.

getProcessInstanceKey

public long getProcessInstanceKey()

Specified by:

getProcessInstanceKey in interface ProcessInstanceRelated

Returns:

the key of the corresponding process instance

getBpmnProcessId

public String getBpmnProcessId()

Specified by:

getBpmnProcessId in interface ProcessInstanceCreationRecordValue

Returns:

the BPMN process id to create a process from

getVersion

public int getVersion()

Specified by:

getVersion in interface ProcessInstanceCreationRecordValue

Returns:

the version of the BPMN process to create a process from

getProcessDefinitionKey

public long getProcessDefinitionKey()

Specified by:

getProcessDefinitionKey in interface ProcessInstanceCreationRecordValue

Returns:

the unique key of the BPMN process definition to create a process from

getStartInstructions

public List<ProcessInstanceCreationRecordValue.ProcessInstanceCreationStartInstructionValue> getStartInstructions()

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

Specified by:

getStartInstructions in interface ProcessInstanceCreationRecordValue

withVariables

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

withProcessInstanceKey

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

withBpmnProcessId

public final ImmutableProcessInstanceCreationRecordValue withBpmnProcessId(String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withVersion

public final ImmutableProcessInstanceCreationRecordValue withVersion(int value)

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

Parameters:

value - A new value for version

Returns:

A modified copy of the this object

withProcessDefinitionKey

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

withStartInstructions

public final ImmutableProcessInstanceCreationRecordValue withStartInstructions(ProcessInstanceCreationRecordValue.ProcessInstanceCreationStartInstructionValue... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withStartInstructions

public final ImmutableProcessInstanceCreationRecordValue withStartInstructions(Iterable<? extends ProcessInstanceCreationRecordValue.ProcessInstanceCreationStartInstructionValue> elements)

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

Parameters:

elements - An iterable of startInstructions elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
 Object another)

This instance is equal to all instances of ImmutableProcessInstanceCreationRecordValue 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: variables, processInstanceKey, bpmnProcessId, version, processDefinitionKey, startInstructions.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ProcessInstanceCreationRecordValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableProcessInstanceCreationRecordValue copyOf(ProcessInstanceCreationRecordValue instance)

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

builder

public static ImmutableProcessInstanceCreationRecordValue.Builder builder()

Creates a builder for ImmutableProcessInstanceCreationRecordValue.

 ImmutableProcessInstanceCreationRecordValue.builder()
    .putVariable|putAllVariables(String => Object) // variables mappings
    .withProcessInstanceKey(long) // optional processInstanceKey
    .withBpmnProcessId(String | null) // nullable bpmnProcessId
    .withVersion(int) // optional version
    .withProcessDefinitionKey(long) // optional processDefinitionKey
    .addStartInstruction|addAllStartInstructions(io.camunda.zeebe.protocol.record.value.ProcessInstanceCreationRecordValue.ProcessInstanceCreationStartInstructionValue) // startInstructions elements
    .build();
 

Returns:

A new ImmutableProcessInstanceCreationRecordValue builder