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

Class ImmutableSignalRecordValue.Builder

java.lang.Object
io.camunda.zeebe.protocol.record.value.ImmutableSignalRecordValue.Builder
Enclosing class:
ImmutableSignalRecordValue
public static final class ImmutableSignalRecordValue.Builder extends Object
Builds instances of type ImmutableSignalRecordValue. 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 Details

    • from

      public final ImmutableSignalRecordValue.Builder from(SignalRecordValue instance)
      Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.SignalRecordValue instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

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

    • withSignalName

      public final ImmutableSignalRecordValue.Builder withSignalName(String signalName)
      Initializes the value for the signalName attribute.
      Parameters:
      signalName - The value for signalName (can be null)
      Returns:
      this builder for use in a chained invocation

    • clear

      public ImmutableSignalRecordValue.Builder clear()
      Clear the builder to the initial state.
      Returns:
      this builder for use in a chained invocation

    • build

      public ImmutableSignalRecordValue build()
      Builds a new ImmutableSignalRecordValue.
      Returns:
      An immutable instance of SignalRecordValue
      Throws:
      IllegalStateException - if any required attributes are missing