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

Class ImmutableProcessInstanceResultRecordValue.Builder

java.lang.Object

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

Enclosing class:

ImmutableProcessInstanceResultRecordValue

@NotThreadSafe
public static final class ImmutableProcessInstanceResultRecordValue.Builder
extends Object

Builds instances of type ImmutableProcessInstanceResultRecordValue. 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
ImmutableProcessInstanceResultRecordValue	build()	Builds a new ImmutableProcessInstanceResultRecordValue.
ImmutableProcessInstanceResultRecordValue.Builder	clear()	Clear the builder to the initial state.
final ImmutableProcessInstanceResultRecordValue.Builder	from(RecordValueWithVariables instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.RecordValueWithVariables instance.
final ImmutableProcessInstanceResultRecordValue.Builder	from(ProcessInstanceRelated instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.ProcessInstanceRelated instance.
final ImmutableProcessInstanceResultRecordValue.Builder	from(ProcessInstanceResultRecordValue instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.ProcessInstanceResultRecordValue instance.
final ImmutableProcessInstanceResultRecordValue.Builder	putAllVariables(Map<String,? extends Object> entries)	Put all mappings from the specified map as entries to variables map.
final ImmutableProcessInstanceResultRecordValue.Builder	putVariable(String key, Object value)	Put one entry to the variables map.
final ImmutableProcessInstanceResultRecordValue.Builder	putVariable(Map.Entry<String,? extends Object> entry)	Put one entry to the variables map.
final ImmutableProcessInstanceResultRecordValue.Builder	withBpmnProcessId(String bpmnProcessId)	Initializes the value for the bpmnProcessId attribute.
final ImmutableProcessInstanceResultRecordValue.Builder	withProcessDefinitionKey(long processDefinitionKey)	Initializes the value for the processDefinitionKey attribute.
final ImmutableProcessInstanceResultRecordValue.Builder	withProcessInstanceKey(long processInstanceKey)	Initializes the value for the processInstanceKey attribute.
final ImmutableProcessInstanceResultRecordValue.Builder	withVariables(Map<String,? extends Object> entries)	Sets or replaces all mappings from the specified map as entries for the variables map.
final ImmutableProcessInstanceResultRecordValue.Builder	withVersion(int version)	Initializes the value for the version attribute.

Methods inherited from class java.lang.Object

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

Method Details

from

public final ImmutableProcessInstanceResultRecordValue.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 ImmutableProcessInstanceResultRecordValue.Builder from(ProcessInstanceResultRecordValue instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableProcessInstanceResultRecordValue.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 ImmutableProcessInstanceResultRecordValue.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 ImmutableProcessInstanceResultRecordValue.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 ImmutableProcessInstanceResultRecordValue.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 ImmutableProcessInstanceResultRecordValue.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

withBpmnProcessId

public final ImmutableProcessInstanceResultRecordValue.Builder withBpmnProcessId(String bpmnProcessId)

Initializes the value for the bpmnProcessId attribute.

Parameters:

bpmnProcessId - The value for bpmnProcessId (can be null)

Returns:

this builder for use in a chained invocation

withVersion

public final ImmutableProcessInstanceResultRecordValue.Builder withVersion(int version)

Initializes the value for the version attribute.

Parameters:

version - The value for version

Returns:

this builder for use in a chained invocation

withProcessDefinitionKey

public final ImmutableProcessInstanceResultRecordValue.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

withProcessInstanceKey

public final ImmutableProcessInstanceResultRecordValue.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

clear

public ImmutableProcessInstanceResultRecordValue.Builder clear()

Clear the builder to the initial state.

Returns:

this builder for use in a chained invocation

build

public ImmutableProcessInstanceResultRecordValue build()

Builds a new ImmutableProcessInstanceResultRecordValue.

Returns:

An immutable instance of ProcessInstanceResultRecordValue

Throws:

IllegalStateException - if any required attributes are missing