org.apache.gobblin.source.workunit

Class ImmutableWorkUnit

java.lang.Object

org.apache.gobblin.configuration.State

org.apache.gobblin.source.workunit.WorkUnit

org.apache.gobblin.source.workunit.ImmutableWorkUnit

All Implemented Interfaces:

WritableShim

Direct Known Subclasses:

ImmutableWorkUnit

public class ImmutableWorkUnit
extends WorkUnit

An immutable version of WorkUnit.

Constructor Summary

Constructors

Constructor and Description
ImmutableWorkUnit(WorkUnit workUnit)

Method Summary

Modifier and Type	Method and Description
void	addAll(Properties properties) Populates this instance with values of a Properties instance.
void	addAll(State otherState) Populates this instance with properties of the other instance.
void	addAllIfNotExist(Properties properties) Add properties in a Properties instance that are not in the current instance.
void	addAllIfNotExist(State otherState) Add properties in a State instance that are not in the current instance.
void	appendToListProp(String key, String value) Appends the input value to a list property that can be retrieved with State.getPropAsList(java.lang.String).
void	overrideWith(Properties properties) Add properties in a Properties instance that are in the current instance.
void	overrideWith(State otherState) Add properties in a State instance that are in the current instance.
void	readFields(DataInput in)
void	setHighWaterMark(long highWaterMark) Deprecated.
void	setId(String id) Set the id used for state persistence and logging.
void	setLowWaterMark(long lowWaterMark) Deprecated.
void	setProp(String key, Object value) Set a property.

Methods inherited from class org.apache.gobblin.source.workunit.WorkUnit

contains, copyOf, create, create, createEmpty, equals, getExpectedHighWatermark, getExpectedHighWatermark, getExpectedHighWatermark, getExtract, getHighWaterMark, getLowWatermark, getLowWaterMark, getLowWatermark, getLowWatermark, getOutputFilePath, getProp, getProp, hashCode, setWatermarkInterval, skip, write

Methods inherited from class org.apache.gobblin.configuration.State

appendToSetProp, getId, getPropAsBoolean, getPropAsBoolean, getPropAsCaseInsensitiveSet, getPropAsCaseInsensitiveSet, getPropAsDouble, getPropAsDouble, getPropAsInt, getPropAsInt, getPropAsJsonArray, getPropAsList, getPropAsList, getPropAsLong, getPropAsLong, getPropAsSet, getPropAsSet, getPropAsShort, getPropAsShort, getPropAsShortWithRadix, getPropAsShortWithRadix, getProperties, getProperty, getProperty, getPropertyNames, removeProp, removePropsWithPrefix, setProps, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImmutableWorkUnit

public ImmutableWorkUnit(WorkUnit workUnit)

Method Detail

setProp

public void setProp(String key,
                    Object value)

Description copied from class: State

Set a property.

Both key and value are stored as strings.

Overrides:

setProp in class State

Parameters:

key - property key

value - property value

setHighWaterMark

@Deprecated
public void setHighWaterMark(long highWaterMark)

Deprecated.

Description copied from class: WorkUnit

Set the high watermark of this WorkUnit.

Overrides:

setHighWaterMark in class WorkUnit

Parameters:

highWaterMark - high watermark

setLowWaterMark

@Deprecated
public void setLowWaterMark(long lowWaterMark)

Deprecated.

Description copied from class: WorkUnit

Set the low watermark of this WorkUnit.

Overrides:

setLowWaterMark in class WorkUnit

Parameters:

lowWaterMark - low watermark

addAll

public void addAll(Properties properties)

Description copied from class: State

Populates this instance with values of a Properties instance.

Overrides:

addAll in class State

Parameters:

properties - a Properties instance

addAll

public void addAll(State otherState)

Description copied from class: State

Populates this instance with properties of the other instance.

Overrides:

addAll in class State

Parameters:

otherState - the other State instance

addAllIfNotExist

public void addAllIfNotExist(Properties properties)

Description copied from class: State

Add properties in a Properties instance that are not in the current instance.

Overrides:

addAllIfNotExist in class State

Parameters:

properties - a Properties instance

addAllIfNotExist

public void addAllIfNotExist(State otherState)

Description copied from class: State

Add properties in a State instance that are not in the current instance.

Overrides:

addAllIfNotExist in class State

Parameters:

otherState - a State instance

overrideWith

public void overrideWith(Properties properties)

Description copied from class: State

Add properties in a Properties instance that are in the current instance.

Overrides:

overrideWith in class State

Parameters:

properties - a Properties instance

overrideWith

public void overrideWith(State otherState)

Description copied from class: State

Add properties in a State instance that are in the current instance.

Overrides:

overrideWith in class State

Parameters:

otherState - a State instance

setId

public void setId(String id)

Description copied from class: State

Set the id used for state persistence and logging.

Overrides:

setId in class State

Parameters:

id - id of this instance

appendToListProp

public void appendToListProp(String key,
                             String value)

Description copied from class: State

Appends the input value to a list property that can be retrieved with State.getPropAsList(java.lang.String).

List properties are internally stored as comma separated strings. Adding a value that contains commas (for example "a,b,c") will essentially add multiple values to the property ("a", "b", and "c"). This is similar to the way that Configuration works.

Overrides:

appendToListProp in class State

Parameters:

key - property key

value - property value (if it includes commas, it will be split by the commas).

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface WritableShim

Overrides:

readFields in class WorkUnit

Throws:

IOException