org.apache.hadoop.yarn.client.api
Class TimelineClient

java.lang.Object
  org.apache.hadoop.service.AbstractService
      org.apache.hadoop.yarn.client.api.TimelineClient

All Implemented Interfaces:

Closeable, org.apache.hadoop.service.Service

Direct Known Subclasses:

TimelineClientImpl

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract class TimelineClient
extends org.apache.hadoop.service.AbstractService

A client library that can be used to post some information in terms of a number of conceptual entities.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Constructor Summary

protected

TimelineClient(String name)

Method Summary

static TimelineClient	createTimelineClient()
abstract org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse	putEntities(org.apache.hadoop.yarn.api.records.timeline.TimelineEntity... entities) Send the information of a number of conceptual entities to the timeline server.

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceInit, serviceStart, serviceStop, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Constructor Detail

TimelineClient

@InterfaceAudience.Private
protected TimelineClient(String name)

Method Detail

createTimelineClient

@InterfaceAudience.Public
public static TimelineClient createTimelineClient()

putEntities

@InterfaceAudience.Public
public abstract org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse putEntities(org.apache.hadoop.yarn.api.records.timeline.TimelineEntity... entities)
                                                                                     throws IOException,
                                                                                            org.apache.hadoop.yarn.exceptions.YarnException

Send the information of a number of conceptual entities to the timeline server. It is a blocking API. The method will not return until it gets the response from the timeline server.

Parameters:

entities - the collection of TimelineEntity

Returns:

the error information if the sent entities are not correctly stored

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException