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

Class ImmutableMessageCorrelationRecordValue.Builder

java.lang.Object

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

Enclosing class:

ImmutableMessageCorrelationRecordValue

public static final class ImmutableMessageCorrelationRecordValue.Builder
extends Object

Builds instances of type ImmutableMessageCorrelationRecordValue. 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
ImmutableMessageCorrelationRecordValue	build()	Builds a new ImmutableMessageCorrelationRecordValue.
ImmutableMessageCorrelationRecordValue.Builder	clear()	Clear the builder to the initial state.
final ImmutableMessageCorrelationRecordValue.Builder	from(RecordValueWithVariables instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.RecordValueWithVariables instance.
final ImmutableMessageCorrelationRecordValue.Builder	from(MessageCorrelationRecordValue instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.MessageCorrelationRecordValue instance.
final ImmutableMessageCorrelationRecordValue.Builder	from(ProcessInstanceRelated instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.ProcessInstanceRelated instance.
final ImmutableMessageCorrelationRecordValue.Builder	from(TenantOwned instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.TenantOwned instance.
final ImmutableMessageCorrelationRecordValue.Builder	putAllVariables(Map<String,? extends Object> entries)	Put all mappings from the specified map as entries to variables map.
final ImmutableMessageCorrelationRecordValue.Builder	putVariable(String key, Object value)	Put one entry to the variables map.
final ImmutableMessageCorrelationRecordValue.Builder	putVariable(Map.Entry<String,? extends Object> entry)	Put one entry to the variables map.
final ImmutableMessageCorrelationRecordValue.Builder	withCorrelationKey(String correlationKey)	Initializes the value for the correlationKey attribute.
final ImmutableMessageCorrelationRecordValue.Builder	withMessageKey(long messageKey)	Initializes the value for the messageKey attribute.
final ImmutableMessageCorrelationRecordValue.Builder	withName(String name)	Initializes the value for the name attribute.
final ImmutableMessageCorrelationRecordValue.Builder	withProcessInstanceKey(long processInstanceKey)	Initializes the value for the processInstanceKey attribute.
final ImmutableMessageCorrelationRecordValue.Builder	withRequestId(long requestId)	Initializes the value for the requestId attribute.
final ImmutableMessageCorrelationRecordValue.Builder	withRequestStreamId(int requestStreamId)	Initializes the value for the requestStreamId attribute.
final ImmutableMessageCorrelationRecordValue.Builder	withTenantId(String tenantId)	Initializes the value for the tenantId attribute.
final ImmutableMessageCorrelationRecordValue.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 ImmutableMessageCorrelationRecordValue.Builder from(MessageCorrelationRecordValue instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

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

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableMessageCorrelationRecordValue.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 ImmutableMessageCorrelationRecordValue.Builder putVariable(String key,
 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 ImmutableMessageCorrelationRecordValue.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 ImmutableMessageCorrelationRecordValue.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 ImmutableMessageCorrelationRecordValue.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

withTenantId

public final ImmutableMessageCorrelationRecordValue.Builder withTenantId(String tenantId)

Initializes the value for the tenantId attribute.

Parameters:

tenantId - The value for tenantId (can be null)

Returns:

this builder for use in a chained invocation

withProcessInstanceKey

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

withName

public final ImmutableMessageCorrelationRecordValue.Builder withName(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name (can be null)

Returns:

this builder for use in a chained invocation

withCorrelationKey

public final ImmutableMessageCorrelationRecordValue.Builder withCorrelationKey(String correlationKey)

Initializes the value for the correlationKey attribute.

Parameters:

correlationKey - The value for correlationKey (can be null)

Returns:

this builder for use in a chained invocation

withMessageKey

public final ImmutableMessageCorrelationRecordValue.Builder withMessageKey(long messageKey)

Initializes the value for the messageKey attribute.

Parameters:

messageKey - The value for messageKey

Returns:

this builder for use in a chained invocation

withRequestId

public final ImmutableMessageCorrelationRecordValue.Builder withRequestId(long requestId)

Initializes the value for the requestId attribute.

Parameters:

requestId - The value for requestId

Returns:

this builder for use in a chained invocation

withRequestStreamId

public final ImmutableMessageCorrelationRecordValue.Builder withRequestStreamId(int requestStreamId)

Initializes the value for the requestStreamId attribute.

Parameters:

requestStreamId - The value for requestStreamId

Returns:

this builder for use in a chained invocation

clear

public ImmutableMessageCorrelationRecordValue.Builder clear()

Clear the builder to the initial state.

Returns:

this builder for use in a chained invocation

build

public ImmutableMessageCorrelationRecordValue build()

Builds a new ImmutableMessageCorrelationRecordValue.

Returns:

An immutable instance of MessageCorrelationRecordValue

Throws:

IllegalStateException - if any required attributes are missing