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

Class ImmutableProcessMessageSubscriptionRecordValue

java.lang.Object

io.camunda.zeebe.protocol.record.value.ImmutableProcessMessageSubscriptionRecordValue

All Implemented Interfaces:

JsonSerializable, RecordValue, RecordValueWithVariables, ProcessInstanceRelated, ProcessMessageSubscriptionRecordValue

@ParametersAreNonnullByDefault
@Immutable
public final class ImmutableProcessMessageSubscriptionRecordValue
extends Object
implements ProcessMessageSubscriptionRecordValue

Immutable implementation of ProcessMessageSubscriptionRecordValue.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableProcessMessageSubscriptionRecordValue.Builder	builder()	Creates a builder for ImmutableProcessMessageSubscriptionRecordValue.
static ImmutableProcessMessageSubscriptionRecordValue	copyOf(ProcessMessageSubscriptionRecordValue instance)	Creates an immutable copy of a ProcessMessageSubscriptionRecordValue value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableProcessMessageSubscriptionRecordValue that have equal attribute values.
String	getBpmnProcessId()
String	getCorrelationKey()
String	getElementId()
long	getElementInstanceKey()
long	getMessageKey()
String	getMessageName()
long	getProcessInstanceKey()
Map<String,Object>	getVariables()
int	hashCode()	Returns a lazily computed hash code from attributes: variables, processInstanceKey, elementInstanceKey, bpmnProcessId, messageKey, messageName, correlationKey, elementId, interrupting.
boolean	isInterrupting()
String	toString()	Prints the immutable value ProcessMessageSubscriptionRecordValue with attribute values.
final ImmutableProcessMessageSubscriptionRecordValue	withBpmnProcessId(String value)	Copy the current immutable object by setting a value for the bpmnProcessId attribute.
final ImmutableProcessMessageSubscriptionRecordValue	withCorrelationKey(String value)	Copy the current immutable object by setting a value for the correlationKey attribute.
final ImmutableProcessMessageSubscriptionRecordValue	withElementId(String value)	Copy the current immutable object by setting a value for the elementId attribute.
final ImmutableProcessMessageSubscriptionRecordValue	withElementInstanceKey(long value)	Copy the current immutable object by setting a value for the elementInstanceKey attribute.
final ImmutableProcessMessageSubscriptionRecordValue	withInterrupting(boolean value)	Copy the current immutable object by setting a value for the interrupting attribute.
final ImmutableProcessMessageSubscriptionRecordValue	withMessageKey(long value)	Copy the current immutable object by setting a value for the messageKey attribute.
final ImmutableProcessMessageSubscriptionRecordValue	withMessageName(String value)	Copy the current immutable object by setting a value for the messageName attribute.
final ImmutableProcessMessageSubscriptionRecordValue	withProcessInstanceKey(long value)	Copy the current immutable object by setting a value for the processInstanceKey attribute.
final ImmutableProcessMessageSubscriptionRecordValue	withVariables(Map<String,? extends Object> entries)	Copy the current immutable object by replacing the variables map with the specified map.

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

Specified by:

getProcessInstanceKey in interface ProcessMessageSubscriptionRecordValue

Returns:

the process instance key

getElementInstanceKey

public long getElementInstanceKey()

Specified by:

getElementInstanceKey in interface ProcessMessageSubscriptionRecordValue

Returns:

the element instance key

getBpmnProcessId

public String getBpmnProcessId()

Specified by:

getBpmnProcessId in interface ProcessMessageSubscriptionRecordValue

Returns:

the BPMN process id

getMessageKey

public long getMessageKey()

Specified by:

getMessageKey in interface ProcessMessageSubscriptionRecordValue

Returns:

the key of the correlated message

getMessageName

public String getMessageName()

Specified by:

getMessageName in interface ProcessMessageSubscriptionRecordValue

Returns:

the message name

getCorrelationKey

public String getCorrelationKey()

Specified by:

getCorrelationKey in interface ProcessMessageSubscriptionRecordValue

Returns:

the correlation key

getElementId

public String getElementId()

Specified by:

getElementId in interface ProcessMessageSubscriptionRecordValue

Returns:

the id of the element tied to the subscription.

isInterrupting

public boolean isInterrupting()

Specified by:

isInterrupting in interface ProcessMessageSubscriptionRecordValue

Returns:

true if the event tied to the subscription is interrupting. Otherwise, it returns false if the event is non-interrupting.

withVariables

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

withElementInstanceKey

public final ImmutableProcessMessageSubscriptionRecordValue withElementInstanceKey(long value)

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

Parameters:

value - A new value for elementInstanceKey

Returns:

A modified copy of the this object

withBpmnProcessId

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

withMessageKey

public final ImmutableProcessMessageSubscriptionRecordValue withMessageKey(long value)

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

Parameters:

value - A new value for messageKey

Returns:

A modified copy of the this object

withMessageName

public final ImmutableProcessMessageSubscriptionRecordValue withMessageName(String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withCorrelationKey

public final ImmutableProcessMessageSubscriptionRecordValue withCorrelationKey(String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withElementId

public final ImmutableProcessMessageSubscriptionRecordValue withElementId(String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withInterrupting

public final ImmutableProcessMessageSubscriptionRecordValue withInterrupting(boolean value)

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

Parameters:

value - A new value for interrupting

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
 Object another)

This instance is equal to all instances of ImmutableProcessMessageSubscriptionRecordValue 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, elementInstanceKey, bpmnProcessId, messageKey, messageName, correlationKey, elementId, interrupting.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ProcessMessageSubscriptionRecordValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableProcessMessageSubscriptionRecordValue copyOf(ProcessMessageSubscriptionRecordValue instance)

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

builder

public static ImmutableProcessMessageSubscriptionRecordValue.Builder builder()

Creates a builder for ImmutableProcessMessageSubscriptionRecordValue.

 ImmutableProcessMessageSubscriptionRecordValue.builder()
    .putVariable|putAllVariables(String => Object) // variables mappings
    .withProcessInstanceKey(long) // optional processInstanceKey
    .withElementInstanceKey(long) // optional elementInstanceKey
    .withBpmnProcessId(String | null) // nullable bpmnProcessId
    .withMessageKey(long) // optional messageKey
    .withMessageName(String | null) // nullable messageName
    .withCorrelationKey(String | null) // nullable correlationKey
    .withElementId(String | null) // nullable elementId
    .withInterrupting(boolean) // optional interrupting
    .build();
 

Returns:

A new ImmutableProcessMessageSubscriptionRecordValue builder