org.embulk.config

Interface ConfigSource

All Superinterfaces:

DataSource

public interface ConfigSource
extends DataSource

Represents an Embulk configuration for a plugin.

It had two following methods that return Jackson's instances till v0.9, but they are removed so that Jackson on the core side can be hidden from plugins.

• Iterable<Map.Entry<String, JsonNode>> getAttributes()
• ObjectNode getObjectNode()

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
ConfigSource	deepCopy() Creates a deep copy of itself.
ConfigSource	getNested(String attrName) Returns a nested value under attrName.
ConfigSource	getNestedOrGetEmpty(String attrName) Returns a nested value under attrName.
ConfigSource	getNestedOrSetEmpty(String attrName) Returns a nested value under attrName.
default <T> T	loadConfig(Class<T> taskType) Deprecated. Use embulk-util-config instead.
ConfigSource	merge(DataSource other) Merges another ConfigSource into itself.
ConfigSource	remove(String attrName) Removes the attribute named attrName.
ConfigSource	set(String attrName, Object v) Sets a value for attrName.
ConfigSource	setAll(DataSource other) Sets all attributes in other into itself.
ConfigSource	setNested(String attrName, DataSource v) Sets a nested value for attrName.

Methods inherited from interface org.embulk.config.DataSource

get, get, getAttributeNames, getListOf, has, hasList, hasNested, isEmpty, toJson, toMap

Method Detail

loadConfig

@Deprecated
default <T> T loadConfig(Class<T> taskType)

Deprecated. Use embulk-util-config instead.

Loads this configuration as a task class like PluginTask.

This method will be deprecated. Loading configs will be replaced by another library embulk-util-config on plugin's side.

Type Parameters:

T - the task class to load this configuration as

Parameters:

taskType - the task class to load this configuration as

Returns:

a task class instance loaded

Since:

0.4.0

getNested

ConfigSource getNested(String attrName)

Returns a nested value under attrName.

Specified by:

getNested in interface DataSource

Parameters:

attrName - name of the nested attribute to look for

Returns:

the nested attribute value of attrName

Since:

0.4.0

getNestedOrSetEmpty

ConfigSource getNestedOrSetEmpty(String attrName)

Returns a nested value under attrName. Sets an empty object node "{}" there if it is empty.

Specified by:

getNestedOrSetEmpty in interface DataSource

Parameters:

attrName - name of the nested attribute to look for

Returns:

the nested attribute value of attrName

Since:

0.4.0

getNestedOrGetEmpty

ConfigSource getNestedOrGetEmpty(String attrName)

Returns a nested value under attrName. Returns an empty object node "{}" there if it is empty.

Specified by:

getNestedOrGetEmpty in interface DataSource

Parameters:

attrName - name of the nested attribute to look for

Returns:

the nested attribute value of attrName

Since:

0.7.5

set

ConfigSource set(String attrName,
                 Object v)

Sets a value for attrName.

Specified by:

set in interface DataSource

Parameters:

attrName - name of the attribute to set the value at

v - the value Object to set

Returns:

itself after the value is set

Since:

0.4.0

setNested

ConfigSource setNested(String attrName,
                       DataSource v)

Sets a nested value for attrName.

Specified by:

setNested in interface DataSource

Parameters:

attrName - name of the attribute to set the nested value at

v - the nested value to set

Returns:

itself after the nested value is set

Since:

0.4.0

setAll

ConfigSource setAll(DataSource other)

Sets all attributes in other into itself.

Specified by:

setAll in interface DataSource

Parameters:

other - the other ConfigSource to set

Returns:

itself after the attributes are set

Since:

0.4.0

remove

ConfigSource remove(String attrName)

Removes the attribute named attrName.

Specified by:

remove in interface DataSource

Parameters:

attrName - name of the attribute to remove

Returns:

itself after the attribute is removed

Since:

0.6.14

deepCopy

ConfigSource deepCopy()

Creates a deep copy of itself.

Specified by:

deepCopy in interface DataSource

Returns:

the new ConfigSource instance that is deep-copied from itself

Since:

0.4.0

merge

ConfigSource merge(DataSource other)

Merges another ConfigSource into itself.

Specified by:

merge in interface DataSource

Parameters:

other - the other ConfigSource to merge

Returns:

itself after the other ConfigSource is merged

Since:

0.4.0