org.apache.hadoop.yarn.util.timeline

クラス TimelineUtils

java.lang.Object

org.apache.hadoop.yarn.util.timeline.TimelineUtils

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class TimelineUtils
extends Object

The helper class for the timeline module.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	DEFAULT_FLOW_VERSION
static String	FLOW_NAME_TAG_PREFIX
static String	FLOW_RUN_ID_TAG_PREFIX
static String	FLOW_VERSION_TAG_PREFIX

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
TimelineUtils()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static Text	buildTimelineTokenService(Configuration conf)
static TimelineAbout	createTimelineAbout(String about)
static String	dumpTimelineRecordtoJSON(Object o) Serialize a POJO object into a JSON string not in a pretty format
static String	dumpTimelineRecordtoJSON(Object o, boolean pretty) Serialize a POJO object into a JSON string
static String	generateDefaultFlowName(String appName, ApplicationId appId)
static String	generateFlowNameTag(String flowName) Generate flow name tag.
static String	generateFlowRunIdTag(long flowRunId) Generate flow run ID tag.
static String	generateFlowVersionTag(String flowVersion) Generate flow version tag.
static float	getTimelineServiceVersion(Configuration conf) Returns the timeline service version.
static InetSocketAddress	getTimelineTokenServiceAddress(Configuration conf)
static boolean	timelineServiceEnabled(Configuration conf) Returns whether the timeline service is enabled via configuration.
static boolean	timelineServiceV1_5Enabled(Configuration conf) Returns whether the timeline service v.1.5 is enabled via configuration.

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

FLOW_NAME_TAG_PREFIX

public static final String FLOW_NAME_TAG_PREFIX

関連項目:

定数フィールド値

FLOW_VERSION_TAG_PREFIX

public static final String FLOW_VERSION_TAG_PREFIX

関連項目:

定数フィールド値

FLOW_RUN_ID_TAG_PREFIX

public static final String FLOW_RUN_ID_TAG_PREFIX

関連項目:

定数フィールド値

DEFAULT_FLOW_VERSION

public static final String DEFAULT_FLOW_VERSION

関連項目:

定数フィールド値

コンストラクタの詳細

TimelineUtils

public TimelineUtils()

メソッドの詳細

dumpTimelineRecordtoJSON

public static String dumpTimelineRecordtoJSON(Object o)
                                       throws org.codehaus.jackson.JsonGenerationException,
                                              org.codehaus.jackson.map.JsonMappingException,
                                              IOException

Serialize a POJO object into a JSON string not in a pretty format

パラメータ:

o - an object to serialize

戻り値:

a JSON string

例外:

IOException

org.codehaus.jackson.map.JsonMappingException

org.codehaus.jackson.JsonGenerationException

dumpTimelineRecordtoJSON

public static String dumpTimelineRecordtoJSON(Object o,
                                              boolean pretty)
                                       throws org.codehaus.jackson.JsonGenerationException,
                                              org.codehaus.jackson.map.JsonMappingException,
                                              IOException

Serialize a POJO object into a JSON string

パラメータ:

o - an object to serialize

pretty - whether in a pretty format or not

戻り値:

a JSON string

例外:

IOException

org.codehaus.jackson.map.JsonMappingException

org.codehaus.jackson.JsonGenerationException

timelineServiceEnabled

public static boolean timelineServiceEnabled(Configuration conf)

Returns whether the timeline service is enabled via configuration.

パラメータ:

conf - the configuration

戻り値:

whether the timeline service is enabled.

getTimelineServiceVersion

public static float getTimelineServiceVersion(Configuration conf)

Returns the timeline service version. It does not check whether the timeline service itself is enabled.

パラメータ:

conf - the configuration

戻り値:

the timeline service version as a float.

timelineServiceV1_5Enabled

public static boolean timelineServiceV1_5Enabled(Configuration conf)

Returns whether the timeline service v.1.5 is enabled via configuration.

パラメータ:

conf - the configuration

戻り値:

whether the timeline service v.1.5 is enabled. V.1.5 refers to a version equal to 1.5.

createTimelineAbout

public static TimelineAbout createTimelineAbout(String about)

getTimelineTokenServiceAddress

public static InetSocketAddress getTimelineTokenServiceAddress(Configuration conf)

buildTimelineTokenService

public static Text buildTimelineTokenService(Configuration conf)

generateDefaultFlowName

public static String generateDefaultFlowName(String appName,
                                             ApplicationId appId)

generateFlowNameTag

public static String generateFlowNameTag(String flowName)

Generate flow name tag.

パラメータ:

flowName - flow name that identifies a distinct flow application which can be run repeatedly over time

戻り値:

flow name tag.

generateFlowVersionTag

public static String generateFlowVersionTag(String flowVersion)

Generate flow version tag.

パラメータ:

flowVersion - flow version that keeps track of the changes made to the flow

戻り値:

flow version tag.

generateFlowRunIdTag

public static String generateFlowRunIdTag(long flowRunId)

Generate flow run ID tag.

パラメータ:

flowRunId - flow run ID that identifies one instance (or specific execution) of that flow

戻り値:

flow run id tag.