org.embulk.config

Interface TaskReport

All Superinterfaces:

DataSource

public interface TaskReport
extends DataSource

Represents a report from a plugin task.

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

Method Summary

Modifier and Type	Method and Description
TaskReport	deepCopy() Creates a deep copy of itself.
TaskReport	getNested(String attrName) Returns a nested value under attrName.
TaskReport	getNestedOrGetEmpty(String attrName) Returns a nested value under attrName.
TaskReport	getNestedOrSetEmpty(String attrName) Returns a nested value under attrName.
TaskReport	merge(DataSource other) Merges another TaskReport into itself.
TaskReport	remove(String attrName) Removes the attribute named attrName.
TaskReport	set(String attrName, Object v) Sets a value for attrName.
TaskReport	setAll(DataSource other) Sets all attributes in other into itself.
TaskReport	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

getNested

TaskReport 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.7.0

getNestedOrSetEmpty

TaskReport 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.7.0

getNestedOrGetEmpty

TaskReport 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

TaskReport 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.7.0

setNested

TaskReport 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.7.0

setAll

TaskReport setAll(DataSource other)

Sets all attributes in other into itself.

Specified by:

setAll in interface DataSource

Parameters:

other - the other TaskReport to set

Returns:

itself after the attributes are set

Since:

0.7.0

remove

TaskReport 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.7.0

deepCopy

TaskReport deepCopy()

Creates a deep copy of itself.

Specified by:

deepCopy in interface DataSource

Returns:

the new TaskReport instance that is deep-copied from itself

Since:

0.7.0

merge

TaskReport merge(DataSource other)

Merges another TaskReport into itself.

Specified by:

merge in interface DataSource

Parameters:

other - the other TaskReport to merge

Returns:

itself after the other TaskReport is merged

Since:

0.7.0