org.apache.gobblin.stream

Class StreamEntity<D>

java.lang.Object

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

Type Parameters:

D - the type of records represented in the stream.

All Implemented Interfaces:

Ackable

Direct Known Subclasses:

ControlMessage, RecordEnvelope

public abstract class StreamEntity<D>
extends Object
implements Ackable

An entity in the Gobblin ingestion stream. Note: When transforming or cloning a stream entity, it is important to construct the new entity in the correct way to ensure callbacks are spread correctly: 1-to-1 entity transformation constructor: super(upstreamEntity, true); 1-to-n entity transformation: ForkedEntityBuilder forkedEntityBuilder = new ForkedEntityBuilder(); super(forkedEntityBuilder, true); forkedEntityBuilder.close(); Cloning entity: ForkCloner forkCloner = record.forkCloner(); forkCloner.getClone(); forkCloner.close();

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StreamEntity.ForkCloner Used to clone a StreamEntity retaining the correct callbacks.
class	StreamEntity.ForkedEntityBuilder Used to generate derived StreamEntitys using a HierarchicalAckable to make sure parent ackable is automatically acked when all children are acked.

Field Summary

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

NoopAckable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamEntity()
protected	StreamEntity(StreamEntity<?> upstreamEntity, boolean copyCallbacks)
protected	StreamEntity(StreamEntity.ForkedEntityBuilder forkedEntityBuilder, boolean copyCallbacks)

Method Summary

Modifier and Type	Method and Description
void	ack() Acknowledge this entity as a success.
StreamEntity<D>	addCallBack(Ackable ackable)
protected abstract StreamEntity<D>	buildClone()
StreamEntity.ForkCloner	forkCloner()
StreamEntity<D>	getSingleClone()
void	nack(Throwable error) Mark this entity as failed to process.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamEntity

protected StreamEntity()

StreamEntity

protected StreamEntity(StreamEntity<?> upstreamEntity,
                       boolean copyCallbacks)

StreamEntity

protected StreamEntity(StreamEntity.ForkedEntityBuilder forkedEntityBuilder,
                       boolean copyCallbacks)

Method Detail

ack

public void ack()

Description copied from interface: Ackable

Acknowledge this entity as a success.

Specified by:

ack in interface Ackable

nack

public void nack(Throwable error)

Description copied from interface: Ackable

Mark this entity as failed to process.

Specified by:

nack in interface Ackable

addCallBack

public StreamEntity<D> addCallBack(Ackable ackable)

getSingleClone

public final StreamEntity<D> getSingleClone()

Returns:

a clone of this StreamEntity.

buildClone

protected abstract StreamEntity<D> buildClone()

Returns:

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

forkCloner

public StreamEntity.ForkCloner forkCloner()

Returns:

a StreamEntity.ForkCloner to generate multiple clones of this StreamEntity.