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

Class ImmutableSignalSubscriptionRecordValue

java.lang.Object
io.camunda.zeebe.protocol.record.value.ImmutableSignalSubscriptionRecordValue
All Implemented Interfaces:
JsonSerializable, RecordValue, SignalSubscriptionRecordValue
@ParametersAreNonnullByDefault @Immutable public final class ImmutableSignalSubscriptionRecordValue extends Object implements SignalSubscriptionRecordValue
Immutable implementation of SignalSubscriptionRecordValue.

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

  • Method Details

    • getProcessDefinitionKey

      public long getProcessDefinitionKey()
      Specified by:
      getProcessDefinitionKey in interface SignalSubscriptionRecordValue
      Returns:
      the process key tied to the subscription

    • getBpmnProcessId

      public String getBpmnProcessId()
      Specified by:
      getBpmnProcessId in interface SignalSubscriptionRecordValue
      Returns:
      the BPMN process id tied to the subscription

    • getCatchEventId

      public String getCatchEventId()
      Specified by:
      getCatchEventId in interface SignalSubscriptionRecordValue
      Returns:
      the id of the catch event tied to the subscription

    • getCatchEventInstanceKey

      public long getCatchEventInstanceKey()
      Specified by:
      getCatchEventInstanceKey in interface SignalSubscriptionRecordValue
      Returns:
      the key of the catch event instance key tied to the subscription

    • getSignalName

      public String getSignalName()
      Specified by:
      getSignalName in interface SignalSubscriptionRecordValue
      Returns:
      the name of the signal

    • withProcessDefinitionKey

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

    • withBpmnProcessId

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

    • withCatchEventId

      public final ImmutableSignalSubscriptionRecordValue withCatchEventId(String value)
      Copy the current immutable object by setting a value for the catchEventId attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for catchEventId (can be null)
      Returns:
      A modified copy of the this object

    • withCatchEventInstanceKey

      public final ImmutableSignalSubscriptionRecordValue withCatchEventInstanceKey(long value)
      Copy the current immutable object by setting a value for the catchEventInstanceKey attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for catchEventInstanceKey
      Returns:
      A modified copy of the this object

    • withSignalName

      public final ImmutableSignalSubscriptionRecordValue withSignalName(String value)
      Copy the current immutable object by setting a value for the signalName attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for signalName (can be null)
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableSignalSubscriptionRecordValue 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: processDefinitionKey, bpmnProcessId, catchEventId, catchEventInstanceKey, signalName.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value SignalSubscriptionRecordValue with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ImmutableSignalSubscriptionRecordValue copyOf(SignalSubscriptionRecordValue instance)
      Creates an immutable copy of a SignalSubscriptionRecordValue 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 SignalSubscriptionRecordValue instance

    • builder

      public static ImmutableSignalSubscriptionRecordValue.Builder builder()
      Creates a builder for ImmutableSignalSubscriptionRecordValue. 
       ImmutableSignalSubscriptionRecordValue.builder()
    .withProcessDefinitionKey(long) // optional processDefinitionKey
    .withBpmnProcessId(String | null) // nullable bpmnProcessId
    .withCatchEventId(String | null) // nullable catchEventId
    .withCatchEventInstanceKey(long) // optional catchEventInstanceKey
    .withSignalName(String | null) // nullable signalName
    .build();
      Returns:
      A new ImmutableSignalSubscriptionRecordValue builder