Package io.camunda.zeebe.engine.api.records

Record Class RecordBatchEntry

java.lang.Object
java.lang.Record
io.camunda.zeebe.engine.api.records.RecordBatchEntry
All Implemented Interfaces:
ImmutableRecordBatchEntry
public record RecordBatchEntry(long key, int sourceIndex, RecordMetadata recordMetadata, UnifiedRecordValue unifiedRecordValue) extends Record implements ImmutableRecordBatchEntry

  • Constructor Details

    • RecordBatchEntry

      public RecordBatchEntry(long key, int sourceIndex, RecordMetadata recordMetadata, UnifiedRecordValue unifiedRecordValue)
      Creates an instance of a RecordBatchEntry record class.
      Parameters:
      key - the value for the key record component
      sourceIndex - the value for the sourceIndex record component
      recordMetadata - the value for the recordMetadata record component
      unifiedRecordValue - the value for the unifiedRecordValue record component

  • Method Details

    • recordValue

      public UnifiedRecordValue recordValue()
      Specified by:
      recordValue in interface ImmutableRecordBatchEntry
      Returns:
      the actual record value, this method returns a general type but can be casted to the right record value class if necessary

    • getLength

      public int getLength()
      Specified by:
      getLength in interface ImmutableRecordBatchEntry
      Returns:
      the length of the record entry, important for the batch to determine whether it reached its maximum size

    • getMetadataLength

      public int getMetadataLength()

    • getValueLength

      public int getValueLength()

    • createEntry

      public static RecordBatchEntry createEntry(long key, int sourceIndex, RecordType recordType, Intent intent, RejectionType rejectionType, String rejectionReason, ValueType valueType, BufferWriter valueWriter)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • key

      public long key()
      Returns the value of the key record component.
      Specified by:
      key in interface ImmutableRecordBatchEntry
      Returns:
      the value of the key record component

    • sourceIndex

      public int sourceIndex()
      Returns the value of the sourceIndex record component.
      Specified by:
      sourceIndex in interface ImmutableRecordBatchEntry
      Returns:
      the value of the sourceIndex record component

    • recordMetadata

      public RecordMetadata recordMetadata()
      Returns the value of the recordMetadata record component.
      Specified by:
      recordMetadata in interface ImmutableRecordBatchEntry
      Returns:
      the value of the recordMetadata record component

    • unifiedRecordValue

      public UnifiedRecordValue unifiedRecordValue()
      Returns the value of the unifiedRecordValue record component.
      Returns:
      the value of the unifiedRecordValue record component