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

Class ImmutableProcessEventRecordValue.Builder

java.lang.Object

io.camunda.zeebe.protocol.record.value.ImmutableProcessEventRecordValue.Builder

Enclosing class:

ImmutableProcessEventRecordValue

@NotThreadSafe
public static final class ImmutableProcessEventRecordValue.Builder
extends Object

Builds instances of type ImmutableProcessEventRecordValue. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableProcessEventRecordValue	build()	Builds a new ImmutableProcessEventRecordValue.
ImmutableProcessEventRecordValue.Builder	clear()	Clear the builder to the initial state.
final ImmutableProcessEventRecordValue.Builder	from(RecordValueWithVariables instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.RecordValueWithVariables instance.
final ImmutableProcessEventRecordValue.Builder	from(ProcessEventRecordValue instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.ProcessEventRecordValue instance.
final ImmutableProcessEventRecordValue.Builder	from(ProcessInstanceRelated instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.ProcessInstanceRelated instance.
final ImmutableProcessEventRecordValue.Builder	putAllVariables(Map<String,? extends Object> entries)	Put all mappings from the specified map as entries to variables map.
final ImmutableProcessEventRecordValue.Builder	putVariable(String key, Object value)	Put one entry to the variables map.
final ImmutableProcessEventRecordValue.Builder	putVariable(Map.Entry<String,? extends Object> entry)	Put one entry to the variables map.
final ImmutableProcessEventRecordValue.Builder	withProcessDefinitionKey(long processDefinitionKey)	Initializes the value for the processDefinitionKey attribute.
final ImmutableProcessEventRecordValue.Builder	withProcessInstanceKey(long processInstanceKey)	Initializes the value for the processInstanceKey attribute.
final ImmutableProcessEventRecordValue.Builder	withScopeKey(long scopeKey)	Initializes the value for the scopeKey attribute.
final ImmutableProcessEventRecordValue.Builder	withTargetElementId(String targetElementId)	Initializes the value for the targetElementId attribute.
final ImmutableProcessEventRecordValue.Builder	withVariables(Map<String,? extends Object> entries)	Sets or replaces all mappings from the specified map as entries for the variables map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public final ImmutableProcessEventRecordValue.Builder from(ProcessInstanceRelated instance)

Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.ProcessInstanceRelated instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableProcessEventRecordValue.Builder from(ProcessEventRecordValue instance)

Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.ProcessEventRecordValue instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableProcessEventRecordValue.Builder from(RecordValueWithVariables instance)

Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.RecordValueWithVariables instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

putVariable

public final ImmutableProcessEventRecordValue.Builder putVariable(@Nullable
 String key,
 @Nullable
 Object value)

Put one entry to the variables map.

Parameters:

key - The key in the variables map

value - The associated value in the variables map

Returns:

this builder for use in a chained invocation

putVariable

public final ImmutableProcessEventRecordValue.Builder putVariable(Map.Entry<String,? extends Object> entry)

Put one entry to the variables map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

withVariables

public final ImmutableProcessEventRecordValue.Builder withVariables(Map<String,? extends Object> entries)

Sets or replaces all mappings from the specified map as entries for the variables map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the variables map

Returns:

this builder for use in a chained invocation

putAllVariables

public final ImmutableProcessEventRecordValue.Builder putAllVariables(Map<String,? extends Object> entries)

Put all mappings from the specified map as entries to variables map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the variables map

Returns:

this builder for use in a chained invocation

withProcessInstanceKey

public final ImmutableProcessEventRecordValue.Builder withProcessInstanceKey(long processInstanceKey)

Initializes the value for the processInstanceKey attribute.

Parameters:

processInstanceKey - The value for processInstanceKey

Returns:

this builder for use in a chained invocation

withScopeKey

public final ImmutableProcessEventRecordValue.Builder withScopeKey(long scopeKey)

Initializes the value for the scopeKey attribute.

Parameters:

scopeKey - The value for scopeKey

Returns:

this builder for use in a chained invocation

withTargetElementId

public final ImmutableProcessEventRecordValue.Builder withTargetElementId(String targetElementId)

Initializes the value for the targetElementId attribute.

Parameters:

targetElementId - The value for targetElementId (can be null)

Returns:

this builder for use in a chained invocation

withProcessDefinitionKey

public final ImmutableProcessEventRecordValue.Builder withProcessDefinitionKey(long processDefinitionKey)

Initializes the value for the processDefinitionKey attribute.

Parameters:

processDefinitionKey - The value for processDefinitionKey

Returns:

this builder for use in a chained invocation

clear

public ImmutableProcessEventRecordValue.Builder clear()

Clear the builder to the initial state.

Returns:

this builder for use in a chained invocation

build

public ImmutableProcessEventRecordValue build()

Builds a new ImmutableProcessEventRecordValue.

Returns:

An immutable instance of ProcessEventRecordValue

Throws:

IllegalStateException - if any required attributes are missing