org.apache.gobblin.stream

Class RecordEnvelope<D>

java.lang.Object

org.apache.gobblin.stream.StreamEntity<D>

org.apache.gobblin.stream.RecordEnvelope<D>

All Implemented Interfaces:

Ackable

Direct Known Subclasses:

FlushRecordEnvelope

@Alpha
public class RecordEnvelope<D>
extends StreamEntity<D>

An envelope around a record containing metadata and allowing for ack'ing the record. Note: When transforming or cloning a record, it is important to do it in the correct way to ensure callbacks and watermarks are spread correctly: 1-to-1 record transformation: record.withRecord(transformedRecord); 1-to-n record transformation: ForkRecordBuilder forkRecordBuilder = record.forkRecordBuilder(); forkRecordBuilder.childRecord(transformed1); forkRecordBuilder.childRecord(transformed2); forkRecordBuilder.close(); Cloning record: ForkCloner forkCloner = record.forkCloner(); forkCloner.getClone(); forkCloner.close();

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RecordEnvelope.ForkRecordBuilder<DO> Used to create derivative records with the same callbacks and watermarks.

Nested classes/interfaces inherited from class org.apache.gobblin.stream.StreamEntity

StreamEntity.ForkCloner, StreamEntity.ForkedEntityBuilder

Field Summary

Fields inherited from interface org.apache.gobblin.ack.Ackable

NoopAckable

Constructor Summary

Constructors

Constructor and Description
RecordEnvelope(D record)
RecordEnvelope(D record, CheckpointableWatermark watermark)

Method Summary

Modifier and Type	Method and Description
protected StreamEntity<D>	buildClone()
<DO> RecordEnvelope.ForkRecordBuilder<DO>	forkRecordBuilder() Obtain a RecordEnvelope.ForkRecordBuilder to create derivative records to this record.
D	getRecord()
Object	getRecordMetadata(String key)
CheckpointableWatermark	getWatermark()
void	setRecordMetadata(String key, Object value) Set the record metadata
<DO> RecordEnvelope<DO>	withRecord(DO newRecord)

Methods inherited from class org.apache.gobblin.stream.StreamEntity

ack, addCallBack, forkCloner, getSingleClone, nack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecordEnvelope

public RecordEnvelope(D record)

RecordEnvelope

public RecordEnvelope(D record,
                      CheckpointableWatermark watermark)

Method Detail

withRecord

public <DO> RecordEnvelope<DO> withRecord(DO newRecord)

Returns:

a new RecordEnvelope with just the record changed.

getRecord

public D getRecord()

Returns:

the record contained.

getWatermark

@Nullable
public CheckpointableWatermark getWatermark()

Returns:

The watermark for this record.

getRecordMetadata

public Object getRecordMetadata(String key)

Returns:

The record metadata with the given key or null if not present

setRecordMetadata

public void setRecordMetadata(String key,
                              Object value)

Set the record metadata

Parameters:

key - key for the metadata

value - value of the metadata

buildClone

protected StreamEntity<D> buildClone()

Specified by:

buildClone in class StreamEntity<D>

Returns:

a clone of this StreamEntity. Implementations need not worry about the callbacks, they will be set automatically.

forkRecordBuilder

public <DO> RecordEnvelope.ForkRecordBuilder<DO> forkRecordBuilder()

Obtain a RecordEnvelope.ForkRecordBuilder to create derivative records to this record.