@InterfaceAudience.Public @InterfaceStability.Evolving public abstract class TimelineClient extends CompositeService implements Flushable
TimelineV2Client for ATS V2 interface.STOP_ONLY_STARTED_SERVICES| Modifier | Constructor and Description | 
|---|---|
| protected  | TimelineClient(String name) | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract void | cancelDelegationToken(Token<TimelineDelegationTokenIdentifier> timelineDT)
 Cancel a timeline delegation token. | 
| static TimelineClient | createTimelineClient()Creates an instance of the timeline v.1.x client. | 
| abstract Token<TimelineDelegationTokenIdentifier> | getDelegationToken(String renewer)
 Get a delegation token so as to be able to talk to the timeline server in a
 secure way. | 
| abstract void | putDomain(ApplicationAttemptId appAttemptId,
         TimelineDomain domain)
 Send the information of a domain to the timeline server. | 
| abstract void | putDomain(TimelineDomain domain)
 Send the information of a domain to the timeline server. | 
| abstract TimelinePutResponse | putEntities(ApplicationAttemptId appAttemptId,
           TimelineEntityGroupId groupId,
           TimelineEntity... entities)
 Send the information of a number of conceptual entities to the timeline
 server. | 
| abstract TimelinePutResponse | putEntities(TimelineEntity... entities)
 Send the information of a number of conceptual entities to the timeline
 server. | 
| abstract long | renewDelegationToken(Token<TimelineDelegationTokenIdentifier> timelineDT)
 Renew a timeline delegation token. | 
addIfService, addService, getServices, removeService, serviceInit, serviceStart, serviceStopclose, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStopprotected TimelineClient(String name)
@InterfaceAudience.Public public static TimelineClient createTimelineClient()
UserGroupInformation.doAs(java.security.PrivilegedAction<T>) another user to construct and initialize
 a timeline client if the following operations are supposed to be conducted
 by that user.@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.
entities - the collection of TimelineEntityIOException - if there are I/O errorsYarnException - if entities are incomplete/invalid@InterfaceAudience.Public public abstract TimelinePutResponse putEntities(ApplicationAttemptId appAttemptId, TimelineEntityGroupId groupId, 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. This API is only for timeline service v1.5
appAttemptId - ApplicationAttemptIdgroupId - TimelineEntityGroupIdentities - the collection of TimelineEntityIOException - if there are I/O errorsYarnException - if entities are incomplete/invalid@InterfaceAudience.Public public abstract void putDomain(TimelineDomain domain) throws IOException, YarnException
Send the information of a domain to the timeline server. It is a blocking API. The method will not return until it gets the response from the timeline server.
domain - an TimelineDomain objectIOExceptionYarnException@InterfaceAudience.Public public abstract void putDomain(ApplicationAttemptId appAttemptId, TimelineDomain domain) throws IOException, YarnException
Send the information of a domain to the timeline server. It is a blocking API. The method will not return until it gets the response from the timeline server. This API is only for timeline service v1.5
domain - an TimelineDomain objectappAttemptId - ApplicationAttemptIdIOExceptionYarnException@InterfaceAudience.Public public abstract Token<TimelineDelegationTokenIdentifier> getDelegationToken(String renewer) throws IOException, YarnException
Get a delegation token so as to be able to talk to the timeline server in a secure way.
renewer - Address of the renewer who can renew these tokens when needed by
          securely talking to the timeline serverToken) that can be used to talk to the
         timeline serverIOExceptionYarnException@InterfaceAudience.Public public abstract long renewDelegationToken(Token<TimelineDelegationTokenIdentifier> timelineDT) throws IOException, YarnException
Renew a timeline delegation token.
timelineDT - the delegation token to renewIOExceptionYarnException@InterfaceAudience.Public public abstract void cancelDelegationToken(Token<TimelineDelegationTokenIdentifier> timelineDT) throws IOException, YarnException
Cancel a timeline delegation token.
timelineDT - the delegation token to cancelIOExceptionYarnExceptionCopyright © 2023 Apache Software Foundation. All rights reserved.