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

Interface MutableRecordBatch

All Superinterfaces:

ImmutableRecordBatch, Iterable<ImmutableRecordBatchEntry>

All Known Implementing Classes:

RecordBatch

public interface MutableRecordBatch
extends ImmutableRecordBatch

Represents a modifiable batch of record, which means we can add multiple Records to the batch. For further processing the user can iterate of the appended entries and retrieve the needed data.

Method Summary

Modifier and Type	Method	Description
Either<RuntimeException,Void>	appendRecord(long key, int sourceIndex, RecordType recordType, Intent intent, RejectionType rejectionType, String rejectionReason, ValueType valueType, BufferWriter valueWriter)	Allows to add a new Record to the batch
boolean	canAppendRecordOfLength(int recordLength)	Allows to verify whether the given record length is suitable to be appended in the current batch.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

appendRecord

Either<RuntimeException,Void> appendRecord(long key,
 int sourceIndex,
 RecordType recordType,
 Intent intent,
 RejectionType rejectionType,
 String rejectionReason,
 ValueType valueType,
 BufferWriter valueWriter)

Allows to add a new Record to the batch

Parameters:

key - the key of the record

sourceIndex - the position/index in the current batch which caused that entry; should be set to -1 if no entry caused it

recordType - the type of the record, part of the record metadata, must be set

intent - the intent of the record, part of the record metadata, must be set

rejectionType - the rejection type, part of the record metadata, can be set to a NULL_VALUE

rejectionReason - the rejection reason, part of the record metadata, can be empty

valueType - the value type, part of the record metadata, must be set

valueWriter - the actual record value

Returns:

either a failure if record can't be added to the batch or null on success

canAppendRecordOfLength

boolean canAppendRecordOfLength(int recordLength)

Allows to verify whether the given record length is suitable to be appended in the current batch. This method is useful if you have one record which will be updated and you don't want to append it right now, just to verify whether it would still fit.

Parameters:

recordLength - the expected record length, which needs to be verified

Returns:

true if the record length would fit into the batch, false otherwise