12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566 |
- <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
- <!-- Generated by the JDiff Javadoc doclet -->
- <!-- (http://www.jdiff.org) -->
- <!-- on Tue Jan 29 03:53:51 UTC 2019 -->
- <api
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:noNamespaceSchemaLocation='api.xsd'
- name="Apache Hadoop YARN Common 3.1.2"
- jdversion="1.0.9">
- <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/hadoop-annotations.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/jdiff.jar -verbose -classpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/classes:/build/source/hadoop-common-project/hadoop-common/target/hadoop-common-3.1.2.jar:/maven/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/maven/org/apache/httpcomponents/httpclient/4.5.2/httpclient-4.5.2.jar:/maven/org/apache/httpcomponents/httpcore/4.4.4/httpcore-4.4.4.jar:/maven/commons-net/commons-net/3.6/commons-net-3.6.jar:/maven/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/maven/org/eclipse/jetty/jetty-server/9.3.24.v20180605/jetty-server-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-http/9.3.24.v20180605/jetty-http-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-io/9.3.24.v20180605/jetty-io-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-servlet/9.3.24.v20180605/jetty-servlet-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-security/9.3.24.v20180605/jetty-security-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-webapp/9.3.24.v20180605/jetty-webapp-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-xml/9.3.24.v20180605/jetty-xml-9.3.24.v20180605.jar:/maven/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/maven/com/sun/jersey/jersey-servlet/1.19/jersey-servlet-1.19.jar:/maven/commons-beanutils/commons-beanutils/1.9.3/commons-beanutils-1.9.3.jar:/maven/org/apache/commons/commons-configuration2/2.1.1/commons-configuration2-2.1.1.jar:/maven/org/apache/commons/commons-lang3/3.4/commons-lang3-3.4.jar:/maven/org/slf4j/slf4j-log4j12/1.7.25/slf4j-log4j12-1.7.25.jar:/maven/org/apache/avro/avro/1.7.7/avro-1.7.7.jar:/maven/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/maven/org/xerial/snappy/snappy-java/1.0.5/snappy-java-1.0.5.jar:/maven/com/google/re2j/re2j/1.1/re2j-1.1.jar:/maven/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/maven/com/jcraft/jsch/0.1.54/jsch-0.1.54.jar:/maven/org/apache/curator/curator-client/2.13.0/curator-client-2.13.0.jar:/maven/org/apache/curator/curator-recipes/2.13.0/curator-recipes-2.13.0.jar:/maven/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/maven/org/apache/htrace/htrace-core4/4.1.0-incubating/htrace-core4-4.1.0-incubating.jar:/maven/org/apache/zookeeper/zookeeper/3.4.13/zookeeper-3.4.13.jar:/maven/org/apache/yetus/audience-annotations/0.5.0/audience-annotations-0.5.0.jar:/maven/io/netty/netty/3.10.5.Final/netty-3.10.5.Final.jar:/maven/org/apache/kerby/kerb-simplekdc/1.0.1/kerb-simplekdc-1.0.1.jar:/maven/org/apache/kerby/kerb-client/1.0.1/kerb-client-1.0.1.jar:/maven/org/apache/kerby/kerby-config/1.0.1/kerby-config-1.0.1.jar:/maven/org/apache/kerby/kerb-core/1.0.1/kerb-core-1.0.1.jar:/maven/org/apache/kerby/kerby-pkix/1.0.1/kerby-pkix-1.0.1.jar:/maven/org/apache/kerby/kerby-asn1/1.0.1/kerby-asn1-1.0.1.jar:/maven/org/apache/kerby/kerby-util/1.0.1/kerby-util-1.0.1.jar:/maven/org/apache/kerby/kerb-common/1.0.1/kerb-common-1.0.1.jar:/maven/org/apache/kerby/kerb-crypto/1.0.1/kerb-crypto-1.0.1.jar:/maven/org/apache/kerby/kerb-util/1.0.1/kerb-util-1.0.1.jar:/maven/org/apache/kerby/token-provider/1.0.1/token-provider-1.0.1.jar:/maven/org/apache/kerby/kerb-admin/1.0.1/kerb-admin-1.0.1.jar:/maven/org/apache/kerby/kerb-server/1.0.1/kerb-server-1.0.1.jar:/maven/org/apache/kerby/kerb-identity/1.0.1/kerb-identity-1.0.1.jar:/maven/org/apache/kerby/kerby-xdr/1.0.1/kerby-xdr-1.0.1.jar:/maven/org/codehaus/woodstox/stax2-api/3.1.4/stax2-api-3.1.4.jar:/maven/com/fasterxml/woodstox/woodstox-core/5.0.3/woodstox-core-5.0.3.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-yarn-api-3.1.2.jar:/maven/com/fasterxml/jackson/core/jackson-annotations/2.7.8/jackson-annotations-2.7.8.jar:/build/source/hadoop-common-project/hadoop-auth/target/hadoop-auth-3.1.2.jar:/maven/com/nimbusds/nimbus-jose-jwt/4.41.1/nimbus-jose-jwt-4.41.1.jar:/maven/com/github/stephenc/jcip/jcip-annotations/1.0-1/jcip-annotations-1.0-1.jar:/maven/net/minidev/json-smart/2.3/json-smart-2.3.jar:/maven/net/minidev/accessors-smart/1.2/accessors-smart-1.2.jar:/maven/org/ow2/asm/asm/5.0.4/asm-5.0.4.jar:/maven/org/apache/curator/curator-framework/2.13.0/curator-framework-2.13.0.jar:/maven/javax/xml/bind/jaxb-api/2.2.11/jaxb-api-2.2.11.jar:/maven/org/apache/commons/commons-compress/1.18/commons-compress-1.18.jar:/maven/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/maven/javax/servlet/javax.servlet-api/3.1.0/javax.servlet-api-3.1.0.jar:/maven/commons-codec/commons-codec/1.11/commons-codec-1.11.jar:/maven/org/eclipse/jetty/jetty-util/9.3.24.v20180605/jetty-util-9.3.24.v20180605.jar:/maven/com/sun/jersey/jersey-core/1.19/jersey-core-1.19.jar:/maven/javax/ws/rs/jsr311-api/1.1.1/jsr311-api-1.1.1.jar:/maven/com/sun/jersey/jersey-client/1.19/jersey-client-1.19.jar:/maven/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/maven/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/maven/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/maven/org/slf4j/slf4j-api/1.7.25/slf4j-api-1.7.25.jar:/build/source/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-3.1.2.jar:/usr/lib/jvm/java-8-openjdk-amd64/lib/tools.jar:/maven/com/google/inject/extensions/guice-servlet/4.0/guice-servlet-4.0.jar:/maven/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/maven/commons-io/commons-io/2.5/commons-io-2.5.jar:/maven/com/google/inject/guice/4.0/guice-4.0.jar:/maven/javax/inject/javax.inject/1/javax.inject-1.jar:/maven/aopalliance/aopalliance/1.0/aopalliance-1.0.jar:/maven/com/sun/jersey/jersey-server/1.19/jersey-server-1.19.jar:/maven/com/sun/jersey/jersey-json/1.19/jersey-json-1.19.jar:/maven/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/maven/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/maven/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/maven/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/maven/com/sun/jersey/contribs/jersey-guice/1.19/jersey-guice-1.19.jar:/maven/log4j/log4j/1.2.17/log4j-1.2.17.jar:/maven/com/fasterxml/jackson/core/jackson-core/2.7.8/jackson-core-2.7.8.jar:/maven/com/fasterxml/jackson/core/jackson-databind/2.7.8/jackson-databind-2.7.8.jar:/maven/com/fasterxml/jackson/module/jackson-module-jaxb-annotations/2.7.8/jackson-module-jaxb-annotations-2.7.8.jar:/maven/com/fasterxml/jackson/jaxrs/jackson-jaxrs-json-provider/2.7.8/jackson-jaxrs-json-provider-2.7.8.jar:/maven/com/fasterxml/jackson/jaxrs/jackson-jaxrs-base/2.7.8/jackson-jaxrs-base-2.7.8.jar:/maven/xerces/xercesImpl/2.11.0/xercesImpl-2.11.0.jar:/maven/xml-apis/xml-apis/1.4.01/xml-apis-1.4.01.jar -sourcepath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/hadoop-annotations.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/jdiff.jar -apidir /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/site/jdiff/xml -apiname Apache Hadoop YARN Common 3.1.2 -->
- <package name="org.apache.hadoop.yarn">
- <!-- start class org.apache.hadoop.yarn.ContainerLogAppender -->
- <class name="ContainerLogAppender" extends="org.apache.log4j.FileAppender"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Flushable"/>
- <constructor name="ContainerLogAppender"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="activateOptions"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.log4j.spi.LoggingEvent"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getContainerLogDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getter/Setter methods for log4j.]]>
- </doc>
- </method>
- <method name="setContainerLogDir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerLogDir" type="java.lang.String"/>
- </method>
- <method name="getContainerLogFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerLogFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerLogFile" type="java.lang.String"/>
- </method>
- <method name="getTotalLogFileSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setTotalLogFileSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logSize" type="long"/>
- <doc>
- <![CDATA[Setter so that log4j can configure it from the
- configuration(log4j.properties).]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A simple log4j-appender for container's logs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.ContainerLogAppender -->
- <!-- start class org.apache.hadoop.yarn.ContainerRollingLogAppender -->
- <class name="ContainerRollingLogAppender" extends="org.apache.log4j.RollingFileAppender"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Flushable"/>
- <constructor name="ContainerRollingLogAppender"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="activateOptions"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getContainerLogDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getter/Setter methods for log4j.]]>
- </doc>
- </method>
- <method name="setContainerLogDir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerLogDir" type="java.lang.String"/>
- </method>
- <method name="getContainerLogFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerLogFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerLogFile" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[A simple log4j-appender for container's logs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.ContainerRollingLogAppender -->
- <!-- start class org.apache.hadoop.yarn.YarnUncaughtExceptionHandler -->
- <class name="YarnUncaughtExceptionHandler" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Thread.UncaughtExceptionHandler"/>
- <constructor name="YarnUncaughtExceptionHandler"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="uncaughtException"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="java.lang.Thread"/>
- <param name="e" type="java.lang.Throwable"/>
- </method>
- <doc>
- <![CDATA[This class is intended to be installed by calling
- {@link Thread#setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler)}
- In the main entry point. It is intended to try and cleanly shut down
- programs using the YARN Event framework.
-
- Note: Right now it only will shut down the program if a Error is caught, but
- not any other exception. Anything else is just logged.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.YarnUncaughtExceptionHandler -->
- </package>
- <package name="org.apache.hadoop.yarn.api">
- </package>
- <package name="org.apache.hadoop.yarn.client">
- <!-- start class org.apache.hadoop.yarn.client.AHSProxy -->
- <class name="AHSProxy" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AHSProxy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createAHSProxy" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="protocol" type="java.lang.Class"/>
- <param name="ahsAddress" type="java.net.InetSocketAddress"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProxy" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="protocol" type="java.lang.Class"/>
- <param name="rmAddress" type="java.net.InetSocketAddress"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.client.AHSProxy -->
- <!-- start class org.apache.hadoop.yarn.client.ClientRMProxy -->
- <class name="ClientRMProxy" extends="org.apache.hadoop.yarn.client.RMProxy"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="createRMProxy" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
- <param name="protocol" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a proxy to the ResourceManager for the specified protocol.
- @param configuration Configuration with all the required information.
- @param protocol Client protocol for which proxy is being requested.
- @param <T> Type of proxy.
- @return Proxy to the ResourceManager for the specified client protocol.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getRMDelegationTokenService" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the token service name to be used for RMDelegationToken. Depending
- on whether HA is enabled or not, this method generates the appropriate
- service name as a comma-separated list of service addresses.
- @param conf Configuration corresponding to the cluster we need the
- RMDelegationToken for
- @return - Service name for RMDelegationToken]]>
- </doc>
- </method>
- <method name="getAMRMTokenService" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getTokenService" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="address" type="java.lang.String"/>
- <param name="defaultAddr" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.client.ClientRMProxy -->
- <!-- start class org.apache.hadoop.yarn.client.NMProxy -->
- <class name="NMProxy" extends="org.apache.hadoop.yarn.client.ServerProxy"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NMProxy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createNMProxy" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="protocol" type="java.lang.Class"/>
- <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="rpc" type="org.apache.hadoop.yarn.ipc.YarnRPC"/>
- <param name="serverAddress" type="java.net.InetSocketAddress"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.client.NMProxy -->
- <!-- start class org.apache.hadoop.yarn.client.RMProxy -->
- <class name="RMProxy" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RMProxy"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="createRetryPolicy" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="retryTime" type="long"/>
- <param name="retryInterval" type="long"/>
- <param name="isHAEnabled" type="boolean"/>
- <doc>
- <![CDATA[Fetch retry policy from Configuration and create the
- retry policy with specified retryTime and retry interval.]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.client.RMProxy -->
- <!-- start class org.apache.hadoop.yarn.client.ServerProxy -->
- <class name="ServerProxy" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ServerProxy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createRetryPolicy" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="maxWaitTimeStr" type="java.lang.String"/>
- <param name="defMaxWaitTime" type="long"/>
- <param name="connectRetryIntervalStr" type="java.lang.String"/>
- <param name="defRetryInterval" type="long"/>
- </method>
- <method name="createRetriableProxy" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="protocol" type="java.lang.Class"/>
- <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="rpc" type="org.apache.hadoop.yarn.ipc.YarnRPC"/>
- <param name="serverAddress" type="java.net.InetSocketAddress"/>
- <param name="retryPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.client.ServerProxy -->
- </package>
- <package name="org.apache.hadoop.yarn.client.api">
- <!-- start class org.apache.hadoop.yarn.client.api.AppAdminClient -->
- <class name="AppAdminClient" extends="org.apache.hadoop.service.CompositeService"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AppAdminClient"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="createAppAdminClient" return="org.apache.hadoop.yarn.client.api.AppAdminClient"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appType" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[<p>
- Create a new instance of AppAdminClient.
- </p>
- @param appType application type
- @param conf configuration
- @return app admin client]]>
- </doc>
- </method>
- <method name="actionLaunch" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fileName" type="java.lang.String"/>
- <param name="appName" type="java.lang.String"/>
- <param name="lifetime" type="java.lang.Long"/>
- <param name="queue" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Launch a new YARN application.
- </p>
- @param fileName specification of application
- @param appName name of the application
- @param lifetime lifetime of the application
- @param queue queue of the application
- @return exit code
- @throws IOException IOException
- @throws YarnException exception in client or server]]>
- </doc>
- </method>
- <method name="actionStop" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Stop a YARN application (attempt to stop gracefully before killing the
- application). In the case of a long-running service, the service may be
- restarted later.
- </p>
- @param appName the name of the application
- @return exit code
- @throws IOException IOException
- @throws YarnException exception in client or server]]>
- </doc>
- </method>
- <method name="actionStart" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Start a YARN application from a previously saved specification. In the
- case of a long-running service, the service must have been previously
- launched/started and then stopped, or previously saved but not started.
- </p>
- @param appName the name of the application
- @return exit code
- @throws IOException IOException
- @throws YarnException exception in client or server]]>
- </doc>
- </method>
- <method name="actionSave" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fileName" type="java.lang.String"/>
- <param name="appName" type="java.lang.String"/>
- <param name="lifetime" type="java.lang.Long"/>
- <param name="queue" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Save the specification for a YARN application / long-running service.
- The application may be started later.
- </p>
- @param fileName specification of application to save
- @param appName name of the application
- @param lifetime lifetime of the application
- @param queue queue of the application
- @return exit code
- @throws IOException IOException
- @throws YarnException exception in client or server]]>
- </doc>
- </method>
- <method name="actionDestroy" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Remove the specification and all application data for a YARN application.
- The application cannot be running.
- </p>
- @param appName the name of the application
- @return exit code
- @throws IOException IOException
- @throws YarnException exception in client or server]]>
- </doc>
- </method>
- <method name="actionFlex" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <param name="componentCounts" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Change the number of running containers for a component of a YARN
- application / long-running service.
- </p>
- @param appName the name of the application
- @param componentCounts map of component name to new component count or
- amount to change existing component count (e.g.
- 5, +5, -5)
- @return exit code
- @throws IOException IOException
- @throws YarnException exception in client or server]]>
- </doc>
- </method>
- <method name="enableFastLaunch" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="destinationFolder" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Upload AM dependencies to HDFS. This makes future application launches
- faster since the dependencies do not have to be uploaded on each launch.
- </p>
- @param destinationFolder
- an optional HDFS folder where dependency tarball will be uploaded
- @return exit code
- @throws IOException
- IOException
- @throws YarnException
- exception in client or server]]>
- </doc>
- </method>
- <method name="getStatusString" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appIdOrName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Get detailed app specific status string for a YARN application.
- </p>
- @param appIdOrName appId or appName
- @return status string
- @throws IOException IOException
- @throws YarnException exception in client or server]]>
- </doc>
- </method>
- <method name="initiateUpgrade" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <param name="fileName" type="java.lang.String"/>
- <param name="autoFinalize" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[Initiate upgrade of a long running service.
- @param appName the name of the application.
- @param fileName specification of application upgrade to save.
- @param autoFinalize when true, finalization of upgrade will be done
- automatically.
- @return exit code
- @throws IOException IOException
- @throws YarnException exception in client or server]]>
- </doc>
- </method>
- <method name="actionUpgradeInstances" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <param name="componentInstances" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[Upgrade component instances of a long running service.
- @param appName the name of the application.
- @param componentInstances the name of the component instances.]]>
- </doc>
- </method>
- <method name="actionUpgradeComponents" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <param name="components" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[Upgrade components of a long running service.
- @param appName the name of the application.
- @param components the name of the components.]]>
- </doc>
- </method>
- <method name="actionCleanUp" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <param name="userName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[Operation to be performed by the RM after an application has completed.
- @param appName the name of the application.
- @param userName the name of the user.
- @return exit code]]>
- </doc>
- </method>
- <method name="getInstances" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <param name="components" type="java.util.List"/>
- <param name="version" type="java.lang.String"/>
- <param name="containerStates" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- </method>
- <method name="actionUpgradeExpress" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <param name="fileName" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[Express upgrade a long running service.
- @param appName the name of the application
- @param fileName specification of application upgrade to save.
- @return exit code]]>
- </doc>
- </method>
- <method name="actionCancelUpgrade" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[Cancels the upgrade of the service.
- @param appName the name of the application
- @return exit code
- @throws IOException
- @throws YarnException]]>
- </doc>
- </method>
- <field name="YARN_APP_ADMIN_CLIENT_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CLASS_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="UNIT_TEST_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="UNIT_TEST_CLASS_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Client for managing applications.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.client.api.AppAdminClient -->
- <!-- start class org.apache.hadoop.yarn.client.api.TimelineClient -->
- <class name="TimelineClient" extends="org.apache.hadoop.service.CompositeService"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Flushable"/>
- <constructor name="TimelineClient" type="java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="createTimelineClient" return="org.apache.hadoop.yarn.client.api.TimelineClient"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an instance of the timeline v.1.x client.
- The current UGI when the user initialize the client will be used to do the
- put and the delegation token operations. The current user may use
- {@link UserGroupInformation#doAs} another user to construct and initialize
- a timeline client if the following operations are supposed to be conducted
- by that user.
- @return the created timeline client instance]]>
- </doc>
- </method>
- <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- 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.
- </p>
-
- @param entities
- the collection of {@link TimelineEntity}
- @return the error information if the sent entities are not correctly stored
- @throws IOException if there are I/O errors
- @throws YarnException if entities are incomplete/invalid]]>
- </doc>
- </method>
- <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- <param name="groupId" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"/>
- <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- 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
- </p>
- @param appAttemptId {@link ApplicationAttemptId}
- @param groupId {@link TimelineEntityGroupId}
- @param entities
- the collection of {@link TimelineEntity}
- @return the error information if the sent entities are not correctly stored
- @throws IOException if there are I/O errors
- @throws YarnException if entities are incomplete/invalid]]>
- </doc>
- </method>
- <method name="putDomain"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- 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.
- </p>
-
- @param domain
- an {@link TimelineDomain} object
- @throws IOException
- @throws YarnException]]>
- </doc>
- </method>
- <method name="putDomain"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- 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
- </p>
- @param domain
- an {@link TimelineDomain} object
- @param appAttemptId {@link ApplicationAttemptId}
- @throws IOException
- @throws YarnException]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Get a delegation token so as to be able to talk to the timeline server in a
- secure way.
- </p>
-
- @param renewer
- Address of the renewer who can renew these tokens when needed by
- securely talking to the timeline server
- @return a delegation token ({@link Token}) that can be used to talk to the
- timeline server
- @throws IOException
- @throws YarnException]]>
- </doc>
- </method>
- <method name="renewDelegationToken" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Renew a timeline delegation token.
- </p>
-
- @param timelineDT
- the delegation token to renew
- @return the new expiration time
- @throws IOException
- @throws YarnException]]>
- </doc>
- </method>
- <method name="cancelDelegationToken"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[<p>
- Cancel a timeline delegation token.
- </p>
-
- @param timelineDT
- the delegation token to cancel
- @throws IOException
- @throws YarnException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A client library that can be used to post some information in terms of a
- number of conceptual entities. This client library needs to be used along
- with Timeline V.1.x server versions.
- Refer {@link TimelineV2Client} for ATS V2 interface.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.client.api.TimelineClient -->
- <!-- start class org.apache.hadoop.yarn.client.api.TimelineReaderClient -->
- <class name="TimelineReaderClient" extends="org.apache.hadoop.service.CompositeService"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineReaderClient" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createTimelineReaderClient" return="org.apache.hadoop.yarn.client.api.TimelineReaderClient"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new instance of Timeline Reader Client.]]>
- </doc>
- </method>
- <method name="getApplicationEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets application entity.
- @param appId application id
- @param fields Fields to be fetched. Defaults to INFO.
- @param filters Filters to be applied while fetching entities.
- @return entity of the application
- @throws IOException]]>
- </doc>
- </method>
- <method name="getApplicationAttemptEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets application attempt entity.
- @param appAttemptId application attempt id
- @param fields Fields to be fetched. Defaults to INFO.
- @param filters Filters to be applied while fetching entities.
- @return entity associated with application attempt
- @throws IOException]]>
- </doc>
- </method>
- <method name="getApplicationAttemptEntities" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <param name="limit" type="long"/>
- <param name="fromId" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets application attempt entities.
- @param appId application id
- @param fields Fields to be fetched. Defaults to INFO.
- @param filters Filters to be applied while fetching entities.
- @param limit Number of entities to return.
- @param fromId Retrieve next set of generic ids from given fromId
- @return list of application attempt entities
- @throws IOException]]>
- </doc>
- </method>
- <method name="getContainerEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets Timeline entity for the container.
- @param containerId container id
- @param fields Fields to be fetched. Defaults to INFO.
- @param filters Filters to be applied while fetching entities.
- @return timeline entity for container
- @throws IOException]]>
- </doc>
- </method>
- <method name="getContainerEntities" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <param name="limit" type="long"/>
- <param name="fromId" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets container entities for an application.
- @param appId application id
- @param fields Fields to be fetched. Defaults to INFO.
- @param filters Filters to be applied while fetching entities.
- @param limit Number of entities to return.
- @param fromId Retrieve next set of generic ids from given fromId
- @return list of entities
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A client library that can be used to get Timeline Entities associated with
- application, application attempt or containers. This client library needs to
- be used along with time line v.2 server version.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.client.api.TimelineReaderClient -->
- </package>
- <package name="org.apache.hadoop.yarn.client.api.impl">
- <!-- start class org.apache.hadoop.yarn.client.api.impl.TimelineReaderClientImpl -->
- <class name="TimelineReaderClientImpl" extends="org.apache.hadoop.yarn.client.api.TimelineReaderClient"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineReaderClientImpl"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="serviceInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="getApplicationEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getApplicationAttemptEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getApplicationAttemptEntities" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <param name="limit" type="long"/>
- <param name="fromId" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getContainerEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getContainerEntities" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="fields" type="java.lang.String"/>
- <param name="filters" type="java.util.Map"/>
- <param name="limit" type="long"/>
- <param name="fromId" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="doGetUri" return="com.sun.jersey.api.client.ClientResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="base" type="java.net.URI"/>
- <param name="path" type="java.lang.String"/>
- <param name="params" type="javax.ws.rs.core.MultivaluedMap"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implementation of TimelineReaderClient interface.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.client.api.impl.TimelineReaderClientImpl -->
- </package>
- <package name="org.apache.hadoop.yarn.event">
- <!-- start class org.apache.hadoop.yarn.event.AbstractEvent -->
- <class name="AbstractEvent" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.yarn.event.Event"/>
- <constructor name="AbstractEvent" type="TYPE"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AbstractEvent" type="TYPE, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTimestamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getType" return="TYPE"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Parent class of all the events. All events extend this class.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.event.AbstractEvent -->
- <!-- start class org.apache.hadoop.yarn.event.AsyncDispatcher -->
- <class name="AsyncDispatcher" extends="org.apache.hadoop.service.AbstractService"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.yarn.event.Dispatcher"/>
- <constructor name="AsyncDispatcher"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AsyncDispatcher" type="java.util.concurrent.BlockingQueue"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AsyncDispatcher" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set a name for this dispatcher thread.
- @param dispatcherName name of the dispatcher thread]]>
- </doc>
- </constructor>
- <method name="disableExitOnDispatchException"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="serviceStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="setDrainEventsOnStop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="serviceStop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="dispatch"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="event" type="org.apache.hadoop.yarn.event.Event"/>
- </method>
- <method name="register"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventType" type="java.lang.Class"/>
- <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
- </method>
- <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isEventThreadWaiting" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="isDrained" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="isStopped" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <field name="eventDispatchers" type="java.util.Map"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Dispatches {@link Event}s in a separate thread. Currently only single thread
- does that. Potentially there could be multiple channels for each event type
- class and a thread pool can be used to dispatch the events.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.event.AsyncDispatcher -->
- <!-- start interface org.apache.hadoop.yarn.event.Dispatcher -->
- <interface name="Dispatcher" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="register"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventType" type="java.lang.Class"/>
- <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
- </method>
- <doc>
- <![CDATA[Event Dispatcher interface. It dispatches events to registered
- event handlers based on event types.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.event.Dispatcher -->
- <!-- start interface org.apache.hadoop.yarn.event.Event -->
- <interface name="Event" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getType" return="TYPE"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTimestamp" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Interface defining events api.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.event.Event -->
- <!-- start interface org.apache.hadoop.yarn.event.EventHandler -->
- <interface name="EventHandler" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="handle"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="T"/>
- </method>
- <doc>
- <![CDATA[Interface for handling events of type T
- @param <T> parameterized event of type T]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.event.EventHandler -->
- </package>
- <package name="org.apache.hadoop.yarn.factories">
- </package>
- <package name="org.apache.hadoop.yarn.factory.providers">
- </package>
- <package name="org.apache.hadoop.yarn.logaggregation">
- <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
- <class name="AggregatedLogFormat" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AggregatedLogFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
- <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
- <class name="AggregatedLogFormat.LogKey" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="LogKey"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="LogKey" type="org.apache.hadoop.yarn.api.records.ContainerId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="LogKey" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
- <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
- <class name="AggregatedLogFormat.LogReader" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LogReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getApplicationOwner" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the owner of the application.
- @return the application owner.
- @throws IOException if we can not get the application owner.]]>
- </doc>
- </method>
- <method name="getApplicationAcls" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns ACLs for the application. An empty map is returned if no ACLs are
- found.
- @return a map of the Application ACLs.
- @throws IOException if we can not get the application acls.]]>
- </doc>
- </method>
- <method name="next" return="java.io.DataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the next key and return the value-stream.
-
- @param key the log key
- @return the valueStream if there are more keys or null otherwise
- @throws IOException if we can not get the dataInputStream
- for the next key]]>
- </doc>
- </method>
- <method name="readAcontainerLogs"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="valueStream" type="java.io.DataInputStream"/>
- <param name="writer" type="java.io.Writer"/>
- <param name="logUploadedTime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes all logs for a single container to the provided writer.
- @param valueStream the valueStream
- @param writer the log writer
- @param logUploadedTime the time stamp
- @throws IOException if we can not read the container logs.]]>
- </doc>
- </method>
- <method name="readAcontainerLogs"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="valueStream" type="java.io.DataInputStream"/>
- <param name="writer" type="java.io.Writer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes all logs for a single container to the provided writer.
- @param valueStream the value stream
- @param writer the log writer
- @throws IOException if we can not read the container logs.]]>
- </doc>
- </method>
- <method name="readAContainerLogsForALogType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="valueStream" type="java.io.DataInputStream"/>
- <param name="out" type="java.io.PrintStream"/>
- <param name="logUploadedTime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
- all types for a single container.
-
- @param valueStream the value stream
- @param out the print stream
- @param logUploadedTime the time stamp
- @throws IOException if we can not read the container log by specifying
- the container log type.]]>
- </doc>
- </method>
- <method name="readAContainerLogsForALogType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="valueStream" type="java.io.DataInputStream"/>
- <param name="out" type="java.io.PrintStream"/>
- <param name="logUploadedTime" type="long"/>
- <param name="bytes" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
- all types for a single container for the specific bytes.
- @param valueStream the value stream
- @param out the output print stream
- @param logUploadedTime the log upload time stamp
- @param bytes the output size of the log
- @throws IOException if we can not read the container log]]>
- </doc>
- </method>
- <method name="readAContainerLogsForALogType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="valueStream" type="java.io.DataInputStream"/>
- <param name="out" type="java.io.PrintStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
- all types for a single container.
-
- @param valueStream the value stream
- @param out the output print stream
- @throws IOException if we can not read the container log]]>
- </doc>
- </method>
- <method name="readContainerLogsForALogType" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="valueStream" type="java.io.DataInputStream"/>
- <param name="out" type="java.io.PrintStream"/>
- <param name="logUploadedTime" type="long"/>
- <param name="logType" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
- the specific types for a single container.
- @param valueStream the value stream
- @param out the output print stream
- @param logUploadedTime the log uploaded time stamp
- @param logType the given log type
- @throws IOException if we can not read the container logs]]>
- </doc>
- </method>
- <method name="readContainerLogsForALogType" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="valueStream" type="java.io.DataInputStream"/>
- <param name="out" type="java.io.PrintStream"/>
- <param name="logUploadedTime" type="long"/>
- <param name="logType" type="java.util.List"/>
- <param name="bytes" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
- the specific types for a single container.
- @param valueStream the value stream
- @param out the output print stream
- @param logUploadedTime the log uploaded time stamp
- @param logType the given log type
- @throws IOException if we can not read the container logs]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
- </package>
- <package name="org.apache.hadoop.yarn.logaggregation.filecontroller">
- </package>
- <package name="org.apache.hadoop.yarn.logaggregation.filecontroller.ifile">
- </package>
- <package name="org.apache.hadoop.yarn.logaggregation.filecontroller.tfile">
- </package>
- <package name="org.apache.hadoop.yarn.nodelabels">
- </package>
- <package name="org.apache.hadoop.yarn.nodelabels.event">
- </package>
- <package name="org.apache.hadoop.yarn.security">
- <!-- start class org.apache.hadoop.yarn.security.AccessRequest -->
- <class name="AccessRequest" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AccessRequest" type="org.apache.hadoop.yarn.security.PrivilegedEntity, org.apache.hadoop.security.UserGroupInformation, org.apache.hadoop.yarn.security.AccessType, java.lang.String, java.lang.String, java.lang.String, java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAccessType" return="org.apache.hadoop.yarn.security.AccessType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAppId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAppName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getEntity" return="org.apache.hadoop.yarn.security.PrivilegedEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getForwardedAddresses" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRemoteAddress" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This request object contains all the context information to determine whether
- a user has permission to access the target entity.
- user : the user who's currently accessing
- accessType : the access type against the entity.
- entity : the target object user is accessing.
- appId : the associated app Id for current access. This could be null
- if no app is associated.
- appName : the associated app name for current access. This could be null if
- no app is associated.
- remoteAddress : The caller's remote ip address.
- forwardedAddresses : In case this is an http request, this contains the
- originating IP address of a client connecting to a web
- server through an HTTP proxy or load balancer. This
- parameter is null, if it's a RPC request.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.AccessRequest -->
- <!-- start class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
- <class name="AMRMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AMRMTokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AMRMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getKeyId" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.AMRMTokenIdentifierProto"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[AMRMTokenIdentifier is the TokenIdentifier to be used by
- ApplicationMasters to authenticate to the ResourceManager.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
- <!-- start class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
- <class name="AMRMTokenSelector" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.token.TokenSelector"/>
- <constructor name="AMRMTokenSelector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="selectToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.io.Text"/>
- <param name="tokens" type="java.util.Collection"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
- <!-- start class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
- <class name="ContainerManagerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerManagerSecurityInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
- <!-- start class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
- <class name="ContainerTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext"
- static="false" final="false" visibility="public"
- deprecated="Use one of the other constructors instead.">
- <doc>
- <![CDATA[Creates a instance.
- @param appSubmitter appSubmitter
- @param containerID container ID
- @param creationTime creation time
- @param expiryTimeStamp expiry timestamp
- @param hostName hostname
- @param logAggregationContext log aggregation context
- @param masterKeyId master key ID
- @param priority priority
- @param r resource needed by the container
- @param rmIdentifier ResourceManager identifier
- @deprecated Use one of the other constructors instead.]]>
- </doc>
- </constructor>
- <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, int, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType, org.apache.hadoop.yarn.api.records.ExecutionType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, int, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType, org.apache.hadoop.yarn.api.records.ExecutionType, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convenience Constructor for existing clients.
- @param containerID containerID
- @param containerVersion containerVersion
- @param hostName hostName
- @param appSubmitter appSubmitter
- @param r resource
- @param expiryTimeStamp expiryTimeStamp
- @param masterKeyId masterKeyId
- @param rmIdentifier rmIdentifier
- @param priority priority
- @param creationTime creationTime
- @param logAggregationContext logAggregationContext
- @param nodeLabelExpression nodeLabelExpression
- @param containerType containerType
- @param executionType executionType
- @param allocationRequestId allocationRequestId]]>
- </doc>
- </constructor>
- <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, int, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType, org.apache.hadoop.yarn.api.records.ExecutionType, long, java.util.Set"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a Container Token Identifier.
- @param containerID containerID
- @param containerVersion containerVersion
- @param hostName hostName
- @param appSubmitter appSubmitter
- @param r resource
- @param expiryTimeStamp expiryTimeStamp
- @param masterKeyId masterKeyId
- @param rmIdentifier rmIdentifier
- @param priority priority
- @param creationTime creationTime
- @param logAggregationContext logAggregationContext
- @param nodeLabelExpression nodeLabelExpression
- @param containerType containerType
- @param executionType executionType
- @param allocationRequestId allocationRequestId
- @param allocationTags Set of allocation Tags.]]>
- </doc>
- </constructor>
- <constructor name="ContainerTokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor needed by RPC layer/SecretManager.]]>
- </doc>
- </constructor>
- <method name="getContainerID" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getApplicationSubmitter" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNmHostAddress" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getExpiryTimeStamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMasterKeyId" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getCreationTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRMIdentifier" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the RMIdentifier of RM in which containers are allocated.
- @return RMIdentifier]]>
- </doc>
- </method>
- <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the ContainerType of container to allocate.
- @return ContainerType]]>
- </doc>
- </method>
- <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the ExecutionType of container to allocate
- @return ExecutionType]]>
- </doc>
- </method>
- <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ContainerTokenIdentifierProto"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAllocationRequestId" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getVersion" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Container version
- @return container version]]>
- </doc>
- </method>
- <method name="getNodeLabelExpression" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the node-label-expression in the original ResourceRequest]]>
- </doc>
- </method>
- <method name="getAllcationTags" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="KIND" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[TokenIdentifier for a container. Encodes {@link ContainerId},
- {@link Resource} needed by the container and the target NMs host-address.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
- <!-- start class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
- <class name="ContainerTokenSelector" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.token.TokenSelector"/>
- <constructor name="ContainerTokenSelector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="selectToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.io.Text"/>
- <param name="tokens" type="java.util.Collection"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
- <!-- start class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
- <class name="NMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, org.apache.hadoop.yarn.api.records.NodeId, java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="NMTokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor needed by RPC/Secret manager]]>
- </doc>
- </constructor>
- <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getApplicationSubmitter" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getKeyId" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.NMTokenIdentifierProto"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="KIND" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
- <!-- start class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
- <class name="SchedulerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SchedulerSecurityInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
- </package>
- <package name="org.apache.hadoop.yarn.security.admin">
- <!-- start class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
- <class name="AdminSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AdminSecurityInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
- </package>
- <package name="org.apache.hadoop.yarn.security.client">
- <!-- start class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
- <class name="BaseClientToAMTokenSecretManager" extends="org.apache.hadoop.security.token.SecretManager"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BaseClientToAMTokenSecretManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A base {@link SecretManager} for AMs to extend and validate Client-RM tokens
- issued to clients by the RM using the underlying master-key shared by RM to
- the AMs on their launch. All the methods are called by either Hadoop RPC or
- YARN, so this class is strictly for the purpose of inherit/extend and
- register with Hadoop RPC.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
- <!-- start class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
- <class name="ClientRMSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ClientRMSecurityInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
- <!-- start class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
- <class name="ClientTimelineSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ClientTimelineSecurityInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
- <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
- <class name="ClientToAMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ClientToAMTokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ClientToAMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationAttemptID" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getClientName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ClientToAMTokenIdentifierProto"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
- <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
- <class name="ClientToAMTokenSecretManager" extends="org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ClientToAMTokenSecretManager" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="retrievePassword" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- </method>
- <method name="getMasterKey" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptID" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- </method>
- <method name="setMasterKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- </method>
- <doc>
- <![CDATA[A simple {@link SecretManager} for AMs to validate Client-RM tokens issued to
- clients by the RM using the underlying master-key shared by RM to the AMs on
- their launch. All the methods are called by either Hadoop RPC or YARN, so
- this class is strictly for the purpose of inherit/extend and register with
- Hadoop RPC.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
- <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
- <class name="RMDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RMDelegationTokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="RMDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new delegation token identifier
- @param owner the effective username of the token owner
- @param renewer the username of the renewer
- @param realUser the real username of the token owner]]>
- </doc>
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Delegation Token Identifier that identifies the delegation tokens from the
- Resource Manager.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
- <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
- <class name="RMDelegationTokenSelector" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.token.TokenSelector"/>
- <constructor name="RMDelegationTokenSelector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="selectToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.io.Text"/>
- <param name="tokens" type="java.util.Collection"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
- <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
- <class name="TimelineDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineDelegationTokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TimelineDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new timeline delegation token identifier
- @param owner the effective username of the token owner
- @param renewer the username of the renewer
- @param realUser the real username of the token owner]]>
- </doc>
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
- <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
- <class name="TimelineDelegationTokenSelector" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.token.TokenSelector"/>
- <constructor name="TimelineDelegationTokenSelector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="selectToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.io.Text"/>
- <param name="tokens" type="java.util.Collection"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
- </package>
- <package name="org.apache.hadoop.yarn.server.api">
- </package>
- <package name="org.apache.hadoop.yarn.server.api.impl.pb.client">
- </package>
- <package name="org.apache.hadoop.yarn.server.api.impl.pb.service">
- </package>
- <package name="org.apache.hadoop.yarn.sharedcache">
- <!-- start interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
- <interface name="SharedCacheChecksum" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="computeChecksum" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Calculate the checksum of the passed input stream.
- @param in <code>InputStream</code> to be checksumed
- @return the message digest of the input stream
- @throws IOException]]>
- </doc>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
- <!-- start class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
- <class name="SharedCacheChecksumFactory" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SharedCacheChecksumFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getChecksum" return="org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get a new <code>SharedCacheChecksum</code> object based on the configurable
- algorithm implementation
- (see <code>yarn.sharedcache.checksum.algo.impl</code>)
- @return <code>SharedCacheChecksum</code> object]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
- </package>
- <package name="org.apache.hadoop.yarn.state">
- <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
- <class name="InvalidStateTransitionException" extends="org.apache.hadoop.yarn.state.InvalidStateTransitonException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidStateTransitionException" type="java.lang.Enum, java.lang.Enum"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[The exception that happens when you call invalid state transition.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
- <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
- <class name="InvalidStateTransitonException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link InvalidStateTransitionException} instead.">
- <constructor name="InvalidStateTransitonException" type="java.lang.Enum, java.lang.Enum"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getCurrentState" return="java.lang.Enum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getEvent" return="java.lang.Enum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[@deprecated Use {@link InvalidStateTransitionException} instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
- <!-- start interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
- <interface name="MultipleArcTransition" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="transition" return="STATE"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="operand" type="OPERAND"/>
- <param name="event" type="EVENT"/>
- <doc>
- <![CDATA[Transition hook.
- @return the postState. Post state must be one of the
- valid post states registered in StateMachine.
- @param operand the entity attached to the FSM, whose internal
- state may change.
- @param event causal event]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Hook for Transition.
- Post state is decided by Transition hook. Post state must be one of the
- valid post states registered in StateMachine.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
- <!-- start interface org.apache.hadoop.yarn.state.SingleArcTransition -->
- <interface name="SingleArcTransition" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="transition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="operand" type="OPERAND"/>
- <param name="event" type="EVENT"/>
- <doc>
- <![CDATA[Transition hook.
-
- @param operand the entity attached to the FSM, whose internal
- state may change.
- @param event causal event]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Hook for Transition. This lead to state machine to move to
- the post state as registered in the state machine.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.state.SingleArcTransition -->
- <!-- start interface org.apache.hadoop.yarn.state.StateMachine -->
- <interface name="StateMachine" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getCurrentState" return="STATE"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="doTransition" return="STATE"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventType" type="EVENTTYPE"/>
- <param name="event" type="EVENT"/>
- <exception name="InvalidStateTransitionException" type="org.apache.hadoop.yarn.state.InvalidStateTransitionException"/>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.state.StateMachine -->
- <!-- start class org.apache.hadoop.yarn.state.StateMachineFactory -->
- <class name="StateMachineFactory" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="StateMachineFactory" type="STATE"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
- This is the only constructor in the API.]]>
- </doc>
- </constructor>
- <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="preState" type="STATE"/>
- <param name="postState" type="STATE"/>
- <param name="eventType" type="EVENTTYPE"/>
- <doc>
- <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
- transition added as a new legal transition. This overload
- has no hook object.
- Note that the returned StateMachineFactory is a distinct
- object.
- This method is part of the API.
- @param preState pre-transition state
- @param postState post-transition state
- @param eventType stimulus for the transition]]>
- </doc>
- </method>
- <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="preState" type="STATE"/>
- <param name="postState" type="STATE"/>
- <param name="eventTypes" type="java.util.Set"/>
- <doc>
- <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
- transition added as a new legal transition. This overload
- has no hook object.
- Note that the returned StateMachineFactory is a distinct
- object.
- This method is part of the API.
- @param preState pre-transition state
- @param postState post-transition state
- @param eventTypes List of stimuli for the transitions]]>
- </doc>
- </method>
- <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="preState" type="STATE"/>
- <param name="postState" type="STATE"/>
- <param name="eventTypes" type="java.util.Set"/>
- <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
- <doc>
- <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
- transition added as a new legal transition
- Note that the returned StateMachineFactory is a distinct
- object.
- This method is part of the API.
- @param preState pre-transition state
- @param postState post-transition state
- @param eventTypes List of stimuli for the transitions
- @param hook transition hook]]>
- </doc>
- </method>
- <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="preState" type="STATE"/>
- <param name="postState" type="STATE"/>
- <param name="eventType" type="EVENTTYPE"/>
- <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
- <doc>
- <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
- transition added as a new legal transition
- Note that the returned StateMachineFactory is a distinct object.
- This method is part of the API.
- @param preState pre-transition state
- @param postState post-transition state
- @param eventType stimulus for the transition
- @param hook transition hook]]>
- </doc>
- </method>
- <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="preState" type="STATE"/>
- <param name="postStates" type="java.util.Set"/>
- <param name="eventType" type="EVENTTYPE"/>
- <param name="hook" type="org.apache.hadoop.yarn.state.MultipleArcTransition"/>
- <doc>
- <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
- transition added as a new legal transition
- Note that the returned StateMachineFactory is a distinct object.
- This method is part of the API.
- @param preState pre-transition state
- @param postStates valid post-transition states
- @param eventType stimulus for the transition
- @param hook transition hook]]>
- </doc>
- </method>
- <method name="installTopology" return="org.apache.hadoop.yarn.state.StateMachineFactory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return a StateMachineFactory just like {@code this}, except that if
- you won't need any synchronization to build a state machine
- Note that the returned StateMachineFactory is a distinct object.
- This method is part of the API.
- The only way you could distinguish the returned
- StateMachineFactory from {@code this} would be by
- measuring the performance of the derived
- {@code StateMachine} you can get from it.
- Calling this is optional. It doesn't change the semantics of the factory,
- if you call it then when you use the factory there is no synchronization.]]>
- </doc>
- </method>
- <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="operand" type="OPERAND"/>
- <param name="initialState" type="STATE"/>
- <param name="listener" type="org.apache.hadoop.yarn.state.StateTransitionListener"/>
- <doc>
- <![CDATA[A StateMachine that accepts a transition listener.
- @param operand the object upon which the returned
- {@link StateMachine} will operate.
- @param initialState the state in which the returned
- {@link StateMachine} will start.
- @param listener An implementation of a {@link StateTransitionListener}.
- @return A (@link StateMachine}.]]>
- </doc>
- </method>
- <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="operand" type="OPERAND"/>
- <param name="initialState" type="STATE"/>
- </method>
- <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="operand" type="OPERAND"/>
- </method>
- <method name="generateStateGraph" return="org.apache.hadoop.yarn.state.Graph"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Generate a graph represents the state graph of this StateMachine
- @param name graph name
- @return Graph object generated]]>
- </doc>
- </method>
- <doc>
- <![CDATA[State machine topology.
- This object is semantically immutable. If you have a
- StateMachineFactory there's no operation in the API that changes
- its semantic properties.
- @param <OPERAND> The object type on which this state machine operates.
- @param <STATE> The state of the entity.
- @param <EVENTTYPE> The external eventType to be handled.
- @param <EVENT> The event object.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.state.StateMachineFactory -->
- <!-- start interface org.apache.hadoop.yarn.state.StateTransitionListener -->
- <interface name="StateTransitionListener" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="preTransition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="op" type="OPERAND"/>
- <param name="beforeState" type="STATE"/>
- <param name="eventToBeProcessed" type="EVENT"/>
- <doc>
- <![CDATA[Pre Transition Hook. This will be called before transition.
- @param op Operand.
- @param beforeState State before transition.
- @param eventToBeProcessed Incoming Event.]]>
- </doc>
- </method>
- <method name="postTransition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="op" type="OPERAND"/>
- <param name="beforeState" type="STATE"/>
- <param name="afterState" type="STATE"/>
- <param name="processedEvent" type="EVENT"/>
- <doc>
- <![CDATA[Post Transition Hook. This will be called after the transition.
- @param op Operand.
- @param beforeState State before transition.
- @param afterState State after transition.
- @param processedEvent Processed Event.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A State Transition Listener.
- It exposes a pre and post transition hook called before and
- after the transition.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.state.StateTransitionListener -->
- </package>
- <package name="org.apache.hadoop.yarn.util">
- <!-- start class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
- <class name="AbstractLivelinessMonitor" extends="org.apache.hadoop.service.AbstractService"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AbstractLivelinessMonitor" type="java.lang.String, org.apache.hadoop.yarn.util.Clock"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AbstractLivelinessMonitor" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="serviceStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="serviceStop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="expire"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="ob" type="O"/>
- </method>
- <method name="setExpireInterval"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="expireInterval" type="int"/>
- </method>
- <method name="getExpireInterval" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="o" type="O"/>
- </method>
- <method name="setMonitorInterval"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="monitorInterval" type="long"/>
- </method>
- <method name="receivedPing"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ob" type="O"/>
- </method>
- <method name="register"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ob" type="O"/>
- </method>
- <method name="register"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ob" type="O"/>
- <param name="expireTime" type="long"/>
- </method>
- <method name="unregister"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ob" type="O"/>
- </method>
- <method name="resetTimer"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setResetTimeOnStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="resetTimeOnStart" type="boolean"/>
- </method>
- <field name="DEFAULT_EXPIRE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A simple liveliness monitor with which clients can register, trust the
- component to monitor liveliness, get a call-back on expiry and then finally
- unregister.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
- <!-- start class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
- <class name="ApplicationClassLoader" extends="org.apache.hadoop.util.ApplicationClassLoader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationClassLoader" type="java.net.URL[], java.lang.ClassLoader, java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationClassLoader" type="java.lang.String, java.lang.ClassLoader, java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="MalformedURLException" type="java.net.MalformedURLException"/>
- </constructor>
- <doc>
- <![CDATA[This type has been deprecated in favor of
- {@link org.apache.hadoop.util.ApplicationClassLoader}. All new uses of
- ApplicationClassLoader should use that type instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
- <!-- start class org.apache.hadoop.yarn.util.BoundedAppender -->
- <class name="BoundedAppender" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BoundedAppender" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="append" return="org.apache.hadoop.yarn.util.BoundedAppender"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="csq" type="java.lang.CharSequence"/>
- <doc>
- <![CDATA[Append a {@link CharSequence} considering {@link #limit}, truncating
- from the head of {@code csq} or {@link #messages} when necessary.
- @param csq the {@link CharSequence} to append
- @return this]]>
- </doc>
- </method>
- <method name="length" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get current length of messages considering truncates
- without header and ellipses.
- @return current length]]>
- </doc>
- </method>
- <method name="getLimit" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a string representation of the actual contents, displaying also a
- header and ellipses when there was a truncate.
- @return String representation of the {@link #messages}]]>
- </doc>
- </method>
- <field name="TRUNCATED_MESSAGES_TEMPLATE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A {@link CharSequence} appender that considers its {@link #limit} as upper
- bound.
- <p>
- When {@link #limit} would be reached on append, past messages will be
- truncated from head, and a header telling the user about truncation will be
- prepended, with ellipses in between header and messages.
- <p>
- Note that header and ellipses are not counted against {@link #limit}.
- <p>
- An example:
- <pre>
- {@code
- // At the beginning it's an empty string
- final Appendable shortAppender = new BoundedAppender(80);
- // The whole message fits into limit
- shortAppender.append(
- "message1 this is a very long message but fitting into limit\n");
- // The first message is truncated, the second not
- shortAppender.append("message2 this is shorter than the previous one\n");
- // The first message is deleted, the second truncated, the third
- // preserved
- shortAppender.append("message3 this is even shorter message, maybe.\n");
- // The first two are deleted, the third one truncated, the last preserved
- shortAppender.append("message4 the shortest one, yet the greatest :)");
- // Current contents are like this:
- // Diagnostic messages truncated, showing last 80 chars out of 199:
- // ...s is even shorter message, maybe.
- // message4 the shortest one, yet the greatest :)
- }
- </pre>
- <p>
- Note that <tt>null</tt> values are {@link #append(CharSequence) append}ed
- just like in {@link StringBuilder#append(CharSequence) original
- implementation}.
- <p>
- Note that this class is not thread safe.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.BoundedAppender -->
- <!-- start interface org.apache.hadoop.yarn.util.Clock -->
- <interface name="Clock" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A simple clock interface that gives you time.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.util.Clock -->
- <!-- start class org.apache.hadoop.yarn.util.ConverterUtils -->
- <class name="ConverterUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ConverterUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPathFromYarnURL" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
- <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
- <doc>
- <![CDATA[return a hadoop path from a given url
- This method is deprecated, use {@link URL#toPath()} instead.
-
- @param url
- url to convert
- @return path from {@link URL}
- @throws URISyntaxException]]>
- </doc>
- </method>
- <method name="getYarnUrlFromPath" return="org.apache.hadoop.yarn.api.records.URL"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getYarnUrlFromURI" return="org.apache.hadoop.yarn.api.records.URL"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="recordFactory" type="org.apache.hadoop.yarn.factories.RecordFactory"/>
- <param name="applicationIdStr" type="java.lang.String"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="toNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeIdStr" type="java.lang.String"/>
- </method>
- <method name="toContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIdStr" type="java.lang.String"/>
- </method>
- <method name="toApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptIdStr" type="java.lang.String"/>
- </method>
- <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appIdStr" type="java.lang.String"/>
- </method>
- <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
- <param name="serviceAddr" type="java.net.InetSocketAddress"/>
- <doc>
- <![CDATA[Convert a protobuf token into a rpc token and set its service. Supposed
- to be used for tokens other than RMDelegationToken. For
- RMDelegationToken, use
- {@link #convertFromYarn(org.apache.hadoop.yarn.api.records.Token,
- org.apache.hadoop.io.Text)} instead.
- @param protoToken the yarn token
- @param serviceAddr the connect address for the service
- @return rpc token]]>
- </doc>
- </method>
- <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
- <param name="service" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Convert a protobuf token into a rpc token and set its service.
- @param protoToken the yarn token
- @param service the service for the token]]>
- </doc>
- </method>
- <field name="APPLICATION_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONTAINER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_ATTEMPT_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class contains a set of utilities which help converting data structures
- from/to 'serializableFormat' to/from hadoop/nativejava data structures.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.ConverterUtils -->
- <!-- start class org.apache.hadoop.yarn.util.MonotonicClock -->
- <class name="MonotonicClock" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.yarn.util.Clock"/>
- <constructor name="MonotonicClock"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get current time from some arbitrary time base in the past, counting in
- milliseconds, and not affected by settimeofday or similar system clock
- changes.
- @return a monotonic clock that counts in milliseconds.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A monotonic clock from some arbitrary time base in the past, counting in
- milliseconds, and not affected by settimeofday or similar system clock
- changes.
- This is appropriate to use when computing how much longer to wait for an
- interval to expire.
- This function can return a negative value and it must be handled correctly
- by callers. See the documentation of System#nanoTime for caveats.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.MonotonicClock -->
- <!-- start class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
- <class name="ResourceCalculatorProcessTree" extends="org.apache.hadoop.conf.Configured"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceCalculatorProcessTree" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create process-tree instance with specified root process.
- Subclass must override this.
- @param root process-tree root-process]]>
- </doc>
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <doc>
- <![CDATA[Initialize the object.
- @throws YarnException Throws an exception on error.]]>
- </doc>
- </method>
- <method name="updateProcessTree"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Update the process-tree with latest state.
- Each call to this function should increment the age of the running
- processes that already exist in the process tree. Age is used other API's
- of the interface.]]>
- </doc>
- </method>
- <method name="getProcessTreeDump" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a dump of the process-tree.
- @return a string concatenating the dump of information of all the processes
- in the process-tree]]>
- </doc>
- </method>
- <method name="getVirtualMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the virtual memory used by all the processes in the
- process-tree.
- @return virtual memory used by the process-tree in bytes,
- {@link #UNAVAILABLE} if it cannot be calculated.]]>
- </doc>
- </method>
- <method name="getRssMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the resident set size (rss) memory used by all the processes
- in the process-tree.
- @return rss memory used by the process-tree in bytes,
- {@link #UNAVAILABLE} if it cannot be calculated.]]>
- </doc>
- </method>
- <method name="getVirtualMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="olderThanAge" type="int"/>
- <doc>
- <![CDATA[Get the virtual memory used by all the processes in the
- process-tree that are older than the passed in age.
- @param olderThanAge processes above this age are included in the
- memory addition
- @return virtual memory used by the process-tree in bytes for
- processes older than the specified age, {@link #UNAVAILABLE} if it
- cannot be calculated.]]>
- </doc>
- </method>
- <method name="getRssMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="olderThanAge" type="int"/>
- <doc>
- <![CDATA[Get the resident set size (rss) memory used by all the processes
- in the process-tree that are older than the passed in age.
- @param olderThanAge processes above this age are included in the
- memory addition
- @return rss memory used by the process-tree in bytes for
- processes older than specified age, {@link #UNAVAILABLE} if it cannot be
- calculated.]]>
- </doc>
- </method>
- <method name="getCumulativeCpuTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the CPU time in millisecond used by all the processes in the
- process-tree since the process-tree was created
- @return cumulative CPU time in millisecond since the process-tree
- created, {@link #UNAVAILABLE} if it cannot be calculated.]]>
- </doc>
- </method>
- <method name="getCpuUsagePercent" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the CPU usage by all the processes in the process-tree based on
- average between samples as a ratio of overall CPU cycles similar to top.
- Thus, if 2 out of 4 cores are used this should return 200.0.
- Note: UNAVAILABLE will be returned in case when CPU usage is not
- available. It is NOT advised to return any other error code.
- @return percentage CPU usage since the process-tree was created,
- {@link #UNAVAILABLE} if CPU usage cannot be calculated or not available.]]>
- </doc>
- </method>
- <method name="checkPidPgrpidForMatch" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Verify that the tree process id is same as its process group id.
- @return true if the process id matches else return false.]]>
- </doc>
- </method>
- <method name="getResourceCalculatorProcessTree" return="org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pid" type="java.lang.String"/>
- <param name="clazz" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Create the ResourceCalculatorProcessTree rooted to specified process
- from the class name and configure it. If class name is null, this method
- will try and return a process tree plugin available for this system.
- @param pid process pid of the root of the process tree
- @param clazz class-name
- @param conf configure the plugin with this.
- @return ResourceCalculatorProcessTree or null if ResourceCalculatorPluginTree
- is not available for this system.]]>
- </doc>
- </method>
- <field name="UNAVAILABLE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Interface class to obtain process resource usage
- NOTE: This class should not be used by external users, but only by external
- developers to extend and include their own process-tree implementation,
- especially for platforms other than Linux and Windows.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
- <!-- start class org.apache.hadoop.yarn.util.SystemClock -->
- <class name="SystemClock" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.yarn.util.Clock"/>
- <constructor name="SystemClock"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getInstance" return="org.apache.hadoop.yarn.util.SystemClock"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Implementation of {@link Clock} that gives the current time from the system
- clock in milliseconds.
-
- NOTE: Do not use this to calculate a duration of expire or interval to sleep,
- because it will be broken by settimeofday. Please use {@link MonotonicClock}
- instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.SystemClock -->
- <!-- start class org.apache.hadoop.yarn.util.UTCClock -->
- <class name="UTCClock" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.yarn.util.Clock"/>
- <constructor name="UTCClock"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Implementation of {@link Clock} that gives the current UTC time in
- milliseconds.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.UTCClock -->
- </package>
- <package name="org.apache.hadoop.yarn.util.resource">
- </package>
- <package name="org.apache.hadoop.yarn.util.timeline">
- <!-- start class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
- <class name="TimelineUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <exception name="JsonGenerationException" type="com.fasterxml.jackson.core.JsonGenerationException"/>
- <exception name="JsonMappingException" type="com.fasterxml.jackson.databind.JsonMappingException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize a POJO object into a JSON string not in a pretty format
-
- @param o
- an object to serialize
- @return a JSON string
- @throws IOException
- @throws JsonMappingException
- @throws JsonGenerationException]]>
- </doc>
- </method>
- <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <param name="pretty" type="boolean"/>
- <exception name="JsonGenerationException" type="com.fasterxml.jackson.core.JsonGenerationException"/>
- <exception name="JsonMappingException" type="com.fasterxml.jackson.databind.JsonMappingException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize a POJO object into a JSON string
-
- @param o
- an object to serialize
- @param pretty
- whether in a pretty format or not
- @return a JSON string
- @throws IOException
- @throws JsonMappingException
- @throws JsonGenerationException]]>
- </doc>
- </method>
- <method name="timelineServiceEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Returns whether the timeline service is enabled via configuration.
- @param conf the configuration
- @return whether the timeline service is enabled.]]>
- </doc>
- </method>
- <method name="getTimelineServiceVersion" return="float"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Returns the timeline service version. It does not check whether the
- timeline service itself is enabled.
- @param conf the configuration
- @return the timeline service version as a float.]]>
- </doc>
- </method>
- <method name="timelineServiceV1_5Enabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Returns whether the timeline service v.1.5 is enabled by default via
- configuration.
- @param conf the configuration
- @return whether the timeline service v.1.5 is enabled. V.1.5 refers to a
- version equal to 1.5.]]>
- </doc>
- </method>
- <method name="createTimelineAbout" return="org.apache.hadoop.yarn.api.records.timeline.TimelineAbout"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="about" type="java.lang.String"/>
- </method>
- <method name="getTimelineTokenServiceAddress" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="buildTimelineTokenService" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="generateDefaultFlowName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appName" type="java.lang.String"/>
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="generateFlowNameTag" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flowName" type="java.lang.String"/>
- <doc>
- <![CDATA[Generate flow name tag.
- @param flowName flow name that identifies a distinct flow application which
- can be run repeatedly over time
- @return flow name tag.]]>
- </doc>
- </method>
- <method name="generateFlowVersionTag" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flowVersion" type="java.lang.String"/>
- <doc>
- <![CDATA[Generate flow version tag.
- @param flowVersion flow version that keeps track of the changes made to the
- flow
- @return flow version tag.]]>
- </doc>
- </method>
- <method name="generateFlowRunIdTag" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flowRunId" type="long"/>
- <doc>
- <![CDATA[Generate flow run ID tag.
- @param flowRunId flow run ID that identifies one instance (or specific
- execution) of that flow
- @return flow run id tag.]]>
- </doc>
- </method>
- <field name="FLOW_NAME_TAG_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOW_VERSION_TAG_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOW_RUN_ID_TAG_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FLOW_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The helper class for the timeline module.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
- </package>
- <package name="org.apache.hadoop.yarn.webapp.util">
- </package>
- </api>
|