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

java.lang.Object
  extended by org.apache.hadoop.service.AbstractService
      extended by org.apache.hadoop.yarn.client.api.TimelineClient
All Implemented Interfaces:
Closeable, Service

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract class TimelineClient
extends AbstractService

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


Constructor Summary
protected TimelineClient(String name)
           
 
Method Summary
static TimelineClient createTimelineClient()
           
abstract  TimelinePutResponse putEntities(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 TimelinePutResponse putEntities(TimelineEntity... entities)
                                         throws IOException,
                                                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
YarnException


Copyright © 2014 Apache Software Foundation. All Rights Reserved.