org.apache.gobblin.source.workunit

Class ImmutableExtract

java.lang.Object

org.apache.gobblin.configuration.State

org.apache.gobblin.source.workunit.Extract

org.apache.gobblin.source.workunit.ImmutableExtract

All Implemented Interfaces:

WritableShim

Direct Known Subclasses:

ImmutableExtract

public class ImmutableExtract
extends Extract

An immutable version of Extract.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.gobblin.source.workunit.Extract

Extract.TableType

Constructor Summary

Constructors

Constructor and Description
ImmutableExtract(Extract extract)
ImmutableExtract(SourceState state, Extract.TableType type, String namespace, String table)

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	addDeltaField(String... deltaFieldName) Add more delta fields to the existing set of delta fields.
void	addPrimaryKey(String... primaryKeyFieldName) Add more primary keys to the existing set of primary keys.
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	setDeltaFields(String... deltaFieldName) Set delta fields.
void	setExtractId(String extractId) Set a (non-globally) unique ID for this Extract.
void	setFullTrue(long extractFullRunTime) Set full drop date from the given time.
void	setId(String id) Set the id used for state persistence and logging.
void	setPrimaryKeys(String... primaryKeyFieldName) Set primary keys.
void	setProp(String key, Object value) Set a property.

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

equals, getDeltaFields, getExtractId, getIsFull, getNamespace, getOutputFilePath, getPreviousTableState, getPrimaryKeys, getTable, getType, hashCode, hasType

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

appendToSetProp, contains, getId, getProp, getProp, 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, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableExtract

public ImmutableExtract(SourceState state,
                        Extract.TableType type,
                        String namespace,
                        String table)

ImmutableExtract

public ImmutableExtract(Extract extract)

Method Detail

setFullTrue

public void setFullTrue(long extractFullRunTime)

Description copied from class: Extract

Set full drop date from the given time.

Overrides:

setFullTrue in class Extract

Parameters:

extractFullRunTime - full extract time

setPrimaryKeys

public void setPrimaryKeys(String... primaryKeyFieldName)

Description copied from class: Extract

Set primary keys.

The order of primary keys does not matter.

Overrides:

setPrimaryKeys in class Extract

Parameters:

primaryKeyFieldName - primary key names

setDeltaFields

public void setDeltaFields(String... deltaFieldName)

Description copied from class: Extract

Set delta fields.

The order of delta fields does not matter.

Overrides:

setDeltaFields in class Extract

Parameters:

deltaFieldName - delta field names

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

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

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).

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

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface WritableShim

Overrides:

readFields in class State

Throws:

IOException

setExtractId

public void setExtractId(String extractId)

Description copied from class: Extract

Set a (non-globally) unique ID for this Extract.

Overrides:

setExtractId in class Extract

Parameters:

extractId - unique ID for this Extract

addPrimaryKey

public void addPrimaryKey(String... primaryKeyFieldName)

Description copied from class: Extract

Add more primary keys to the existing set of primary keys.

Overrides:

addPrimaryKey in class Extract

Parameters:

primaryKeyFieldName - primary key names

addDeltaField

public void addDeltaField(String... deltaFieldName)

Description copied from class: Extract

Add more delta fields to the existing set of delta fields.

Overrides:

addDeltaField in class Extract

Parameters:

deltaFieldName - delta field names