Apache_Hadoop_YARN_Common_3.1.1.xml 151 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327
  1. <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
  2. <!-- Generated by the JDiff Javadoc doclet -->
  3. <!-- (http://www.jdiff.org) -->
  4. <!-- on Thu Aug 02 05:11:24 UTC 2018 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop YARN Common 3.1.1"
  9. jdversion="1.0.9">
  10. <!-- 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.1.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.19.v20170502/jetty-server-9.3.19.v20170502.jar:/maven/org/eclipse/jetty/jetty-http/9.3.19.v20170502/jetty-http-9.3.19.v20170502.jar:/maven/org/eclipse/jetty/jetty-io/9.3.19.v20170502/jetty-io-9.3.19.v20170502.jar:/maven/org/eclipse/jetty/jetty-servlet/9.3.19.v20170502/jetty-servlet-9.3.19.v20170502.jar:/maven/org/eclipse/jetty/jetty-security/9.3.19.v20170502/jetty-security-9.3.19.v20170502.jar:/maven/org/eclipse/jetty/jetty-webapp/9.3.19.v20170502/jetty-webapp-9.3.19.v20170502.jar:/maven/org/eclipse/jetty/jetty-xml/9.3.19.v20170502/jetty-xml-9.3.19.v20170502.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.12.0/curator-client-2.12.0.jar:/maven/org/apache/curator/curator-recipes/2.12.0/curator-recipes-2.12.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.9/zookeeper-3.4.9.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.1.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.1.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.12.0/curator-framework-2.12.0.jar:/maven/javax/xml/bind/jaxb-api/2.2.11/jaxb-api-2.2.11.jar:/maven/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/maven/org/tukaani/xz/1.0/xz-1.0.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.19.v20170502/jetty-util-9.3.19.v20170502.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.1.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.1 -->
  11. <package name="org.apache.hadoop.yarn">
  12. <!-- start class org.apache.hadoop.yarn.ContainerLogAppender -->
  13. <class name="ContainerLogAppender" extends="org.apache.log4j.FileAppender"
  14. abstract="false"
  15. static="false" final="false" visibility="public"
  16. deprecated="not deprecated">
  17. <implements name="java.io.Flushable"/>
  18. <constructor name="ContainerLogAppender"
  19. static="false" final="false" visibility="public"
  20. deprecated="not deprecated">
  21. </constructor>
  22. <method name="activateOptions"
  23. abstract="false" native="false" synchronized="true"
  24. static="false" final="false" visibility="public"
  25. deprecated="not deprecated">
  26. </method>
  27. <method name="append"
  28. abstract="false" native="false" synchronized="true"
  29. static="false" final="false" visibility="public"
  30. deprecated="not deprecated">
  31. <param name="event" type="org.apache.log4j.spi.LoggingEvent"/>
  32. </method>
  33. <method name="flush"
  34. abstract="false" native="false" synchronized="false"
  35. static="false" final="false" visibility="public"
  36. deprecated="not deprecated">
  37. </method>
  38. <method name="close"
  39. abstract="false" native="false" synchronized="true"
  40. static="false" final="false" visibility="public"
  41. deprecated="not deprecated">
  42. </method>
  43. <method name="getContainerLogDir" return="java.lang.String"
  44. abstract="false" native="false" synchronized="false"
  45. static="false" final="false" visibility="public"
  46. deprecated="not deprecated">
  47. <doc>
  48. <![CDATA[Getter/Setter methods for log4j.]]>
  49. </doc>
  50. </method>
  51. <method name="setContainerLogDir"
  52. abstract="false" native="false" synchronized="false"
  53. static="false" final="false" visibility="public"
  54. deprecated="not deprecated">
  55. <param name="containerLogDir" type="java.lang.String"/>
  56. </method>
  57. <method name="getContainerLogFile" return="java.lang.String"
  58. abstract="false" native="false" synchronized="false"
  59. static="false" final="false" visibility="public"
  60. deprecated="not deprecated">
  61. </method>
  62. <method name="setContainerLogFile"
  63. abstract="false" native="false" synchronized="false"
  64. static="false" final="false" visibility="public"
  65. deprecated="not deprecated">
  66. <param name="containerLogFile" type="java.lang.String"/>
  67. </method>
  68. <method name="getTotalLogFileSize" return="long"
  69. abstract="false" native="false" synchronized="false"
  70. static="false" final="false" visibility="public"
  71. deprecated="not deprecated">
  72. </method>
  73. <method name="setTotalLogFileSize"
  74. abstract="false" native="false" synchronized="false"
  75. static="false" final="false" visibility="public"
  76. deprecated="not deprecated">
  77. <param name="logSize" type="long"/>
  78. <doc>
  79. <![CDATA[Setter so that log4j can configure it from the
  80. configuration(log4j.properties).]]>
  81. </doc>
  82. </method>
  83. <doc>
  84. <![CDATA[A simple log4j-appender for container's logs.]]>
  85. </doc>
  86. </class>
  87. <!-- end class org.apache.hadoop.yarn.ContainerLogAppender -->
  88. <!-- start class org.apache.hadoop.yarn.ContainerRollingLogAppender -->
  89. <class name="ContainerRollingLogAppender" extends="org.apache.log4j.RollingFileAppender"
  90. abstract="false"
  91. static="false" final="false" visibility="public"
  92. deprecated="not deprecated">
  93. <implements name="java.io.Flushable"/>
  94. <constructor name="ContainerRollingLogAppender"
  95. static="false" final="false" visibility="public"
  96. deprecated="not deprecated">
  97. </constructor>
  98. <method name="activateOptions"
  99. abstract="false" native="false" synchronized="false"
  100. static="false" final="false" visibility="public"
  101. deprecated="not deprecated">
  102. </method>
  103. <method name="flush"
  104. abstract="false" native="false" synchronized="false"
  105. static="false" final="false" visibility="public"
  106. deprecated="not deprecated">
  107. </method>
  108. <method name="getContainerLogDir" return="java.lang.String"
  109. abstract="false" native="false" synchronized="false"
  110. static="false" final="false" visibility="public"
  111. deprecated="not deprecated">
  112. <doc>
  113. <![CDATA[Getter/Setter methods for log4j.]]>
  114. </doc>
  115. </method>
  116. <method name="setContainerLogDir"
  117. abstract="false" native="false" synchronized="false"
  118. static="false" final="false" visibility="public"
  119. deprecated="not deprecated">
  120. <param name="containerLogDir" type="java.lang.String"/>
  121. </method>
  122. <method name="getContainerLogFile" return="java.lang.String"
  123. abstract="false" native="false" synchronized="false"
  124. static="false" final="false" visibility="public"
  125. deprecated="not deprecated">
  126. </method>
  127. <method name="setContainerLogFile"
  128. abstract="false" native="false" synchronized="false"
  129. static="false" final="false" visibility="public"
  130. deprecated="not deprecated">
  131. <param name="containerLogFile" type="java.lang.String"/>
  132. </method>
  133. <doc>
  134. <![CDATA[A simple log4j-appender for container's logs.]]>
  135. </doc>
  136. </class>
  137. <!-- end class org.apache.hadoop.yarn.ContainerRollingLogAppender -->
  138. <!-- start class org.apache.hadoop.yarn.YarnUncaughtExceptionHandler -->
  139. <class name="YarnUncaughtExceptionHandler" extends="java.lang.Object"
  140. abstract="false"
  141. static="false" final="false" visibility="public"
  142. deprecated="not deprecated">
  143. <implements name="java.lang.Thread.UncaughtExceptionHandler"/>
  144. <constructor name="YarnUncaughtExceptionHandler"
  145. static="false" final="false" visibility="public"
  146. deprecated="not deprecated">
  147. </constructor>
  148. <method name="uncaughtException"
  149. abstract="false" native="false" synchronized="false"
  150. static="false" final="false" visibility="public"
  151. deprecated="not deprecated">
  152. <param name="t" type="java.lang.Thread"/>
  153. <param name="e" type="java.lang.Throwable"/>
  154. </method>
  155. <doc>
  156. <![CDATA[This class is intended to be installed by calling
  157. {@link Thread#setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler)}
  158. In the main entry point. It is intended to try and cleanly shut down
  159. programs using the YARN Event framework.
  160. Note: Right now it only will shut down the program if a Error is caught, but
  161. not any other exception. Anything else is just logged.]]>
  162. </doc>
  163. </class>
  164. <!-- end class org.apache.hadoop.yarn.YarnUncaughtExceptionHandler -->
  165. </package>
  166. <package name="org.apache.hadoop.yarn.api">
  167. </package>
  168. <package name="org.apache.hadoop.yarn.client">
  169. <!-- start class org.apache.hadoop.yarn.client.AHSProxy -->
  170. <class name="AHSProxy" extends="java.lang.Object"
  171. abstract="false"
  172. static="false" final="false" visibility="public"
  173. deprecated="not deprecated">
  174. <constructor name="AHSProxy"
  175. static="false" final="false" visibility="public"
  176. deprecated="not deprecated">
  177. </constructor>
  178. <method name="createAHSProxy" return="T"
  179. abstract="false" native="false" synchronized="false"
  180. static="true" final="false" visibility="public"
  181. deprecated="not deprecated">
  182. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  183. <param name="protocol" type="java.lang.Class"/>
  184. <param name="ahsAddress" type="java.net.InetSocketAddress"/>
  185. <exception name="IOException" type="java.io.IOException"/>
  186. </method>
  187. <method name="getProxy" return="T"
  188. abstract="false" native="false" synchronized="false"
  189. static="true" final="false" visibility="protected"
  190. deprecated="not deprecated">
  191. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  192. <param name="protocol" type="java.lang.Class"/>
  193. <param name="rmAddress" type="java.net.InetSocketAddress"/>
  194. <exception name="IOException" type="java.io.IOException"/>
  195. </method>
  196. </class>
  197. <!-- end class org.apache.hadoop.yarn.client.AHSProxy -->
  198. <!-- start class org.apache.hadoop.yarn.client.ClientRMProxy -->
  199. <class name="ClientRMProxy" extends="org.apache.hadoop.yarn.client.RMProxy"
  200. abstract="false"
  201. static="false" final="false" visibility="public"
  202. deprecated="not deprecated">
  203. <method name="createRMProxy" return="T"
  204. abstract="false" native="false" synchronized="false"
  205. static="true" final="false" visibility="public"
  206. deprecated="not deprecated">
  207. <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
  208. <param name="protocol" type="java.lang.Class"/>
  209. <exception name="IOException" type="java.io.IOException"/>
  210. <doc>
  211. <![CDATA[Create a proxy to the ResourceManager for the specified protocol.
  212. @param configuration Configuration with all the required information.
  213. @param protocol Client protocol for which proxy is being requested.
  214. @param <T> Type of proxy.
  215. @return Proxy to the ResourceManager for the specified client protocol.
  216. @throws IOException]]>
  217. </doc>
  218. </method>
  219. <method name="getRMDelegationTokenService" return="org.apache.hadoop.io.Text"
  220. abstract="false" native="false" synchronized="false"
  221. static="true" final="false" visibility="public"
  222. deprecated="not deprecated">
  223. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  224. <doc>
  225. <![CDATA[Get the token service name to be used for RMDelegationToken. Depending
  226. on whether HA is enabled or not, this method generates the appropriate
  227. service name as a comma-separated list of service addresses.
  228. @param conf Configuration corresponding to the cluster we need the
  229. RMDelegationToken for
  230. @return - Service name for RMDelegationToken]]>
  231. </doc>
  232. </method>
  233. <method name="getAMRMTokenService" return="org.apache.hadoop.io.Text"
  234. abstract="false" native="false" synchronized="false"
  235. static="true" final="false" visibility="public"
  236. deprecated="not deprecated">
  237. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  238. </method>
  239. <method name="getTokenService" return="org.apache.hadoop.io.Text"
  240. abstract="false" native="false" synchronized="false"
  241. static="true" final="false" visibility="public"
  242. deprecated="not deprecated">
  243. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  244. <param name="address" type="java.lang.String"/>
  245. <param name="defaultAddr" type="java.lang.String"/>
  246. <param name="defaultPort" type="int"/>
  247. </method>
  248. </class>
  249. <!-- end class org.apache.hadoop.yarn.client.ClientRMProxy -->
  250. <!-- start class org.apache.hadoop.yarn.client.NMProxy -->
  251. <class name="NMProxy" extends="org.apache.hadoop.yarn.client.ServerProxy"
  252. abstract="false"
  253. static="false" final="false" visibility="public"
  254. deprecated="not deprecated">
  255. <constructor name="NMProxy"
  256. static="false" final="false" visibility="public"
  257. deprecated="not deprecated">
  258. </constructor>
  259. <method name="createNMProxy" return="T"
  260. abstract="false" native="false" synchronized="false"
  261. static="true" final="false" visibility="public"
  262. deprecated="not deprecated">
  263. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  264. <param name="protocol" type="java.lang.Class"/>
  265. <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
  266. <param name="rpc" type="org.apache.hadoop.yarn.ipc.YarnRPC"/>
  267. <param name="serverAddress" type="java.net.InetSocketAddress"/>
  268. </method>
  269. </class>
  270. <!-- end class org.apache.hadoop.yarn.client.NMProxy -->
  271. <!-- start class org.apache.hadoop.yarn.client.RMProxy -->
  272. <class name="RMProxy" extends="java.lang.Object"
  273. abstract="false"
  274. static="false" final="false" visibility="public"
  275. deprecated="not deprecated">
  276. <constructor name="RMProxy"
  277. static="false" final="false" visibility="protected"
  278. deprecated="not deprecated">
  279. </constructor>
  280. <method name="createRetryPolicy" return="org.apache.hadoop.io.retry.RetryPolicy"
  281. abstract="false" native="false" synchronized="false"
  282. static="true" final="false" visibility="protected"
  283. deprecated="not deprecated">
  284. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  285. <param name="retryTime" type="long"/>
  286. <param name="retryInterval" type="long"/>
  287. <param name="isHAEnabled" type="boolean"/>
  288. <doc>
  289. <![CDATA[Fetch retry policy from Configuration and create the
  290. retry policy with specified retryTime and retry interval.]]>
  291. </doc>
  292. </method>
  293. </class>
  294. <!-- end class org.apache.hadoop.yarn.client.RMProxy -->
  295. <!-- start class org.apache.hadoop.yarn.client.ServerProxy -->
  296. <class name="ServerProxy" extends="java.lang.Object"
  297. abstract="false"
  298. static="false" final="false" visibility="public"
  299. deprecated="not deprecated">
  300. <constructor name="ServerProxy"
  301. static="false" final="false" visibility="public"
  302. deprecated="not deprecated">
  303. </constructor>
  304. <method name="createRetryPolicy" return="org.apache.hadoop.io.retry.RetryPolicy"
  305. abstract="false" native="false" synchronized="false"
  306. static="true" final="false" visibility="protected"
  307. deprecated="not deprecated">
  308. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  309. <param name="maxWaitTimeStr" type="java.lang.String"/>
  310. <param name="defMaxWaitTime" type="long"/>
  311. <param name="connectRetryIntervalStr" type="java.lang.String"/>
  312. <param name="defRetryInterval" type="long"/>
  313. </method>
  314. <method name="createRetriableProxy" return="T"
  315. abstract="false" native="false" synchronized="false"
  316. static="true" final="false" visibility="protected"
  317. deprecated="not deprecated">
  318. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  319. <param name="protocol" type="java.lang.Class"/>
  320. <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
  321. <param name="rpc" type="org.apache.hadoop.yarn.ipc.YarnRPC"/>
  322. <param name="serverAddress" type="java.net.InetSocketAddress"/>
  323. <param name="retryPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
  324. </method>
  325. </class>
  326. <!-- end class org.apache.hadoop.yarn.client.ServerProxy -->
  327. </package>
  328. <package name="org.apache.hadoop.yarn.client.api">
  329. <!-- start class org.apache.hadoop.yarn.client.api.AppAdminClient -->
  330. <class name="AppAdminClient" extends="org.apache.hadoop.service.CompositeService"
  331. abstract="true"
  332. static="false" final="false" visibility="public"
  333. deprecated="not deprecated">
  334. <constructor name="AppAdminClient"
  335. static="false" final="false" visibility="protected"
  336. deprecated="not deprecated">
  337. </constructor>
  338. <method name="createAppAdminClient" return="org.apache.hadoop.yarn.client.api.AppAdminClient"
  339. abstract="false" native="false" synchronized="false"
  340. static="true" final="false" visibility="public"
  341. deprecated="not deprecated">
  342. <param name="appType" type="java.lang.String"/>
  343. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  344. <doc>
  345. <![CDATA[<p>
  346. Create a new instance of AppAdminClient.
  347. </p>
  348. @param appType application type
  349. @param conf configuration
  350. @return app admin client]]>
  351. </doc>
  352. </method>
  353. <method name="actionLaunch" return="int"
  354. abstract="true" native="false" synchronized="false"
  355. static="false" final="false" visibility="public"
  356. deprecated="not deprecated">
  357. <param name="fileName" type="java.lang.String"/>
  358. <param name="appName" type="java.lang.String"/>
  359. <param name="lifetime" type="java.lang.Long"/>
  360. <param name="queue" type="java.lang.String"/>
  361. <exception name="IOException" type="java.io.IOException"/>
  362. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  363. <doc>
  364. <![CDATA[<p>
  365. Launch a new YARN application.
  366. </p>
  367. @param fileName specification of application
  368. @param appName name of the application
  369. @param lifetime lifetime of the application
  370. @param queue queue of the application
  371. @return exit code
  372. @throws IOException IOException
  373. @throws YarnException exception in client or server]]>
  374. </doc>
  375. </method>
  376. <method name="actionStop" return="int"
  377. abstract="true" native="false" synchronized="false"
  378. static="false" final="false" visibility="public"
  379. deprecated="not deprecated">
  380. <param name="appName" type="java.lang.String"/>
  381. <exception name="IOException" type="java.io.IOException"/>
  382. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  383. <doc>
  384. <![CDATA[<p>
  385. Stop a YARN application (attempt to stop gracefully before killing the
  386. application). In the case of a long-running service, the service may be
  387. restarted later.
  388. </p>
  389. @param appName the name of the application
  390. @return exit code
  391. @throws IOException IOException
  392. @throws YarnException exception in client or server]]>
  393. </doc>
  394. </method>
  395. <method name="actionStart" return="int"
  396. abstract="true" native="false" synchronized="false"
  397. static="false" final="false" visibility="public"
  398. deprecated="not deprecated">
  399. <param name="appName" type="java.lang.String"/>
  400. <exception name="IOException" type="java.io.IOException"/>
  401. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  402. <doc>
  403. <![CDATA[<p>
  404. Start a YARN application from a previously saved specification. In the
  405. case of a long-running service, the service must have been previously
  406. launched/started and then stopped, or previously saved but not started.
  407. </p>
  408. @param appName the name of the application
  409. @return exit code
  410. @throws IOException IOException
  411. @throws YarnException exception in client or server]]>
  412. </doc>
  413. </method>
  414. <method name="actionSave" return="int"
  415. abstract="true" native="false" synchronized="false"
  416. static="false" final="false" visibility="public"
  417. deprecated="not deprecated">
  418. <param name="fileName" type="java.lang.String"/>
  419. <param name="appName" type="java.lang.String"/>
  420. <param name="lifetime" type="java.lang.Long"/>
  421. <param name="queue" type="java.lang.String"/>
  422. <exception name="IOException" type="java.io.IOException"/>
  423. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  424. <doc>
  425. <![CDATA[<p>
  426. Save the specification for a YARN application / long-running service.
  427. The application may be started later.
  428. </p>
  429. @param fileName specification of application to save
  430. @param appName name of the application
  431. @param lifetime lifetime of the application
  432. @param queue queue of the application
  433. @return exit code
  434. @throws IOException IOException
  435. @throws YarnException exception in client or server]]>
  436. </doc>
  437. </method>
  438. <method name="actionDestroy" return="int"
  439. abstract="true" native="false" synchronized="false"
  440. static="false" final="false" visibility="public"
  441. deprecated="not deprecated">
  442. <param name="appName" type="java.lang.String"/>
  443. <exception name="IOException" type="java.io.IOException"/>
  444. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  445. <doc>
  446. <![CDATA[<p>
  447. Remove the specification and all application data for a YARN application.
  448. The application cannot be running.
  449. </p>
  450. @param appName the name of the application
  451. @return exit code
  452. @throws IOException IOException
  453. @throws YarnException exception in client or server]]>
  454. </doc>
  455. </method>
  456. <method name="actionFlex" return="int"
  457. abstract="true" native="false" synchronized="false"
  458. static="false" final="false" visibility="public"
  459. deprecated="not deprecated">
  460. <param name="appName" type="java.lang.String"/>
  461. <param name="componentCounts" type="java.util.Map"/>
  462. <exception name="IOException" type="java.io.IOException"/>
  463. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  464. <doc>
  465. <![CDATA[<p>
  466. Change the number of running containers for a component of a YARN
  467. application / long-running service.
  468. </p>
  469. @param appName the name of the application
  470. @param componentCounts map of component name to new component count or
  471. amount to change existing component count (e.g.
  472. 5, +5, -5)
  473. @return exit code
  474. @throws IOException IOException
  475. @throws YarnException exception in client or server]]>
  476. </doc>
  477. </method>
  478. <method name="enableFastLaunch" return="int"
  479. abstract="true" native="false" synchronized="false"
  480. static="false" final="false" visibility="public"
  481. deprecated="not deprecated">
  482. <param name="destinationFolder" type="java.lang.String"/>
  483. <exception name="IOException" type="java.io.IOException"/>
  484. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  485. <doc>
  486. <![CDATA[<p>
  487. Upload AM dependencies to HDFS. This makes future application launches
  488. faster since the dependencies do not have to be uploaded on each launch.
  489. </p>
  490. @param destinationFolder
  491. an optional HDFS folder where dependency tarball will be uploaded
  492. @return exit code
  493. @throws IOException
  494. IOException
  495. @throws YarnException
  496. exception in client or server]]>
  497. </doc>
  498. </method>
  499. <method name="getStatusString" return="java.lang.String"
  500. abstract="true" native="false" synchronized="false"
  501. static="false" final="false" visibility="public"
  502. deprecated="not deprecated">
  503. <param name="appIdOrName" type="java.lang.String"/>
  504. <exception name="IOException" type="java.io.IOException"/>
  505. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  506. <doc>
  507. <![CDATA[<p>
  508. Get detailed app specific status string for a YARN application.
  509. </p>
  510. @param appIdOrName appId or appName
  511. @return status string
  512. @throws IOException IOException
  513. @throws YarnException exception in client or server]]>
  514. </doc>
  515. </method>
  516. <method name="initiateUpgrade" return="int"
  517. abstract="true" native="false" synchronized="false"
  518. static="false" final="false" visibility="public"
  519. deprecated="not deprecated">
  520. <param name="appName" type="java.lang.String"/>
  521. <param name="fileName" type="java.lang.String"/>
  522. <param name="autoFinalize" type="boolean"/>
  523. <exception name="IOException" type="java.io.IOException"/>
  524. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  525. <doc>
  526. <![CDATA[Initiate upgrade of a long running service.
  527. @param appName the name of the application.
  528. @param fileName specification of application upgrade to save.
  529. @param autoFinalize when true, finalization of upgrade will be done
  530. automatically.
  531. @return exit code
  532. @throws IOException IOException
  533. @throws YarnException exception in client or server]]>
  534. </doc>
  535. </method>
  536. <method name="actionUpgradeInstances" return="int"
  537. abstract="true" native="false" synchronized="false"
  538. static="false" final="false" visibility="public"
  539. deprecated="not deprecated">
  540. <param name="appName" type="java.lang.String"/>
  541. <param name="componentInstances" type="java.util.List"/>
  542. <exception name="IOException" type="java.io.IOException"/>
  543. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  544. <doc>
  545. <![CDATA[Upgrade component instances of a long running service.
  546. @param appName the name of the application.
  547. @param componentInstances the name of the component instances.]]>
  548. </doc>
  549. </method>
  550. <method name="actionUpgradeComponents" return="int"
  551. abstract="true" native="false" synchronized="false"
  552. static="false" final="false" visibility="public"
  553. deprecated="not deprecated">
  554. <param name="appName" type="java.lang.String"/>
  555. <param name="components" type="java.util.List"/>
  556. <exception name="IOException" type="java.io.IOException"/>
  557. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  558. <doc>
  559. <![CDATA[Upgrade components of a long running service.
  560. @param appName the name of the application.
  561. @param components the name of the components.]]>
  562. </doc>
  563. </method>
  564. <method name="actionCleanUp" return="int"
  565. abstract="true" native="false" synchronized="false"
  566. static="false" final="false" visibility="public"
  567. deprecated="not deprecated">
  568. <param name="appName" type="java.lang.String"/>
  569. <param name="userName" type="java.lang.String"/>
  570. <exception name="IOException" type="java.io.IOException"/>
  571. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  572. <doc>
  573. <![CDATA[Operation to be performed by the RM after an application has completed.
  574. @param appName the name of the application.
  575. @param userName the name of the user.
  576. @return exit code]]>
  577. </doc>
  578. </method>
  579. <field name="YARN_APP_ADMIN_CLIENT_PREFIX" type="java.lang.String"
  580. transient="false" volatile="false"
  581. static="true" final="true" visibility="public"
  582. deprecated="not deprecated">
  583. </field>
  584. <field name="DEFAULT_TYPE" type="java.lang.String"
  585. transient="false" volatile="false"
  586. static="true" final="true" visibility="public"
  587. deprecated="not deprecated">
  588. </field>
  589. <field name="DEFAULT_CLASS_NAME" type="java.lang.String"
  590. transient="false" volatile="false"
  591. static="true" final="true" visibility="public"
  592. deprecated="not deprecated">
  593. </field>
  594. <field name="UNIT_TEST_TYPE" type="java.lang.String"
  595. transient="false" volatile="false"
  596. static="true" final="true" visibility="public"
  597. deprecated="not deprecated">
  598. </field>
  599. <field name="UNIT_TEST_CLASS_NAME" type="java.lang.String"
  600. transient="false" volatile="false"
  601. static="true" final="true" visibility="public"
  602. deprecated="not deprecated">
  603. </field>
  604. <doc>
  605. <![CDATA[Client for managing applications.]]>
  606. </doc>
  607. </class>
  608. <!-- end class org.apache.hadoop.yarn.client.api.AppAdminClient -->
  609. <!-- start class org.apache.hadoop.yarn.client.api.TimelineClient -->
  610. <class name="TimelineClient" extends="org.apache.hadoop.service.CompositeService"
  611. abstract="true"
  612. static="false" final="false" visibility="public"
  613. deprecated="not deprecated">
  614. <implements name="java.io.Flushable"/>
  615. <constructor name="TimelineClient" type="java.lang.String"
  616. static="false" final="false" visibility="protected"
  617. deprecated="not deprecated">
  618. </constructor>
  619. <method name="createTimelineClient" return="org.apache.hadoop.yarn.client.api.TimelineClient"
  620. abstract="false" native="false" synchronized="false"
  621. static="true" final="false" visibility="public"
  622. deprecated="not deprecated">
  623. <doc>
  624. <![CDATA[Creates an instance of the timeline v.1.x client.
  625. The current UGI when the user initialize the client will be used to do the
  626. put and the delegation token operations. The current user may use
  627. {@link UserGroupInformation#doAs} another user to construct and initialize
  628. a timeline client if the following operations are supposed to be conducted
  629. by that user.
  630. @return the created timeline client instance]]>
  631. </doc>
  632. </method>
  633. <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
  634. abstract="true" native="false" synchronized="false"
  635. static="false" final="false" visibility="public"
  636. deprecated="not deprecated">
  637. <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
  638. <exception name="IOException" type="java.io.IOException"/>
  639. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  640. <doc>
  641. <![CDATA[<p>
  642. Send the information of a number of conceptual entities to the timeline
  643. server. It is a blocking API. The method will not return until it gets the
  644. response from the timeline server.
  645. </p>
  646. @param entities
  647. the collection of {@link TimelineEntity}
  648. @return the error information if the sent entities are not correctly stored
  649. @throws IOException if there are I/O errors
  650. @throws YarnException if entities are incomplete/invalid]]>
  651. </doc>
  652. </method>
  653. <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
  654. abstract="true" native="false" synchronized="false"
  655. static="false" final="false" visibility="public"
  656. deprecated="not deprecated">
  657. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  658. <param name="groupId" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"/>
  659. <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
  660. <exception name="IOException" type="java.io.IOException"/>
  661. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  662. <doc>
  663. <![CDATA[<p>
  664. Send the information of a number of conceptual entities to the timeline
  665. server. It is a blocking API. The method will not return until it gets the
  666. response from the timeline server.
  667. This API is only for timeline service v1.5
  668. </p>
  669. @param appAttemptId {@link ApplicationAttemptId}
  670. @param groupId {@link TimelineEntityGroupId}
  671. @param entities
  672. the collection of {@link TimelineEntity}
  673. @return the error information if the sent entities are not correctly stored
  674. @throws IOException if there are I/O errors
  675. @throws YarnException if entities are incomplete/invalid]]>
  676. </doc>
  677. </method>
  678. <method name="putDomain"
  679. abstract="true" native="false" synchronized="false"
  680. static="false" final="false" visibility="public"
  681. deprecated="not deprecated">
  682. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  683. <exception name="IOException" type="java.io.IOException"/>
  684. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  685. <doc>
  686. <![CDATA[<p>
  687. Send the information of a domain to the timeline server. It is a
  688. blocking API. The method will not return until it gets the response from
  689. the timeline server.
  690. </p>
  691. @param domain
  692. an {@link TimelineDomain} object
  693. @throws IOException
  694. @throws YarnException]]>
  695. </doc>
  696. </method>
  697. <method name="putDomain"
  698. abstract="true" native="false" synchronized="false"
  699. static="false" final="false" visibility="public"
  700. deprecated="not deprecated">
  701. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  702. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  703. <exception name="IOException" type="java.io.IOException"/>
  704. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  705. <doc>
  706. <![CDATA[<p>
  707. Send the information of a domain to the timeline server. It is a
  708. blocking API. The method will not return until it gets the response from
  709. the timeline server.
  710. This API is only for timeline service v1.5
  711. </p>
  712. @param domain
  713. an {@link TimelineDomain} object
  714. @param appAttemptId {@link ApplicationAttemptId}
  715. @throws IOException
  716. @throws YarnException]]>
  717. </doc>
  718. </method>
  719. <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
  720. abstract="true" native="false" synchronized="false"
  721. static="false" final="false" visibility="public"
  722. deprecated="not deprecated">
  723. <param name="renewer" type="java.lang.String"/>
  724. <exception name="IOException" type="java.io.IOException"/>
  725. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  726. <doc>
  727. <![CDATA[<p>
  728. Get a delegation token so as to be able to talk to the timeline server in a
  729. secure way.
  730. </p>
  731. @param renewer
  732. Address of the renewer who can renew these tokens when needed by
  733. securely talking to the timeline server
  734. @return a delegation token ({@link Token}) that can be used to talk to the
  735. timeline server
  736. @throws IOException
  737. @throws YarnException]]>
  738. </doc>
  739. </method>
  740. <method name="renewDelegationToken" return="long"
  741. abstract="true" native="false" synchronized="false"
  742. static="false" final="false" visibility="public"
  743. deprecated="not deprecated">
  744. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  745. <exception name="IOException" type="java.io.IOException"/>
  746. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  747. <doc>
  748. <![CDATA[<p>
  749. Renew a timeline delegation token.
  750. </p>
  751. @param timelineDT
  752. the delegation token to renew
  753. @return the new expiration time
  754. @throws IOException
  755. @throws YarnException]]>
  756. </doc>
  757. </method>
  758. <method name="cancelDelegationToken"
  759. abstract="true" native="false" synchronized="false"
  760. static="false" final="false" visibility="public"
  761. deprecated="not deprecated">
  762. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  763. <exception name="IOException" type="java.io.IOException"/>
  764. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  765. <doc>
  766. <![CDATA[<p>
  767. Cancel a timeline delegation token.
  768. </p>
  769. @param timelineDT
  770. the delegation token to cancel
  771. @throws IOException
  772. @throws YarnException]]>
  773. </doc>
  774. </method>
  775. <doc>
  776. <![CDATA[A client library that can be used to post some information in terms of a
  777. number of conceptual entities. This client library needs to be used along
  778. with Timeline V.1.x server versions.
  779. Refer {@link TimelineV2Client} for ATS V2 interface.]]>
  780. </doc>
  781. </class>
  782. <!-- end class org.apache.hadoop.yarn.client.api.TimelineClient -->
  783. </package>
  784. <package name="org.apache.hadoop.yarn.client.api.impl">
  785. </package>
  786. <package name="org.apache.hadoop.yarn.event">
  787. <!-- start class org.apache.hadoop.yarn.event.AbstractEvent -->
  788. <class name="AbstractEvent" extends="java.lang.Object"
  789. abstract="true"
  790. static="false" final="false" visibility="public"
  791. deprecated="not deprecated">
  792. <implements name="org.apache.hadoop.yarn.event.Event"/>
  793. <constructor name="AbstractEvent" type="TYPE"
  794. static="false" final="false" visibility="public"
  795. deprecated="not deprecated">
  796. </constructor>
  797. <constructor name="AbstractEvent" type="TYPE, long"
  798. static="false" final="false" visibility="public"
  799. deprecated="not deprecated">
  800. </constructor>
  801. <method name="getTimestamp" return="long"
  802. abstract="false" native="false" synchronized="false"
  803. static="false" final="false" visibility="public"
  804. deprecated="not deprecated">
  805. </method>
  806. <method name="getType" return="TYPE"
  807. abstract="false" native="false" synchronized="false"
  808. static="false" final="false" visibility="public"
  809. deprecated="not deprecated">
  810. </method>
  811. <method name="toString" return="java.lang.String"
  812. abstract="false" native="false" synchronized="false"
  813. static="false" final="false" visibility="public"
  814. deprecated="not deprecated">
  815. </method>
  816. <doc>
  817. <![CDATA[Parent class of all the events. All events extend this class.]]>
  818. </doc>
  819. </class>
  820. <!-- end class org.apache.hadoop.yarn.event.AbstractEvent -->
  821. <!-- start class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  822. <class name="AsyncDispatcher" extends="org.apache.hadoop.service.AbstractService"
  823. abstract="false"
  824. static="false" final="false" visibility="public"
  825. deprecated="not deprecated">
  826. <implements name="org.apache.hadoop.yarn.event.Dispatcher"/>
  827. <constructor name="AsyncDispatcher"
  828. static="false" final="false" visibility="public"
  829. deprecated="not deprecated">
  830. </constructor>
  831. <constructor name="AsyncDispatcher" type="java.util.concurrent.BlockingQueue"
  832. static="false" final="false" visibility="public"
  833. deprecated="not deprecated">
  834. </constructor>
  835. <constructor name="AsyncDispatcher" type="java.lang.String"
  836. static="false" final="false" visibility="public"
  837. deprecated="not deprecated">
  838. <doc>
  839. <![CDATA[Set a name for this dispatcher thread.
  840. @param dispatcherName name of the dispatcher thread]]>
  841. </doc>
  842. </constructor>
  843. <method name="disableExitOnDispatchException"
  844. abstract="false" native="false" synchronized="false"
  845. static="false" final="false" visibility="public"
  846. deprecated="not deprecated">
  847. </method>
  848. <method name="serviceStart"
  849. abstract="false" native="false" synchronized="false"
  850. static="false" final="false" visibility="protected"
  851. deprecated="not deprecated">
  852. <exception name="Exception" type="java.lang.Exception"/>
  853. </method>
  854. <method name="setDrainEventsOnStop"
  855. abstract="false" native="false" synchronized="false"
  856. static="false" final="false" visibility="public"
  857. deprecated="not deprecated">
  858. </method>
  859. <method name="serviceStop"
  860. abstract="false" native="false" synchronized="false"
  861. static="false" final="false" visibility="protected"
  862. deprecated="not deprecated">
  863. <exception name="Exception" type="java.lang.Exception"/>
  864. </method>
  865. <method name="dispatch"
  866. abstract="false" native="false" synchronized="false"
  867. static="false" final="false" visibility="protected"
  868. deprecated="not deprecated">
  869. <param name="event" type="org.apache.hadoop.yarn.event.Event"/>
  870. </method>
  871. <method name="register"
  872. abstract="false" native="false" synchronized="false"
  873. static="false" final="false" visibility="public"
  874. deprecated="not deprecated">
  875. <param name="eventType" type="java.lang.Class"/>
  876. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  877. </method>
  878. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  879. abstract="false" native="false" synchronized="false"
  880. static="false" final="false" visibility="public"
  881. deprecated="not deprecated">
  882. </method>
  883. <method name="isEventThreadWaiting" return="boolean"
  884. abstract="false" native="false" synchronized="false"
  885. static="false" final="false" visibility="protected"
  886. deprecated="not deprecated">
  887. </method>
  888. <method name="isDrained" return="boolean"
  889. abstract="false" native="false" synchronized="false"
  890. static="false" final="false" visibility="protected"
  891. deprecated="not deprecated">
  892. </method>
  893. <method name="isStopped" return="boolean"
  894. abstract="false" native="false" synchronized="false"
  895. static="false" final="false" visibility="protected"
  896. deprecated="not deprecated">
  897. </method>
  898. <field name="eventDispatchers" type="java.util.Map"
  899. transient="false" volatile="false"
  900. static="false" final="true" visibility="protected"
  901. deprecated="not deprecated">
  902. </field>
  903. <doc>
  904. <![CDATA[Dispatches {@link Event}s in a separate thread. Currently only single thread
  905. does that. Potentially there could be multiple channels for each event type
  906. class and a thread pool can be used to dispatch the events.]]>
  907. </doc>
  908. </class>
  909. <!-- end class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  910. <!-- start interface org.apache.hadoop.yarn.event.Dispatcher -->
  911. <interface name="Dispatcher" abstract="true"
  912. static="false" final="false" visibility="public"
  913. deprecated="not deprecated">
  914. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  915. abstract="true" native="false" synchronized="false"
  916. static="false" final="false" visibility="public"
  917. deprecated="not deprecated">
  918. </method>
  919. <method name="register"
  920. abstract="true" native="false" synchronized="false"
  921. static="false" final="false" visibility="public"
  922. deprecated="not deprecated">
  923. <param name="eventType" type="java.lang.Class"/>
  924. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  925. </method>
  926. <doc>
  927. <![CDATA[Event Dispatcher interface. It dispatches events to registered
  928. event handlers based on event types.]]>
  929. </doc>
  930. </interface>
  931. <!-- end interface org.apache.hadoop.yarn.event.Dispatcher -->
  932. <!-- start interface org.apache.hadoop.yarn.event.Event -->
  933. <interface name="Event" abstract="true"
  934. static="false" final="false" visibility="public"
  935. deprecated="not deprecated">
  936. <method name="getType" return="TYPE"
  937. abstract="true" native="false" synchronized="false"
  938. static="false" final="false" visibility="public"
  939. deprecated="not deprecated">
  940. </method>
  941. <method name="getTimestamp" return="long"
  942. abstract="true" native="false" synchronized="false"
  943. static="false" final="false" visibility="public"
  944. deprecated="not deprecated">
  945. </method>
  946. <method name="toString" return="java.lang.String"
  947. abstract="true" native="false" synchronized="false"
  948. static="false" final="false" visibility="public"
  949. deprecated="not deprecated">
  950. </method>
  951. <doc>
  952. <![CDATA[Interface defining events api.]]>
  953. </doc>
  954. </interface>
  955. <!-- end interface org.apache.hadoop.yarn.event.Event -->
  956. <!-- start interface org.apache.hadoop.yarn.event.EventHandler -->
  957. <interface name="EventHandler" abstract="true"
  958. static="false" final="false" visibility="public"
  959. deprecated="not deprecated">
  960. <method name="handle"
  961. abstract="true" native="false" synchronized="false"
  962. static="false" final="false" visibility="public"
  963. deprecated="not deprecated">
  964. <param name="event" type="T"/>
  965. </method>
  966. <doc>
  967. <![CDATA[Interface for handling events of type T
  968. @param <T> parameterized event of type T]]>
  969. </doc>
  970. </interface>
  971. <!-- end interface org.apache.hadoop.yarn.event.EventHandler -->
  972. </package>
  973. <package name="org.apache.hadoop.yarn.factories">
  974. </package>
  975. <package name="org.apache.hadoop.yarn.factory.providers">
  976. </package>
  977. <package name="org.apache.hadoop.yarn.logaggregation">
  978. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  979. <class name="AggregatedLogFormat" extends="java.lang.Object"
  980. abstract="false"
  981. static="false" final="false" visibility="public"
  982. deprecated="not deprecated">
  983. <constructor name="AggregatedLogFormat"
  984. static="false" final="false" visibility="public"
  985. deprecated="not deprecated">
  986. </constructor>
  987. </class>
  988. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  989. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  990. <class name="AggregatedLogFormat.LogKey" extends="java.lang.Object"
  991. abstract="false"
  992. static="true" final="false" visibility="public"
  993. deprecated="not deprecated">
  994. <implements name="org.apache.hadoop.io.Writable"/>
  995. <constructor name="LogKey"
  996. static="false" final="false" visibility="public"
  997. deprecated="not deprecated">
  998. </constructor>
  999. <constructor name="LogKey" type="org.apache.hadoop.yarn.api.records.ContainerId"
  1000. static="false" final="false" visibility="public"
  1001. deprecated="not deprecated">
  1002. </constructor>
  1003. <constructor name="LogKey" type="java.lang.String"
  1004. static="false" final="false" visibility="public"
  1005. deprecated="not deprecated">
  1006. </constructor>
  1007. <method name="hashCode" return="int"
  1008. abstract="false" native="false" synchronized="false"
  1009. static="false" final="false" visibility="public"
  1010. deprecated="not deprecated">
  1011. </method>
  1012. <method name="equals" return="boolean"
  1013. abstract="false" native="false" synchronized="false"
  1014. static="false" final="false" visibility="public"
  1015. deprecated="not deprecated">
  1016. <param name="obj" type="java.lang.Object"/>
  1017. </method>
  1018. <method name="toString" return="java.lang.String"
  1019. abstract="false" native="false" synchronized="false"
  1020. static="false" final="false" visibility="public"
  1021. deprecated="not deprecated">
  1022. </method>
  1023. </class>
  1024. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  1025. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  1026. <class name="AggregatedLogFormat.LogReader" extends="java.lang.Object"
  1027. abstract="false"
  1028. static="true" final="false" visibility="public"
  1029. deprecated="not deprecated">
  1030. <constructor name="LogReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path"
  1031. static="false" final="false" visibility="public"
  1032. deprecated="not deprecated">
  1033. <exception name="IOException" type="java.io.IOException"/>
  1034. </constructor>
  1035. <method name="getApplicationOwner" return="java.lang.String"
  1036. abstract="false" native="false" synchronized="false"
  1037. static="false" final="false" visibility="public"
  1038. deprecated="not deprecated">
  1039. <exception name="IOException" type="java.io.IOException"/>
  1040. <doc>
  1041. <![CDATA[Returns the owner of the application.
  1042. @return the application owner.
  1043. @throws IOException if we can not get the application owner.]]>
  1044. </doc>
  1045. </method>
  1046. <method name="getApplicationAcls" return="java.util.Map"
  1047. abstract="false" native="false" synchronized="false"
  1048. static="false" final="false" visibility="public"
  1049. deprecated="not deprecated">
  1050. <exception name="IOException" type="java.io.IOException"/>
  1051. <doc>
  1052. <![CDATA[Returns ACLs for the application. An empty map is returned if no ACLs are
  1053. found.
  1054. @return a map of the Application ACLs.
  1055. @throws IOException if we can not get the application acls.]]>
  1056. </doc>
  1057. </method>
  1058. <method name="next" return="java.io.DataInputStream"
  1059. abstract="false" native="false" synchronized="false"
  1060. static="false" final="false" visibility="public"
  1061. deprecated="not deprecated">
  1062. <param name="key" type="org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey"/>
  1063. <exception name="IOException" type="java.io.IOException"/>
  1064. <doc>
  1065. <![CDATA[Read the next key and return the value-stream.
  1066. @param key the log key
  1067. @return the valueStream if there are more keys or null otherwise
  1068. @throws IOException if we can not get the dataInputStream
  1069. for the next key]]>
  1070. </doc>
  1071. </method>
  1072. <method name="readAcontainerLogs"
  1073. abstract="false" native="false" synchronized="false"
  1074. static="true" final="false" visibility="public"
  1075. deprecated="not deprecated">
  1076. <param name="valueStream" type="java.io.DataInputStream"/>
  1077. <param name="writer" type="java.io.Writer"/>
  1078. <param name="logUploadedTime" type="long"/>
  1079. <exception name="IOException" type="java.io.IOException"/>
  1080. <doc>
  1081. <![CDATA[Writes all logs for a single container to the provided writer.
  1082. @param valueStream the valueStream
  1083. @param writer the log writer
  1084. @param logUploadedTime the time stamp
  1085. @throws IOException if we can not read the container logs.]]>
  1086. </doc>
  1087. </method>
  1088. <method name="readAcontainerLogs"
  1089. abstract="false" native="false" synchronized="false"
  1090. static="true" final="false" visibility="public"
  1091. deprecated="not deprecated">
  1092. <param name="valueStream" type="java.io.DataInputStream"/>
  1093. <param name="writer" type="java.io.Writer"/>
  1094. <exception name="IOException" type="java.io.IOException"/>
  1095. <doc>
  1096. <![CDATA[Writes all logs for a single container to the provided writer.
  1097. @param valueStream the value stream
  1098. @param writer the log writer
  1099. @throws IOException if we can not read the container logs.]]>
  1100. </doc>
  1101. </method>
  1102. <method name="readAContainerLogsForALogType"
  1103. abstract="false" native="false" synchronized="false"
  1104. static="true" final="false" visibility="public"
  1105. deprecated="not deprecated">
  1106. <param name="valueStream" type="java.io.DataInputStream"/>
  1107. <param name="out" type="java.io.PrintStream"/>
  1108. <param name="logUploadedTime" type="long"/>
  1109. <exception name="IOException" type="java.io.IOException"/>
  1110. <doc>
  1111. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1112. all types for a single container.
  1113. @param valueStream the value stream
  1114. @param out the print stream
  1115. @param logUploadedTime the time stamp
  1116. @throws IOException if we can not read the container log by specifying
  1117. the container log type.]]>
  1118. </doc>
  1119. </method>
  1120. <method name="readAContainerLogsForALogType"
  1121. abstract="false" native="false" synchronized="false"
  1122. static="true" final="false" visibility="public"
  1123. deprecated="not deprecated">
  1124. <param name="valueStream" type="java.io.DataInputStream"/>
  1125. <param name="out" type="java.io.PrintStream"/>
  1126. <param name="logUploadedTime" type="long"/>
  1127. <param name="bytes" type="long"/>
  1128. <exception name="IOException" type="java.io.IOException"/>
  1129. <doc>
  1130. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1131. all types for a single container for the specific bytes.
  1132. @param valueStream the value stream
  1133. @param out the output print stream
  1134. @param logUploadedTime the log upload time stamp
  1135. @param bytes the output size of the log
  1136. @throws IOException if we can not read the container log]]>
  1137. </doc>
  1138. </method>
  1139. <method name="readAContainerLogsForALogType"
  1140. abstract="false" native="false" synchronized="false"
  1141. static="true" final="false" visibility="public"
  1142. deprecated="not deprecated">
  1143. <param name="valueStream" type="java.io.DataInputStream"/>
  1144. <param name="out" type="java.io.PrintStream"/>
  1145. <exception name="IOException" type="java.io.IOException"/>
  1146. <doc>
  1147. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1148. all types for a single container.
  1149. @param valueStream the value stream
  1150. @param out the output print stream
  1151. @throws IOException if we can not read the container log]]>
  1152. </doc>
  1153. </method>
  1154. <method name="readContainerLogsForALogType" return="int"
  1155. abstract="false" native="false" synchronized="false"
  1156. static="true" final="false" visibility="public"
  1157. deprecated="not deprecated">
  1158. <param name="valueStream" type="java.io.DataInputStream"/>
  1159. <param name="out" type="java.io.PrintStream"/>
  1160. <param name="logUploadedTime" type="long"/>
  1161. <param name="logType" type="java.util.List"/>
  1162. <exception name="IOException" type="java.io.IOException"/>
  1163. <doc>
  1164. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1165. the specific types for a single container.
  1166. @param valueStream the value stream
  1167. @param out the output print stream
  1168. @param logUploadedTime the log uploaded time stamp
  1169. @param logType the given log type
  1170. @throws IOException if we can not read the container logs]]>
  1171. </doc>
  1172. </method>
  1173. <method name="readContainerLogsForALogType" return="int"
  1174. abstract="false" native="false" synchronized="false"
  1175. static="true" final="false" visibility="public"
  1176. deprecated="not deprecated">
  1177. <param name="valueStream" type="java.io.DataInputStream"/>
  1178. <param name="out" type="java.io.PrintStream"/>
  1179. <param name="logUploadedTime" type="long"/>
  1180. <param name="logType" type="java.util.List"/>
  1181. <param name="bytes" type="long"/>
  1182. <exception name="IOException" type="java.io.IOException"/>
  1183. <doc>
  1184. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1185. the specific types for a single container.
  1186. @param valueStream the value stream
  1187. @param out the output print stream
  1188. @param logUploadedTime the log uploaded time stamp
  1189. @param logType the given log type
  1190. @throws IOException if we can not read the container logs]]>
  1191. </doc>
  1192. </method>
  1193. <method name="close"
  1194. abstract="false" native="false" synchronized="false"
  1195. static="false" final="false" visibility="public"
  1196. deprecated="not deprecated">
  1197. </method>
  1198. </class>
  1199. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  1200. </package>
  1201. <package name="org.apache.hadoop.yarn.logaggregation.filecontroller">
  1202. </package>
  1203. <package name="org.apache.hadoop.yarn.logaggregation.filecontroller.ifile">
  1204. </package>
  1205. <package name="org.apache.hadoop.yarn.logaggregation.filecontroller.tfile">
  1206. </package>
  1207. <package name="org.apache.hadoop.yarn.nodelabels">
  1208. </package>
  1209. <package name="org.apache.hadoop.yarn.nodelabels.event">
  1210. </package>
  1211. <package name="org.apache.hadoop.yarn.security">
  1212. <!-- start class org.apache.hadoop.yarn.security.AccessRequest -->
  1213. <class name="AccessRequest" extends="java.lang.Object"
  1214. abstract="false"
  1215. static="false" final="false" visibility="public"
  1216. deprecated="not deprecated">
  1217. <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"
  1218. static="false" final="false" visibility="public"
  1219. deprecated="not deprecated">
  1220. </constructor>
  1221. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1222. abstract="false" native="false" synchronized="false"
  1223. static="false" final="false" visibility="public"
  1224. deprecated="not deprecated">
  1225. </method>
  1226. <method name="getAccessType" return="org.apache.hadoop.yarn.security.AccessType"
  1227. abstract="false" native="false" synchronized="false"
  1228. static="false" final="false" visibility="public"
  1229. deprecated="not deprecated">
  1230. </method>
  1231. <method name="getAppId" return="java.lang.String"
  1232. abstract="false" native="false" synchronized="false"
  1233. static="false" final="false" visibility="public"
  1234. deprecated="not deprecated">
  1235. </method>
  1236. <method name="getAppName" return="java.lang.String"
  1237. abstract="false" native="false" synchronized="false"
  1238. static="false" final="false" visibility="public"
  1239. deprecated="not deprecated">
  1240. </method>
  1241. <method name="getEntity" return="org.apache.hadoop.yarn.security.PrivilegedEntity"
  1242. abstract="false" native="false" synchronized="false"
  1243. static="false" final="false" visibility="public"
  1244. deprecated="not deprecated">
  1245. </method>
  1246. <method name="getForwardedAddresses" return="java.util.List"
  1247. abstract="false" native="false" synchronized="false"
  1248. static="false" final="false" visibility="public"
  1249. deprecated="not deprecated">
  1250. </method>
  1251. <method name="getRemoteAddress" return="java.lang.String"
  1252. abstract="false" native="false" synchronized="false"
  1253. static="false" final="false" visibility="public"
  1254. deprecated="not deprecated">
  1255. </method>
  1256. <doc>
  1257. <![CDATA[This request object contains all the context information to determine whether
  1258. a user has permission to access the target entity.
  1259. user : the user who's currently accessing
  1260. accessType : the access type against the entity.
  1261. entity : the target object user is accessing.
  1262. appId : the associated app Id for current access. This could be null
  1263. if no app is associated.
  1264. appName : the associated app name for current access. This could be null if
  1265. no app is associated.
  1266. remoteAddress : The caller's remote ip address.
  1267. forwardedAddresses : In case this is an http request, this contains the
  1268. originating IP address of a client connecting to a web
  1269. server through an HTTP proxy or load balancer. This
  1270. parameter is null, if it's a RPC request.]]>
  1271. </doc>
  1272. </class>
  1273. <!-- end class org.apache.hadoop.yarn.security.AccessRequest -->
  1274. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  1275. <class name="AMRMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1276. abstract="false"
  1277. static="false" final="false" visibility="public"
  1278. deprecated="not deprecated">
  1279. <constructor name="AMRMTokenIdentifier"
  1280. static="false" final="false" visibility="public"
  1281. deprecated="not deprecated">
  1282. </constructor>
  1283. <constructor name="AMRMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, int"
  1284. static="false" final="false" visibility="public"
  1285. deprecated="not deprecated">
  1286. </constructor>
  1287. <method name="write"
  1288. abstract="false" native="false" synchronized="false"
  1289. static="false" final="false" visibility="public"
  1290. deprecated="not deprecated">
  1291. <param name="out" type="java.io.DataOutput"/>
  1292. <exception name="IOException" type="java.io.IOException"/>
  1293. </method>
  1294. <method name="readFields"
  1295. abstract="false" native="false" synchronized="false"
  1296. static="false" final="false" visibility="public"
  1297. deprecated="not deprecated">
  1298. <param name="in" type="java.io.DataInput"/>
  1299. <exception name="IOException" type="java.io.IOException"/>
  1300. </method>
  1301. <method name="getKind" return="org.apache.hadoop.io.Text"
  1302. abstract="false" native="false" synchronized="false"
  1303. static="false" final="false" visibility="public"
  1304. deprecated="not deprecated">
  1305. </method>
  1306. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1307. abstract="false" native="false" synchronized="false"
  1308. static="false" final="false" visibility="public"
  1309. deprecated="not deprecated">
  1310. </method>
  1311. <method name="getKeyId" return="int"
  1312. abstract="false" native="false" synchronized="false"
  1313. static="false" final="false" visibility="public"
  1314. deprecated="not deprecated">
  1315. </method>
  1316. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.AMRMTokenIdentifierProto"
  1317. abstract="false" native="false" synchronized="false"
  1318. static="false" final="false" visibility="public"
  1319. deprecated="not deprecated">
  1320. </method>
  1321. <method name="hashCode" return="int"
  1322. abstract="false" native="false" synchronized="false"
  1323. static="false" final="false" visibility="public"
  1324. deprecated="not deprecated">
  1325. </method>
  1326. <method name="equals" return="boolean"
  1327. abstract="false" native="false" synchronized="false"
  1328. static="false" final="false" visibility="public"
  1329. deprecated="not deprecated">
  1330. <param name="other" type="java.lang.Object"/>
  1331. </method>
  1332. <method name="toString" return="java.lang.String"
  1333. abstract="false" native="false" synchronized="false"
  1334. static="false" final="false" visibility="public"
  1335. deprecated="not deprecated">
  1336. </method>
  1337. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  1338. transient="false" volatile="false"
  1339. static="true" final="true" visibility="public"
  1340. deprecated="not deprecated">
  1341. </field>
  1342. <doc>
  1343. <![CDATA[AMRMTokenIdentifier is the TokenIdentifier to be used by
  1344. ApplicationMasters to authenticate to the ResourceManager.]]>
  1345. </doc>
  1346. </class>
  1347. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  1348. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  1349. <class name="AMRMTokenSelector" extends="java.lang.Object"
  1350. abstract="false"
  1351. static="false" final="false" visibility="public"
  1352. deprecated="not deprecated">
  1353. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1354. <constructor name="AMRMTokenSelector"
  1355. static="false" final="false" visibility="public"
  1356. deprecated="not deprecated">
  1357. </constructor>
  1358. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1359. abstract="false" native="false" synchronized="false"
  1360. static="false" final="false" visibility="public"
  1361. deprecated="not deprecated">
  1362. <param name="service" type="org.apache.hadoop.io.Text"/>
  1363. <param name="tokens" type="java.util.Collection"/>
  1364. </method>
  1365. </class>
  1366. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  1367. <!-- start class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  1368. <class name="ContainerManagerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1369. abstract="false"
  1370. static="false" final="false" visibility="public"
  1371. deprecated="not deprecated">
  1372. <constructor name="ContainerManagerSecurityInfo"
  1373. static="false" final="false" visibility="public"
  1374. deprecated="not deprecated">
  1375. </constructor>
  1376. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1377. abstract="false" native="false" synchronized="false"
  1378. static="false" final="false" visibility="public"
  1379. deprecated="not deprecated">
  1380. <param name="protocol" type="java.lang.Class"/>
  1381. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1382. </method>
  1383. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1384. abstract="false" native="false" synchronized="false"
  1385. static="false" final="false" visibility="public"
  1386. deprecated="not deprecated">
  1387. <param name="protocol" type="java.lang.Class"/>
  1388. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1389. </method>
  1390. </class>
  1391. <!-- end class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  1392. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  1393. <class name="ContainerTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1394. abstract="false"
  1395. static="false" final="false" visibility="public"
  1396. deprecated="not deprecated">
  1397. <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"
  1398. static="false" final="false" visibility="public"
  1399. deprecated="not deprecated">
  1400. </constructor>
  1401. <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"
  1402. static="false" final="false" visibility="public"
  1403. deprecated="Use one of the other constructors instead.">
  1404. <doc>
  1405. <![CDATA[Creates a instance.
  1406. @param appSubmitter appSubmitter
  1407. @param containerID container ID
  1408. @param creationTime creation time
  1409. @param expiryTimeStamp expiry timestamp
  1410. @param hostName hostname
  1411. @param logAggregationContext log aggregation context
  1412. @param masterKeyId master key ID
  1413. @param priority priority
  1414. @param r resource needed by the container
  1415. @param rmIdentifier ResourceManager identifier
  1416. @deprecated Use one of the other constructors instead.]]>
  1417. </doc>
  1418. </constructor>
  1419. <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"
  1420. static="false" final="false" visibility="public"
  1421. deprecated="not deprecated">
  1422. </constructor>
  1423. <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"
  1424. static="false" final="false" visibility="public"
  1425. deprecated="not deprecated">
  1426. </constructor>
  1427. <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"
  1428. static="false" final="false" visibility="public"
  1429. deprecated="not deprecated">
  1430. </constructor>
  1431. <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"
  1432. static="false" final="false" visibility="public"
  1433. deprecated="not deprecated">
  1434. <doc>
  1435. <![CDATA[Convenience Constructor for existing clients.
  1436. @param containerID containerID
  1437. @param containerVersion containerVersion
  1438. @param hostName hostName
  1439. @param appSubmitter appSubmitter
  1440. @param r resource
  1441. @param expiryTimeStamp expiryTimeStamp
  1442. @param masterKeyId masterKeyId
  1443. @param rmIdentifier rmIdentifier
  1444. @param priority priority
  1445. @param creationTime creationTime
  1446. @param logAggregationContext logAggregationContext
  1447. @param nodeLabelExpression nodeLabelExpression
  1448. @param containerType containerType
  1449. @param executionType executionType
  1450. @param allocationRequestId allocationRequestId]]>
  1451. </doc>
  1452. </constructor>
  1453. <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"
  1454. static="false" final="false" visibility="public"
  1455. deprecated="not deprecated">
  1456. <doc>
  1457. <![CDATA[Create a Container Token Identifier.
  1458. @param containerID containerID
  1459. @param containerVersion containerVersion
  1460. @param hostName hostName
  1461. @param appSubmitter appSubmitter
  1462. @param r resource
  1463. @param expiryTimeStamp expiryTimeStamp
  1464. @param masterKeyId masterKeyId
  1465. @param rmIdentifier rmIdentifier
  1466. @param priority priority
  1467. @param creationTime creationTime
  1468. @param logAggregationContext logAggregationContext
  1469. @param nodeLabelExpression nodeLabelExpression
  1470. @param containerType containerType
  1471. @param executionType executionType
  1472. @param allocationRequestId allocationRequestId
  1473. @param allocationTags Set of allocation Tags.]]>
  1474. </doc>
  1475. </constructor>
  1476. <constructor name="ContainerTokenIdentifier"
  1477. static="false" final="false" visibility="public"
  1478. deprecated="not deprecated">
  1479. <doc>
  1480. <![CDATA[Default constructor needed by RPC layer/SecretManager.]]>
  1481. </doc>
  1482. </constructor>
  1483. <method name="getContainerID" return="org.apache.hadoop.yarn.api.records.ContainerId"
  1484. abstract="false" native="false" synchronized="false"
  1485. static="false" final="false" visibility="public"
  1486. deprecated="not deprecated">
  1487. </method>
  1488. <method name="getApplicationSubmitter" return="java.lang.String"
  1489. abstract="false" native="false" synchronized="false"
  1490. static="false" final="false" visibility="public"
  1491. deprecated="not deprecated">
  1492. </method>
  1493. <method name="getNmHostAddress" return="java.lang.String"
  1494. abstract="false" native="false" synchronized="false"
  1495. static="false" final="false" visibility="public"
  1496. deprecated="not deprecated">
  1497. </method>
  1498. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  1499. abstract="false" native="false" synchronized="false"
  1500. static="false" final="false" visibility="public"
  1501. deprecated="not deprecated">
  1502. </method>
  1503. <method name="getExpiryTimeStamp" return="long"
  1504. abstract="false" native="false" synchronized="false"
  1505. static="false" final="false" visibility="public"
  1506. deprecated="not deprecated">
  1507. </method>
  1508. <method name="getMasterKeyId" return="int"
  1509. abstract="false" native="false" synchronized="false"
  1510. static="false" final="false" visibility="public"
  1511. deprecated="not deprecated">
  1512. </method>
  1513. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  1514. abstract="false" native="false" synchronized="false"
  1515. static="false" final="false" visibility="public"
  1516. deprecated="not deprecated">
  1517. </method>
  1518. <method name="getCreationTime" return="long"
  1519. abstract="false" native="false" synchronized="false"
  1520. static="false" final="false" visibility="public"
  1521. deprecated="not deprecated">
  1522. </method>
  1523. <method name="getRMIdentifier" return="long"
  1524. abstract="false" native="false" synchronized="false"
  1525. static="false" final="false" visibility="public"
  1526. deprecated="not deprecated">
  1527. <doc>
  1528. <![CDATA[Get the RMIdentifier of RM in which containers are allocated.
  1529. @return RMIdentifier]]>
  1530. </doc>
  1531. </method>
  1532. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  1533. abstract="false" native="false" synchronized="false"
  1534. static="false" final="false" visibility="public"
  1535. deprecated="not deprecated">
  1536. <doc>
  1537. <![CDATA[Get the ContainerType of container to allocate.
  1538. @return ContainerType]]>
  1539. </doc>
  1540. </method>
  1541. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  1542. abstract="false" native="false" synchronized="false"
  1543. static="false" final="false" visibility="public"
  1544. deprecated="not deprecated">
  1545. <doc>
  1546. <![CDATA[Get the ExecutionType of container to allocate
  1547. @return ExecutionType]]>
  1548. </doc>
  1549. </method>
  1550. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ContainerTokenIdentifierProto"
  1551. abstract="false" native="false" synchronized="false"
  1552. static="false" final="false" visibility="public"
  1553. deprecated="not deprecated">
  1554. </method>
  1555. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  1556. abstract="false" native="false" synchronized="false"
  1557. static="false" final="false" visibility="public"
  1558. deprecated="not deprecated">
  1559. </method>
  1560. <method name="getAllocationRequestId" return="long"
  1561. abstract="false" native="false" synchronized="false"
  1562. static="false" final="false" visibility="public"
  1563. deprecated="not deprecated">
  1564. </method>
  1565. <method name="write"
  1566. abstract="false" native="false" synchronized="false"
  1567. static="false" final="false" visibility="public"
  1568. deprecated="not deprecated">
  1569. <param name="out" type="java.io.DataOutput"/>
  1570. <exception name="IOException" type="java.io.IOException"/>
  1571. </method>
  1572. <method name="readFields"
  1573. abstract="false" native="false" synchronized="false"
  1574. static="false" final="false" visibility="public"
  1575. deprecated="not deprecated">
  1576. <param name="in" type="java.io.DataInput"/>
  1577. <exception name="IOException" type="java.io.IOException"/>
  1578. </method>
  1579. <method name="getKind" return="org.apache.hadoop.io.Text"
  1580. abstract="false" native="false" synchronized="false"
  1581. static="false" final="false" visibility="public"
  1582. deprecated="not deprecated">
  1583. </method>
  1584. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1585. abstract="false" native="false" synchronized="false"
  1586. static="false" final="false" visibility="public"
  1587. deprecated="not deprecated">
  1588. </method>
  1589. <method name="getVersion" return="int"
  1590. abstract="false" native="false" synchronized="false"
  1591. static="false" final="false" visibility="public"
  1592. deprecated="not deprecated">
  1593. <doc>
  1594. <![CDATA[Get the Container version
  1595. @return container version]]>
  1596. </doc>
  1597. </method>
  1598. <method name="getNodeLabelExpression" return="java.lang.String"
  1599. abstract="false" native="false" synchronized="false"
  1600. static="false" final="false" visibility="public"
  1601. deprecated="not deprecated">
  1602. <doc>
  1603. <![CDATA[Get the node-label-expression in the original ResourceRequest]]>
  1604. </doc>
  1605. </method>
  1606. <method name="getAllcationTags" return="java.util.Set"
  1607. abstract="false" native="false" synchronized="false"
  1608. static="false" final="false" visibility="public"
  1609. deprecated="not deprecated">
  1610. </method>
  1611. <method name="hashCode" return="int"
  1612. abstract="false" native="false" synchronized="false"
  1613. static="false" final="false" visibility="public"
  1614. deprecated="not deprecated">
  1615. </method>
  1616. <method name="equals" return="boolean"
  1617. abstract="false" native="false" synchronized="false"
  1618. static="false" final="false" visibility="public"
  1619. deprecated="not deprecated">
  1620. <param name="other" type="java.lang.Object"/>
  1621. </method>
  1622. <method name="toString" return="java.lang.String"
  1623. abstract="false" native="false" synchronized="false"
  1624. static="false" final="false" visibility="public"
  1625. deprecated="not deprecated">
  1626. </method>
  1627. <field name="KIND" type="org.apache.hadoop.io.Text"
  1628. transient="false" volatile="false"
  1629. static="true" final="true" visibility="public"
  1630. deprecated="not deprecated">
  1631. </field>
  1632. <doc>
  1633. <![CDATA[TokenIdentifier for a container. Encodes {@link ContainerId},
  1634. {@link Resource} needed by the container and the target NMs host-address.]]>
  1635. </doc>
  1636. </class>
  1637. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  1638. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  1639. <class name="ContainerTokenSelector" extends="java.lang.Object"
  1640. abstract="false"
  1641. static="false" final="false" visibility="public"
  1642. deprecated="not deprecated">
  1643. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1644. <constructor name="ContainerTokenSelector"
  1645. static="false" final="false" visibility="public"
  1646. deprecated="not deprecated">
  1647. </constructor>
  1648. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1649. abstract="false" native="false" synchronized="false"
  1650. static="false" final="false" visibility="public"
  1651. deprecated="not deprecated">
  1652. <param name="service" type="org.apache.hadoop.io.Text"/>
  1653. <param name="tokens" type="java.util.Collection"/>
  1654. </method>
  1655. </class>
  1656. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  1657. <!-- start class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  1658. <class name="NMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1659. abstract="false"
  1660. static="false" final="false" visibility="public"
  1661. deprecated="not deprecated">
  1662. <constructor name="NMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, org.apache.hadoop.yarn.api.records.NodeId, java.lang.String, int"
  1663. static="false" final="false" visibility="public"
  1664. deprecated="not deprecated">
  1665. </constructor>
  1666. <constructor name="NMTokenIdentifier"
  1667. static="false" final="false" visibility="public"
  1668. deprecated="not deprecated">
  1669. <doc>
  1670. <![CDATA[Default constructor needed by RPC/Secret manager]]>
  1671. </doc>
  1672. </constructor>
  1673. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1674. abstract="false" native="false" synchronized="false"
  1675. static="false" final="false" visibility="public"
  1676. deprecated="not deprecated">
  1677. </method>
  1678. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  1679. abstract="false" native="false" synchronized="false"
  1680. static="false" final="false" visibility="public"
  1681. deprecated="not deprecated">
  1682. </method>
  1683. <method name="getApplicationSubmitter" return="java.lang.String"
  1684. abstract="false" native="false" synchronized="false"
  1685. static="false" final="false" visibility="public"
  1686. deprecated="not deprecated">
  1687. </method>
  1688. <method name="getKeyId" return="int"
  1689. abstract="false" native="false" synchronized="false"
  1690. static="false" final="false" visibility="public"
  1691. deprecated="not deprecated">
  1692. </method>
  1693. <method name="write"
  1694. abstract="false" native="false" synchronized="false"
  1695. static="false" final="false" visibility="public"
  1696. deprecated="not deprecated">
  1697. <param name="out" type="java.io.DataOutput"/>
  1698. <exception name="IOException" type="java.io.IOException"/>
  1699. </method>
  1700. <method name="readFields"
  1701. abstract="false" native="false" synchronized="false"
  1702. static="false" final="false" visibility="public"
  1703. deprecated="not deprecated">
  1704. <param name="in" type="java.io.DataInput"/>
  1705. <exception name="IOException" type="java.io.IOException"/>
  1706. </method>
  1707. <method name="getKind" return="org.apache.hadoop.io.Text"
  1708. abstract="false" native="false" synchronized="false"
  1709. static="false" final="false" visibility="public"
  1710. deprecated="not deprecated">
  1711. </method>
  1712. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1713. abstract="false" native="false" synchronized="false"
  1714. static="false" final="false" visibility="public"
  1715. deprecated="not deprecated">
  1716. </method>
  1717. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.NMTokenIdentifierProto"
  1718. abstract="false" native="false" synchronized="false"
  1719. static="false" final="false" visibility="public"
  1720. deprecated="not deprecated">
  1721. </method>
  1722. <method name="hashCode" return="int"
  1723. abstract="false" native="false" synchronized="false"
  1724. static="false" final="false" visibility="public"
  1725. deprecated="not deprecated">
  1726. </method>
  1727. <method name="equals" return="boolean"
  1728. abstract="false" native="false" synchronized="false"
  1729. static="false" final="false" visibility="public"
  1730. deprecated="not deprecated">
  1731. <param name="other" type="java.lang.Object"/>
  1732. </method>
  1733. <method name="toString" return="java.lang.String"
  1734. abstract="false" native="false" synchronized="false"
  1735. static="false" final="false" visibility="public"
  1736. deprecated="not deprecated">
  1737. </method>
  1738. <field name="KIND" type="org.apache.hadoop.io.Text"
  1739. transient="false" volatile="false"
  1740. static="true" final="true" visibility="public"
  1741. deprecated="not deprecated">
  1742. </field>
  1743. </class>
  1744. <!-- end class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  1745. <!-- start class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  1746. <class name="SchedulerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1747. abstract="false"
  1748. static="false" final="false" visibility="public"
  1749. deprecated="not deprecated">
  1750. <constructor name="SchedulerSecurityInfo"
  1751. static="false" final="false" visibility="public"
  1752. deprecated="not deprecated">
  1753. </constructor>
  1754. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1755. abstract="false" native="false" synchronized="false"
  1756. static="false" final="false" visibility="public"
  1757. deprecated="not deprecated">
  1758. <param name="protocol" type="java.lang.Class"/>
  1759. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1760. </method>
  1761. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1762. abstract="false" native="false" synchronized="false"
  1763. static="false" final="false" visibility="public"
  1764. deprecated="not deprecated">
  1765. <param name="protocol" type="java.lang.Class"/>
  1766. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1767. </method>
  1768. </class>
  1769. <!-- end class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  1770. </package>
  1771. <package name="org.apache.hadoop.yarn.security.admin">
  1772. <!-- start class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  1773. <class name="AdminSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1774. abstract="false"
  1775. static="false" final="false" visibility="public"
  1776. deprecated="not deprecated">
  1777. <constructor name="AdminSecurityInfo"
  1778. static="false" final="false" visibility="public"
  1779. deprecated="not deprecated">
  1780. </constructor>
  1781. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1782. abstract="false" native="false" synchronized="false"
  1783. static="false" final="false" visibility="public"
  1784. deprecated="not deprecated">
  1785. <param name="protocol" type="java.lang.Class"/>
  1786. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1787. </method>
  1788. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1789. abstract="false" native="false" synchronized="false"
  1790. static="false" final="false" visibility="public"
  1791. deprecated="not deprecated">
  1792. <param name="protocol" type="java.lang.Class"/>
  1793. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1794. </method>
  1795. </class>
  1796. <!-- end class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  1797. </package>
  1798. <package name="org.apache.hadoop.yarn.security.client">
  1799. <!-- start class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  1800. <class name="BaseClientToAMTokenSecretManager" extends="org.apache.hadoop.security.token.SecretManager"
  1801. abstract="true"
  1802. static="false" final="false" visibility="public"
  1803. deprecated="not deprecated">
  1804. <constructor name="BaseClientToAMTokenSecretManager"
  1805. static="false" final="false" visibility="public"
  1806. deprecated="not deprecated">
  1807. </constructor>
  1808. <doc>
  1809. <![CDATA[A base {@link SecretManager} for AMs to extend and validate Client-RM tokens
  1810. issued to clients by the RM using the underlying master-key shared by RM to
  1811. the AMs on their launch. All the methods are called by either Hadoop RPC or
  1812. YARN, so this class is strictly for the purpose of inherit/extend and
  1813. register with Hadoop RPC.]]>
  1814. </doc>
  1815. </class>
  1816. <!-- end class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  1817. <!-- start class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  1818. <class name="ClientRMSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1819. abstract="false"
  1820. static="false" final="false" visibility="public"
  1821. deprecated="not deprecated">
  1822. <constructor name="ClientRMSecurityInfo"
  1823. static="false" final="false" visibility="public"
  1824. deprecated="not deprecated">
  1825. </constructor>
  1826. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1827. abstract="false" native="false" synchronized="false"
  1828. static="false" final="false" visibility="public"
  1829. deprecated="not deprecated">
  1830. <param name="protocol" type="java.lang.Class"/>
  1831. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1832. </method>
  1833. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1834. abstract="false" native="false" synchronized="false"
  1835. static="false" final="false" visibility="public"
  1836. deprecated="not deprecated">
  1837. <param name="protocol" type="java.lang.Class"/>
  1838. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1839. </method>
  1840. </class>
  1841. <!-- end class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  1842. <!-- start class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  1843. <class name="ClientTimelineSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1844. abstract="false"
  1845. static="false" final="false" visibility="public"
  1846. deprecated="not deprecated">
  1847. <constructor name="ClientTimelineSecurityInfo"
  1848. static="false" final="false" visibility="public"
  1849. deprecated="not deprecated">
  1850. </constructor>
  1851. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1852. abstract="false" native="false" synchronized="false"
  1853. static="false" final="false" visibility="public"
  1854. deprecated="not deprecated">
  1855. <param name="protocol" type="java.lang.Class"/>
  1856. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1857. </method>
  1858. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1859. abstract="false" native="false" synchronized="false"
  1860. static="false" final="false" visibility="public"
  1861. deprecated="not deprecated">
  1862. <param name="protocol" type="java.lang.Class"/>
  1863. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1864. </method>
  1865. </class>
  1866. <!-- end class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  1867. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  1868. <class name="ClientToAMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1869. abstract="false"
  1870. static="false" final="false" visibility="public"
  1871. deprecated="not deprecated">
  1872. <constructor name="ClientToAMTokenIdentifier"
  1873. static="false" final="false" visibility="public"
  1874. deprecated="not deprecated">
  1875. </constructor>
  1876. <constructor name="ClientToAMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, java.lang.String"
  1877. static="false" final="false" visibility="public"
  1878. deprecated="not deprecated">
  1879. </constructor>
  1880. <method name="getApplicationAttemptID" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1881. abstract="false" native="false" synchronized="false"
  1882. static="false" final="false" visibility="public"
  1883. deprecated="not deprecated">
  1884. </method>
  1885. <method name="getClientName" return="java.lang.String"
  1886. abstract="false" native="false" synchronized="false"
  1887. static="false" final="false" visibility="public"
  1888. deprecated="not deprecated">
  1889. </method>
  1890. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ClientToAMTokenIdentifierProto"
  1891. abstract="false" native="false" synchronized="false"
  1892. static="false" final="false" visibility="public"
  1893. deprecated="not deprecated">
  1894. </method>
  1895. <method name="write"
  1896. abstract="false" native="false" synchronized="false"
  1897. static="false" final="false" visibility="public"
  1898. deprecated="not deprecated">
  1899. <param name="out" type="java.io.DataOutput"/>
  1900. <exception name="IOException" type="java.io.IOException"/>
  1901. </method>
  1902. <method name="readFields"
  1903. abstract="false" native="false" synchronized="false"
  1904. static="false" final="false" visibility="public"
  1905. deprecated="not deprecated">
  1906. <param name="in" type="java.io.DataInput"/>
  1907. <exception name="IOException" type="java.io.IOException"/>
  1908. </method>
  1909. <method name="getKind" return="org.apache.hadoop.io.Text"
  1910. abstract="false" native="false" synchronized="false"
  1911. static="false" final="false" visibility="public"
  1912. deprecated="not deprecated">
  1913. </method>
  1914. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1915. abstract="false" native="false" synchronized="false"
  1916. static="false" final="false" visibility="public"
  1917. deprecated="not deprecated">
  1918. </method>
  1919. <method name="hashCode" return="int"
  1920. abstract="false" native="false" synchronized="false"
  1921. static="false" final="false" visibility="public"
  1922. deprecated="not deprecated">
  1923. </method>
  1924. <method name="equals" return="boolean"
  1925. abstract="false" native="false" synchronized="false"
  1926. static="false" final="false" visibility="public"
  1927. deprecated="not deprecated">
  1928. <param name="other" type="java.lang.Object"/>
  1929. </method>
  1930. <method name="toString" return="java.lang.String"
  1931. abstract="false" native="false" synchronized="false"
  1932. static="false" final="false" visibility="public"
  1933. deprecated="not deprecated">
  1934. </method>
  1935. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  1936. transient="false" volatile="false"
  1937. static="true" final="true" visibility="public"
  1938. deprecated="not deprecated">
  1939. </field>
  1940. </class>
  1941. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  1942. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  1943. <class name="ClientToAMTokenSecretManager" extends="org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager"
  1944. abstract="false"
  1945. static="false" final="false" visibility="public"
  1946. deprecated="not deprecated">
  1947. <constructor name="ClientToAMTokenSecretManager" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, byte[]"
  1948. static="false" final="false" visibility="public"
  1949. deprecated="not deprecated">
  1950. </constructor>
  1951. <method name="retrievePassword" return="byte[]"
  1952. abstract="false" native="false" synchronized="false"
  1953. static="false" final="false" visibility="public"
  1954. deprecated="not deprecated">
  1955. <param name="identifier" type="org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier"/>
  1956. <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
  1957. </method>
  1958. <method name="getMasterKey" return="javax.crypto.SecretKey"
  1959. abstract="false" native="false" synchronized="false"
  1960. static="false" final="false" visibility="public"
  1961. deprecated="not deprecated">
  1962. <param name="applicationAttemptID" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1963. </method>
  1964. <method name="setMasterKey"
  1965. abstract="false" native="false" synchronized="false"
  1966. static="false" final="false" visibility="public"
  1967. deprecated="not deprecated">
  1968. <param name="key" type="byte[]"/>
  1969. </method>
  1970. <doc>
  1971. <![CDATA[A simple {@link SecretManager} for AMs to validate Client-RM tokens issued to
  1972. clients by the RM using the underlying master-key shared by RM to the AMs on
  1973. their launch. All the methods are called by either Hadoop RPC or YARN, so
  1974. this class is strictly for the purpose of inherit/extend and register with
  1975. Hadoop RPC.]]>
  1976. </doc>
  1977. </class>
  1978. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  1979. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  1980. <class name="RMDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  1981. abstract="false"
  1982. static="false" final="false" visibility="public"
  1983. deprecated="not deprecated">
  1984. <constructor name="RMDelegationTokenIdentifier"
  1985. static="false" final="false" visibility="public"
  1986. deprecated="not deprecated">
  1987. </constructor>
  1988. <constructor name="RMDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  1989. static="false" final="false" visibility="public"
  1990. deprecated="not deprecated">
  1991. <doc>
  1992. <![CDATA[Create a new delegation token identifier
  1993. @param owner the effective username of the token owner
  1994. @param renewer the username of the renewer
  1995. @param realUser the real username of the token owner]]>
  1996. </doc>
  1997. </constructor>
  1998. <method name="getKind" return="org.apache.hadoop.io.Text"
  1999. abstract="false" native="false" synchronized="false"
  2000. static="false" final="false" visibility="public"
  2001. deprecated="not deprecated">
  2002. </method>
  2003. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2004. transient="false" volatile="false"
  2005. static="true" final="true" visibility="public"
  2006. deprecated="not deprecated">
  2007. </field>
  2008. <doc>
  2009. <![CDATA[Delegation Token Identifier that identifies the delegation tokens from the
  2010. Resource Manager.]]>
  2011. </doc>
  2012. </class>
  2013. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  2014. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  2015. <class name="RMDelegationTokenSelector" extends="java.lang.Object"
  2016. abstract="false"
  2017. static="false" final="false" visibility="public"
  2018. deprecated="not deprecated">
  2019. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2020. <constructor name="RMDelegationTokenSelector"
  2021. static="false" final="false" visibility="public"
  2022. deprecated="not deprecated">
  2023. </constructor>
  2024. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2025. abstract="false" native="false" synchronized="false"
  2026. static="false" final="false" visibility="public"
  2027. deprecated="not deprecated">
  2028. <param name="service" type="org.apache.hadoop.io.Text"/>
  2029. <param name="tokens" type="java.util.Collection"/>
  2030. </method>
  2031. </class>
  2032. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  2033. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  2034. <class name="TimelineDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  2035. abstract="false"
  2036. static="false" final="false" visibility="public"
  2037. deprecated="not deprecated">
  2038. <constructor name="TimelineDelegationTokenIdentifier"
  2039. static="false" final="false" visibility="public"
  2040. deprecated="not deprecated">
  2041. </constructor>
  2042. <constructor name="TimelineDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  2043. static="false" final="false" visibility="public"
  2044. deprecated="not deprecated">
  2045. <doc>
  2046. <![CDATA[Create a new timeline delegation token identifier
  2047. @param owner the effective username of the token owner
  2048. @param renewer the username of the renewer
  2049. @param realUser the real username of the token owner]]>
  2050. </doc>
  2051. </constructor>
  2052. <method name="getKind" return="org.apache.hadoop.io.Text"
  2053. abstract="false" native="false" synchronized="false"
  2054. static="false" final="false" visibility="public"
  2055. deprecated="not deprecated">
  2056. </method>
  2057. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2058. transient="false" volatile="false"
  2059. static="true" final="true" visibility="public"
  2060. deprecated="not deprecated">
  2061. </field>
  2062. </class>
  2063. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  2064. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  2065. <class name="TimelineDelegationTokenSelector" extends="java.lang.Object"
  2066. abstract="false"
  2067. static="false" final="false" visibility="public"
  2068. deprecated="not deprecated">
  2069. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2070. <constructor name="TimelineDelegationTokenSelector"
  2071. static="false" final="false" visibility="public"
  2072. deprecated="not deprecated">
  2073. </constructor>
  2074. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2075. abstract="false" native="false" synchronized="false"
  2076. static="false" final="false" visibility="public"
  2077. deprecated="not deprecated">
  2078. <param name="service" type="org.apache.hadoop.io.Text"/>
  2079. <param name="tokens" type="java.util.Collection"/>
  2080. </method>
  2081. </class>
  2082. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  2083. </package>
  2084. <package name="org.apache.hadoop.yarn.server.api">
  2085. </package>
  2086. <package name="org.apache.hadoop.yarn.server.api.impl.pb.client">
  2087. </package>
  2088. <package name="org.apache.hadoop.yarn.server.api.impl.pb.service">
  2089. </package>
  2090. <package name="org.apache.hadoop.yarn.sharedcache">
  2091. <!-- start interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  2092. <interface name="SharedCacheChecksum" abstract="true"
  2093. static="false" final="false" visibility="public"
  2094. deprecated="not deprecated">
  2095. <method name="computeChecksum" return="java.lang.String"
  2096. abstract="true" native="false" synchronized="false"
  2097. static="false" final="false" visibility="public"
  2098. deprecated="not deprecated">
  2099. <param name="in" type="java.io.InputStream"/>
  2100. <exception name="IOException" type="java.io.IOException"/>
  2101. <doc>
  2102. <![CDATA[Calculate the checksum of the passed input stream.
  2103. @param in <code>InputStream</code> to be checksumed
  2104. @return the message digest of the input stream
  2105. @throws IOException]]>
  2106. </doc>
  2107. </method>
  2108. </interface>
  2109. <!-- end interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  2110. <!-- start class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  2111. <class name="SharedCacheChecksumFactory" extends="java.lang.Object"
  2112. abstract="false"
  2113. static="false" final="false" visibility="public"
  2114. deprecated="not deprecated">
  2115. <constructor name="SharedCacheChecksumFactory"
  2116. static="false" final="false" visibility="public"
  2117. deprecated="not deprecated">
  2118. </constructor>
  2119. <method name="getChecksum" return="org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum"
  2120. abstract="false" native="false" synchronized="false"
  2121. static="true" final="false" visibility="public"
  2122. deprecated="not deprecated">
  2123. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2124. <doc>
  2125. <![CDATA[Get a new <code>SharedCacheChecksum</code> object based on the configurable
  2126. algorithm implementation
  2127. (see <code>yarn.sharedcache.checksum.algo.impl</code>)
  2128. @return <code>SharedCacheChecksum</code> object]]>
  2129. </doc>
  2130. </method>
  2131. </class>
  2132. <!-- end class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  2133. </package>
  2134. <package name="org.apache.hadoop.yarn.state">
  2135. <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
  2136. <class name="InvalidStateTransitionException" extends="org.apache.hadoop.yarn.state.InvalidStateTransitonException"
  2137. abstract="false"
  2138. static="false" final="false" visibility="public"
  2139. deprecated="not deprecated">
  2140. <constructor name="InvalidStateTransitionException" type="java.lang.Enum, java.lang.Enum"
  2141. static="false" final="false" visibility="public"
  2142. deprecated="not deprecated">
  2143. </constructor>
  2144. <doc>
  2145. <![CDATA[The exception that happens when you call invalid state transition.]]>
  2146. </doc>
  2147. </class>
  2148. <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
  2149. <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  2150. <class name="InvalidStateTransitonException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
  2151. abstract="false"
  2152. static="false" final="false" visibility="public"
  2153. deprecated="Use {@link InvalidStateTransitionException} instead.">
  2154. <constructor name="InvalidStateTransitonException" type="java.lang.Enum, java.lang.Enum"
  2155. static="false" final="false" visibility="public"
  2156. deprecated="not deprecated">
  2157. </constructor>
  2158. <method name="getCurrentState" return="java.lang.Enum"
  2159. abstract="false" native="false" synchronized="false"
  2160. static="false" final="false" visibility="public"
  2161. deprecated="not deprecated">
  2162. </method>
  2163. <method name="getEvent" return="java.lang.Enum"
  2164. abstract="false" native="false" synchronized="false"
  2165. static="false" final="false" visibility="public"
  2166. deprecated="not deprecated">
  2167. </method>
  2168. <doc>
  2169. <![CDATA[@deprecated Use {@link InvalidStateTransitionException} instead.]]>
  2170. </doc>
  2171. </class>
  2172. <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  2173. <!-- start interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  2174. <interface name="MultipleArcTransition" abstract="true"
  2175. static="false" final="false" visibility="public"
  2176. deprecated="not deprecated">
  2177. <method name="transition" return="STATE"
  2178. abstract="true" native="false" synchronized="false"
  2179. static="false" final="false" visibility="public"
  2180. deprecated="not deprecated">
  2181. <param name="operand" type="OPERAND"/>
  2182. <param name="event" type="EVENT"/>
  2183. <doc>
  2184. <![CDATA[Transition hook.
  2185. @return the postState. Post state must be one of the
  2186. valid post states registered in StateMachine.
  2187. @param operand the entity attached to the FSM, whose internal
  2188. state may change.
  2189. @param event causal event]]>
  2190. </doc>
  2191. </method>
  2192. <doc>
  2193. <![CDATA[Hook for Transition.
  2194. Post state is decided by Transition hook. Post state must be one of the
  2195. valid post states registered in StateMachine.]]>
  2196. </doc>
  2197. </interface>
  2198. <!-- end interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  2199. <!-- start interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  2200. <interface name="SingleArcTransition" abstract="true"
  2201. static="false" final="false" visibility="public"
  2202. deprecated="not deprecated">
  2203. <method name="transition"
  2204. abstract="true" native="false" synchronized="false"
  2205. static="false" final="false" visibility="public"
  2206. deprecated="not deprecated">
  2207. <param name="operand" type="OPERAND"/>
  2208. <param name="event" type="EVENT"/>
  2209. <doc>
  2210. <![CDATA[Transition hook.
  2211. @param operand the entity attached to the FSM, whose internal
  2212. state may change.
  2213. @param event causal event]]>
  2214. </doc>
  2215. </method>
  2216. <doc>
  2217. <![CDATA[Hook for Transition. This lead to state machine to move to
  2218. the post state as registered in the state machine.]]>
  2219. </doc>
  2220. </interface>
  2221. <!-- end interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  2222. <!-- start interface org.apache.hadoop.yarn.state.StateMachine -->
  2223. <interface name="StateMachine" abstract="true"
  2224. static="false" final="false" visibility="public"
  2225. deprecated="not deprecated">
  2226. <method name="getCurrentState" return="STATE"
  2227. abstract="true" native="false" synchronized="false"
  2228. static="false" final="false" visibility="public"
  2229. deprecated="not deprecated">
  2230. </method>
  2231. <method name="doTransition" return="STATE"
  2232. abstract="true" native="false" synchronized="false"
  2233. static="false" final="false" visibility="public"
  2234. deprecated="not deprecated">
  2235. <param name="eventType" type="EVENTTYPE"/>
  2236. <param name="event" type="EVENT"/>
  2237. <exception name="InvalidStateTransitionException" type="org.apache.hadoop.yarn.state.InvalidStateTransitionException"/>
  2238. </method>
  2239. </interface>
  2240. <!-- end interface org.apache.hadoop.yarn.state.StateMachine -->
  2241. <!-- start class org.apache.hadoop.yarn.state.StateMachineFactory -->
  2242. <class name="StateMachineFactory" extends="java.lang.Object"
  2243. abstract="false"
  2244. static="false" final="true" visibility="public"
  2245. deprecated="not deprecated">
  2246. <constructor name="StateMachineFactory" type="STATE"
  2247. static="false" final="false" visibility="public"
  2248. deprecated="not deprecated">
  2249. <doc>
  2250. <![CDATA[Constructor
  2251. This is the only constructor in the API.]]>
  2252. </doc>
  2253. </constructor>
  2254. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2255. abstract="false" native="false" synchronized="false"
  2256. static="false" final="false" visibility="public"
  2257. deprecated="not deprecated">
  2258. <param name="preState" type="STATE"/>
  2259. <param name="postState" type="STATE"/>
  2260. <param name="eventType" type="EVENTTYPE"/>
  2261. <doc>
  2262. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2263. transition added as a new legal transition. This overload
  2264. has no hook object.
  2265. Note that the returned StateMachineFactory is a distinct
  2266. object.
  2267. This method is part of the API.
  2268. @param preState pre-transition state
  2269. @param postState post-transition state
  2270. @param eventType stimulus for the transition]]>
  2271. </doc>
  2272. </method>
  2273. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2274. abstract="false" native="false" synchronized="false"
  2275. static="false" final="false" visibility="public"
  2276. deprecated="not deprecated">
  2277. <param name="preState" type="STATE"/>
  2278. <param name="postState" type="STATE"/>
  2279. <param name="eventTypes" type="java.util.Set"/>
  2280. <doc>
  2281. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2282. transition added as a new legal transition. This overload
  2283. has no hook object.
  2284. Note that the returned StateMachineFactory is a distinct
  2285. object.
  2286. This method is part of the API.
  2287. @param preState pre-transition state
  2288. @param postState post-transition state
  2289. @param eventTypes List of stimuli for the transitions]]>
  2290. </doc>
  2291. </method>
  2292. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2293. abstract="false" native="false" synchronized="false"
  2294. static="false" final="false" visibility="public"
  2295. deprecated="not deprecated">
  2296. <param name="preState" type="STATE"/>
  2297. <param name="postState" type="STATE"/>
  2298. <param name="eventTypes" type="java.util.Set"/>
  2299. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  2300. <doc>
  2301. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2302. transition added as a new legal transition
  2303. Note that the returned StateMachineFactory is a distinct
  2304. object.
  2305. This method is part of the API.
  2306. @param preState pre-transition state
  2307. @param postState post-transition state
  2308. @param eventTypes List of stimuli for the transitions
  2309. @param hook transition hook]]>
  2310. </doc>
  2311. </method>
  2312. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2313. abstract="false" native="false" synchronized="false"
  2314. static="false" final="false" visibility="public"
  2315. deprecated="not deprecated">
  2316. <param name="preState" type="STATE"/>
  2317. <param name="postState" type="STATE"/>
  2318. <param name="eventType" type="EVENTTYPE"/>
  2319. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  2320. <doc>
  2321. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2322. transition added as a new legal transition
  2323. Note that the returned StateMachineFactory is a distinct object.
  2324. This method is part of the API.
  2325. @param preState pre-transition state
  2326. @param postState post-transition state
  2327. @param eventType stimulus for the transition
  2328. @param hook transition hook]]>
  2329. </doc>
  2330. </method>
  2331. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2332. abstract="false" native="false" synchronized="false"
  2333. static="false" final="false" visibility="public"
  2334. deprecated="not deprecated">
  2335. <param name="preState" type="STATE"/>
  2336. <param name="postStates" type="java.util.Set"/>
  2337. <param name="eventType" type="EVENTTYPE"/>
  2338. <param name="hook" type="org.apache.hadoop.yarn.state.MultipleArcTransition"/>
  2339. <doc>
  2340. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2341. transition added as a new legal transition
  2342. Note that the returned StateMachineFactory is a distinct object.
  2343. This method is part of the API.
  2344. @param preState pre-transition state
  2345. @param postStates valid post-transition states
  2346. @param eventType stimulus for the transition
  2347. @param hook transition hook]]>
  2348. </doc>
  2349. </method>
  2350. <method name="installTopology" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2351. abstract="false" native="false" synchronized="false"
  2352. static="false" final="false" visibility="public"
  2353. deprecated="not deprecated">
  2354. <doc>
  2355. <![CDATA[@return a StateMachineFactory just like {@code this}, except that if
  2356. you won't need any synchronization to build a state machine
  2357. Note that the returned StateMachineFactory is a distinct object.
  2358. This method is part of the API.
  2359. The only way you could distinguish the returned
  2360. StateMachineFactory from {@code this} would be by
  2361. measuring the performance of the derived
  2362. {@code StateMachine} you can get from it.
  2363. Calling this is optional. It doesn't change the semantics of the factory,
  2364. if you call it then when you use the factory there is no synchronization.]]>
  2365. </doc>
  2366. </method>
  2367. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2368. abstract="false" native="false" synchronized="false"
  2369. static="false" final="false" visibility="public"
  2370. deprecated="not deprecated">
  2371. <param name="operand" type="OPERAND"/>
  2372. <param name="initialState" type="STATE"/>
  2373. <param name="listener" type="org.apache.hadoop.yarn.state.StateTransitionListener"/>
  2374. <doc>
  2375. <![CDATA[A StateMachine that accepts a transition listener.
  2376. @param operand the object upon which the returned
  2377. {@link StateMachine} will operate.
  2378. @param initialState the state in which the returned
  2379. {@link StateMachine} will start.
  2380. @param listener An implementation of a {@link StateTransitionListener}.
  2381. @return A (@link StateMachine}.]]>
  2382. </doc>
  2383. </method>
  2384. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2385. abstract="false" native="false" synchronized="false"
  2386. static="false" final="false" visibility="public"
  2387. deprecated="not deprecated">
  2388. <param name="operand" type="OPERAND"/>
  2389. <param name="initialState" type="STATE"/>
  2390. </method>
  2391. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2392. abstract="false" native="false" synchronized="false"
  2393. static="false" final="false" visibility="public"
  2394. deprecated="not deprecated">
  2395. <param name="operand" type="OPERAND"/>
  2396. </method>
  2397. <method name="generateStateGraph" return="org.apache.hadoop.yarn.state.Graph"
  2398. abstract="false" native="false" synchronized="false"
  2399. static="false" final="false" visibility="public"
  2400. deprecated="not deprecated">
  2401. <param name="name" type="java.lang.String"/>
  2402. <doc>
  2403. <![CDATA[Generate a graph represents the state graph of this StateMachine
  2404. @param name graph name
  2405. @return Graph object generated]]>
  2406. </doc>
  2407. </method>
  2408. <doc>
  2409. <![CDATA[State machine topology.
  2410. This object is semantically immutable. If you have a
  2411. StateMachineFactory there's no operation in the API that changes
  2412. its semantic properties.
  2413. @param <OPERAND> The object type on which this state machine operates.
  2414. @param <STATE> The state of the entity.
  2415. @param <EVENTTYPE> The external eventType to be handled.
  2416. @param <EVENT> The event object.]]>
  2417. </doc>
  2418. </class>
  2419. <!-- end class org.apache.hadoop.yarn.state.StateMachineFactory -->
  2420. <!-- start interface org.apache.hadoop.yarn.state.StateTransitionListener -->
  2421. <interface name="StateTransitionListener" abstract="true"
  2422. static="false" final="false" visibility="public"
  2423. deprecated="not deprecated">
  2424. <method name="preTransition"
  2425. abstract="true" native="false" synchronized="false"
  2426. static="false" final="false" visibility="public"
  2427. deprecated="not deprecated">
  2428. <param name="op" type="OPERAND"/>
  2429. <param name="beforeState" type="STATE"/>
  2430. <param name="eventToBeProcessed" type="EVENT"/>
  2431. <doc>
  2432. <![CDATA[Pre Transition Hook. This will be called before transition.
  2433. @param op Operand.
  2434. @param beforeState State before transition.
  2435. @param eventToBeProcessed Incoming Event.]]>
  2436. </doc>
  2437. </method>
  2438. <method name="postTransition"
  2439. abstract="true" native="false" synchronized="false"
  2440. static="false" final="false" visibility="public"
  2441. deprecated="not deprecated">
  2442. <param name="op" type="OPERAND"/>
  2443. <param name="beforeState" type="STATE"/>
  2444. <param name="afterState" type="STATE"/>
  2445. <param name="processedEvent" type="EVENT"/>
  2446. <doc>
  2447. <![CDATA[Post Transition Hook. This will be called after the transition.
  2448. @param op Operand.
  2449. @param beforeState State before transition.
  2450. @param afterState State after transition.
  2451. @param processedEvent Processed Event.]]>
  2452. </doc>
  2453. </method>
  2454. <doc>
  2455. <![CDATA[A State Transition Listener.
  2456. It exposes a pre and post transition hook called before and
  2457. after the transition.]]>
  2458. </doc>
  2459. </interface>
  2460. <!-- end interface org.apache.hadoop.yarn.state.StateTransitionListener -->
  2461. </package>
  2462. <package name="org.apache.hadoop.yarn.util">
  2463. <!-- start class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  2464. <class name="AbstractLivelinessMonitor" extends="org.apache.hadoop.service.AbstractService"
  2465. abstract="true"
  2466. static="false" final="false" visibility="public"
  2467. deprecated="not deprecated">
  2468. <constructor name="AbstractLivelinessMonitor" type="java.lang.String, org.apache.hadoop.yarn.util.Clock"
  2469. static="false" final="false" visibility="public"
  2470. deprecated="not deprecated">
  2471. </constructor>
  2472. <constructor name="AbstractLivelinessMonitor" type="java.lang.String"
  2473. static="false" final="false" visibility="public"
  2474. deprecated="not deprecated">
  2475. </constructor>
  2476. <method name="serviceStart"
  2477. abstract="false" native="false" synchronized="false"
  2478. static="false" final="false" visibility="protected"
  2479. deprecated="not deprecated">
  2480. <exception name="Exception" type="java.lang.Exception"/>
  2481. </method>
  2482. <method name="serviceStop"
  2483. abstract="false" native="false" synchronized="false"
  2484. static="false" final="false" visibility="protected"
  2485. deprecated="not deprecated">
  2486. <exception name="Exception" type="java.lang.Exception"/>
  2487. </method>
  2488. <method name="expire"
  2489. abstract="true" native="false" synchronized="false"
  2490. static="false" final="false" visibility="protected"
  2491. deprecated="not deprecated">
  2492. <param name="ob" type="O"/>
  2493. </method>
  2494. <method name="setExpireInterval"
  2495. abstract="false" native="false" synchronized="false"
  2496. static="false" final="false" visibility="protected"
  2497. deprecated="not deprecated">
  2498. <param name="expireInterval" type="int"/>
  2499. </method>
  2500. <method name="getExpireInterval" return="long"
  2501. abstract="false" native="false" synchronized="false"
  2502. static="false" final="false" visibility="protected"
  2503. deprecated="not deprecated">
  2504. <param name="o" type="O"/>
  2505. </method>
  2506. <method name="setMonitorInterval"
  2507. abstract="false" native="false" synchronized="false"
  2508. static="false" final="false" visibility="protected"
  2509. deprecated="not deprecated">
  2510. <param name="monitorInterval" type="long"/>
  2511. </method>
  2512. <method name="receivedPing"
  2513. abstract="false" native="false" synchronized="true"
  2514. static="false" final="false" visibility="public"
  2515. deprecated="not deprecated">
  2516. <param name="ob" type="O"/>
  2517. </method>
  2518. <method name="register"
  2519. abstract="false" native="false" synchronized="true"
  2520. static="false" final="false" visibility="public"
  2521. deprecated="not deprecated">
  2522. <param name="ob" type="O"/>
  2523. </method>
  2524. <method name="register"
  2525. abstract="false" native="false" synchronized="true"
  2526. static="false" final="false" visibility="public"
  2527. deprecated="not deprecated">
  2528. <param name="ob" type="O"/>
  2529. <param name="expireTime" type="long"/>
  2530. </method>
  2531. <method name="unregister"
  2532. abstract="false" native="false" synchronized="true"
  2533. static="false" final="false" visibility="public"
  2534. deprecated="not deprecated">
  2535. <param name="ob" type="O"/>
  2536. </method>
  2537. <method name="resetTimer"
  2538. abstract="false" native="false" synchronized="true"
  2539. static="false" final="false" visibility="public"
  2540. deprecated="not deprecated">
  2541. </method>
  2542. <method name="setResetTimeOnStart"
  2543. abstract="false" native="false" synchronized="false"
  2544. static="false" final="false" visibility="protected"
  2545. deprecated="not deprecated">
  2546. <param name="resetTimeOnStart" type="boolean"/>
  2547. </method>
  2548. <field name="DEFAULT_EXPIRE" type="int"
  2549. transient="false" volatile="false"
  2550. static="true" final="true" visibility="public"
  2551. deprecated="not deprecated">
  2552. </field>
  2553. <doc>
  2554. <![CDATA[A simple liveliness monitor with which clients can register, trust the
  2555. component to monitor liveliness, get a call-back on expiry and then finally
  2556. unregister.]]>
  2557. </doc>
  2558. </class>
  2559. <!-- end class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  2560. <!-- start class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  2561. <class name="ApplicationClassLoader" extends="org.apache.hadoop.util.ApplicationClassLoader"
  2562. abstract="false"
  2563. static="false" final="false" visibility="public"
  2564. deprecated="not deprecated">
  2565. <constructor name="ApplicationClassLoader" type="java.net.URL[], java.lang.ClassLoader, java.util.List"
  2566. static="false" final="false" visibility="public"
  2567. deprecated="not deprecated">
  2568. </constructor>
  2569. <constructor name="ApplicationClassLoader" type="java.lang.String, java.lang.ClassLoader, java.util.List"
  2570. static="false" final="false" visibility="public"
  2571. deprecated="not deprecated">
  2572. <exception name="MalformedURLException" type="java.net.MalformedURLException"/>
  2573. </constructor>
  2574. <doc>
  2575. <![CDATA[This type has been deprecated in favor of
  2576. {@link org.apache.hadoop.util.ApplicationClassLoader}. All new uses of
  2577. ApplicationClassLoader should use that type instead.]]>
  2578. </doc>
  2579. </class>
  2580. <!-- end class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  2581. <!-- start class org.apache.hadoop.yarn.util.BoundedAppender -->
  2582. <class name="BoundedAppender" extends="java.lang.Object"
  2583. abstract="false"
  2584. static="false" final="false" visibility="public"
  2585. deprecated="not deprecated">
  2586. <constructor name="BoundedAppender" type="int"
  2587. static="false" final="false" visibility="public"
  2588. deprecated="not deprecated">
  2589. </constructor>
  2590. <method name="append" return="org.apache.hadoop.yarn.util.BoundedAppender"
  2591. abstract="false" native="false" synchronized="false"
  2592. static="false" final="false" visibility="public"
  2593. deprecated="not deprecated">
  2594. <param name="csq" type="java.lang.CharSequence"/>
  2595. <doc>
  2596. <![CDATA[Append a {@link CharSequence} considering {@link #limit}, truncating
  2597. from the head of {@code csq} or {@link #messages} when necessary.
  2598. @param csq the {@link CharSequence} to append
  2599. @return this]]>
  2600. </doc>
  2601. </method>
  2602. <method name="length" return="int"
  2603. abstract="false" native="false" synchronized="false"
  2604. static="false" final="false" visibility="public"
  2605. deprecated="not deprecated">
  2606. <doc>
  2607. <![CDATA[Get current length of messages considering truncates
  2608. without header and ellipses.
  2609. @return current length]]>
  2610. </doc>
  2611. </method>
  2612. <method name="getLimit" return="int"
  2613. abstract="false" native="false" synchronized="false"
  2614. static="false" final="false" visibility="public"
  2615. deprecated="not deprecated">
  2616. </method>
  2617. <method name="toString" return="java.lang.String"
  2618. abstract="false" native="false" synchronized="false"
  2619. static="false" final="false" visibility="public"
  2620. deprecated="not deprecated">
  2621. <doc>
  2622. <![CDATA[Get a string representation of the actual contents, displaying also a
  2623. header and ellipses when there was a truncate.
  2624. @return String representation of the {@link #messages}]]>
  2625. </doc>
  2626. </method>
  2627. <field name="TRUNCATED_MESSAGES_TEMPLATE" type="java.lang.String"
  2628. transient="false" volatile="false"
  2629. static="true" final="true" visibility="public"
  2630. deprecated="not deprecated">
  2631. </field>
  2632. <doc>
  2633. <![CDATA[A {@link CharSequence} appender that considers its {@link #limit} as upper
  2634. bound.
  2635. <p>
  2636. When {@link #limit} would be reached on append, past messages will be
  2637. truncated from head, and a header telling the user about truncation will be
  2638. prepended, with ellipses in between header and messages.
  2639. <p>
  2640. Note that header and ellipses are not counted against {@link #limit}.
  2641. <p>
  2642. An example:
  2643. <pre>
  2644. {@code
  2645. // At the beginning it's an empty string
  2646. final Appendable shortAppender = new BoundedAppender(80);
  2647. // The whole message fits into limit
  2648. shortAppender.append(
  2649. "message1 this is a very long message but fitting into limit\n");
  2650. // The first message is truncated, the second not
  2651. shortAppender.append("message2 this is shorter than the previous one\n");
  2652. // The first message is deleted, the second truncated, the third
  2653. // preserved
  2654. shortAppender.append("message3 this is even shorter message, maybe.\n");
  2655. // The first two are deleted, the third one truncated, the last preserved
  2656. shortAppender.append("message4 the shortest one, yet the greatest :)");
  2657. // Current contents are like this:
  2658. // Diagnostic messages truncated, showing last 80 chars out of 199:
  2659. // ...s is even shorter message, maybe.
  2660. // message4 the shortest one, yet the greatest :)
  2661. }
  2662. </pre>
  2663. <p>
  2664. Note that <tt>null</tt> values are {@link #append(CharSequence) append}ed
  2665. just like in {@link StringBuilder#append(CharSequence) original
  2666. implementation}.
  2667. <p>
  2668. Note that this class is not thread safe.]]>
  2669. </doc>
  2670. </class>
  2671. <!-- end class org.apache.hadoop.yarn.util.BoundedAppender -->
  2672. <!-- start interface org.apache.hadoop.yarn.util.Clock -->
  2673. <interface name="Clock" abstract="true"
  2674. static="false" final="false" visibility="public"
  2675. deprecated="not deprecated">
  2676. <method name="getTime" return="long"
  2677. abstract="true" native="false" synchronized="false"
  2678. static="false" final="false" visibility="public"
  2679. deprecated="not deprecated">
  2680. </method>
  2681. <doc>
  2682. <![CDATA[A simple clock interface that gives you time.]]>
  2683. </doc>
  2684. </interface>
  2685. <!-- end interface org.apache.hadoop.yarn.util.Clock -->
  2686. <!-- start class org.apache.hadoop.yarn.util.ConverterUtils -->
  2687. <class name="ConverterUtils" extends="java.lang.Object"
  2688. abstract="false"
  2689. static="false" final="false" visibility="public"
  2690. deprecated="not deprecated">
  2691. <constructor name="ConverterUtils"
  2692. static="false" final="false" visibility="public"
  2693. deprecated="not deprecated">
  2694. </constructor>
  2695. <method name="getPathFromYarnURL" return="org.apache.hadoop.fs.Path"
  2696. abstract="false" native="false" synchronized="false"
  2697. static="true" final="false" visibility="public"
  2698. deprecated="not deprecated">
  2699. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  2700. <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
  2701. <doc>
  2702. <![CDATA[return a hadoop path from a given url
  2703. This method is deprecated, use {@link URL#toPath()} instead.
  2704. @param url
  2705. url to convert
  2706. @return path from {@link URL}
  2707. @throws URISyntaxException]]>
  2708. </doc>
  2709. </method>
  2710. <method name="getYarnUrlFromPath" return="org.apache.hadoop.yarn.api.records.URL"
  2711. abstract="false" native="false" synchronized="false"
  2712. static="true" final="false" visibility="public"
  2713. deprecated="not deprecated">
  2714. <param name="path" type="org.apache.hadoop.fs.Path"/>
  2715. </method>
  2716. <method name="getYarnUrlFromURI" return="org.apache.hadoop.yarn.api.records.URL"
  2717. abstract="false" native="false" synchronized="false"
  2718. static="true" final="false" visibility="public"
  2719. deprecated="not deprecated">
  2720. <param name="uri" type="java.net.URI"/>
  2721. </method>
  2722. <method name="toString" return="java.lang.String"
  2723. abstract="false" native="false" synchronized="false"
  2724. static="true" final="false" visibility="public"
  2725. deprecated="not deprecated">
  2726. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2727. </method>
  2728. <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2729. abstract="false" native="false" synchronized="false"
  2730. static="true" final="false" visibility="public"
  2731. deprecated="not deprecated">
  2732. <param name="recordFactory" type="org.apache.hadoop.yarn.factories.RecordFactory"/>
  2733. <param name="applicationIdStr" type="java.lang.String"/>
  2734. </method>
  2735. <method name="toString" return="java.lang.String"
  2736. abstract="false" native="false" synchronized="false"
  2737. static="true" final="false" visibility="public"
  2738. deprecated="not deprecated">
  2739. <param name="cId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2740. </method>
  2741. <method name="toNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  2742. abstract="false" native="false" synchronized="false"
  2743. static="true" final="false" visibility="public"
  2744. deprecated="not deprecated">
  2745. <param name="nodeIdStr" type="java.lang.String"/>
  2746. </method>
  2747. <method name="toContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  2748. abstract="false" native="false" synchronized="false"
  2749. static="true" final="false" visibility="public"
  2750. deprecated="not deprecated">
  2751. <param name="containerIdStr" type="java.lang.String"/>
  2752. </method>
  2753. <method name="toApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2754. abstract="false" native="false" synchronized="false"
  2755. static="true" final="false" visibility="public"
  2756. deprecated="not deprecated">
  2757. <param name="applicationAttemptIdStr" type="java.lang.String"/>
  2758. </method>
  2759. <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2760. abstract="false" native="false" synchronized="false"
  2761. static="true" final="false" visibility="public"
  2762. deprecated="not deprecated">
  2763. <param name="appIdStr" type="java.lang.String"/>
  2764. </method>
  2765. <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
  2766. abstract="false" native="false" synchronized="false"
  2767. static="true" final="false" visibility="public"
  2768. deprecated="not deprecated">
  2769. <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  2770. <param name="serviceAddr" type="java.net.InetSocketAddress"/>
  2771. <doc>
  2772. <![CDATA[Convert a protobuf token into a rpc token and set its service. Supposed
  2773. to be used for tokens other than RMDelegationToken. For
  2774. RMDelegationToken, use
  2775. {@link #convertFromYarn(org.apache.hadoop.yarn.api.records.Token,
  2776. org.apache.hadoop.io.Text)} instead.
  2777. @param protoToken the yarn token
  2778. @param serviceAddr the connect address for the service
  2779. @return rpc token]]>
  2780. </doc>
  2781. </method>
  2782. <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
  2783. abstract="false" native="false" synchronized="false"
  2784. static="true" final="false" visibility="public"
  2785. deprecated="not deprecated">
  2786. <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  2787. <param name="service" type="org.apache.hadoop.io.Text"/>
  2788. <doc>
  2789. <![CDATA[Convert a protobuf token into a rpc token and set its service.
  2790. @param protoToken the yarn token
  2791. @param service the service for the token]]>
  2792. </doc>
  2793. </method>
  2794. <field name="APPLICATION_PREFIX" type="java.lang.String"
  2795. transient="false" volatile="false"
  2796. static="true" final="true" visibility="public"
  2797. deprecated="not deprecated">
  2798. </field>
  2799. <field name="CONTAINER_PREFIX" type="java.lang.String"
  2800. transient="false" volatile="false"
  2801. static="true" final="true" visibility="public"
  2802. deprecated="not deprecated">
  2803. </field>
  2804. <field name="APPLICATION_ATTEMPT_PREFIX" type="java.lang.String"
  2805. transient="false" volatile="false"
  2806. static="true" final="true" visibility="public"
  2807. deprecated="not deprecated">
  2808. </field>
  2809. <doc>
  2810. <![CDATA[This class contains a set of utilities which help converting data structures
  2811. from/to 'serializableFormat' to/from hadoop/nativejava data structures.]]>
  2812. </doc>
  2813. </class>
  2814. <!-- end class org.apache.hadoop.yarn.util.ConverterUtils -->
  2815. <!-- start class org.apache.hadoop.yarn.util.MonotonicClock -->
  2816. <class name="MonotonicClock" extends="java.lang.Object"
  2817. abstract="false"
  2818. static="false" final="false" visibility="public"
  2819. deprecated="not deprecated">
  2820. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  2821. <constructor name="MonotonicClock"
  2822. static="false" final="false" visibility="public"
  2823. deprecated="not deprecated">
  2824. </constructor>
  2825. <method name="getTime" return="long"
  2826. abstract="false" native="false" synchronized="false"
  2827. static="false" final="false" visibility="public"
  2828. deprecated="not deprecated">
  2829. <doc>
  2830. <![CDATA[Get current time from some arbitrary time base in the past, counting in
  2831. milliseconds, and not affected by settimeofday or similar system clock
  2832. changes.
  2833. @return a monotonic clock that counts in milliseconds.]]>
  2834. </doc>
  2835. </method>
  2836. <doc>
  2837. <![CDATA[A monotonic clock from some arbitrary time base in the past, counting in
  2838. milliseconds, and not affected by settimeofday or similar system clock
  2839. changes.
  2840. This is appropriate to use when computing how much longer to wait for an
  2841. interval to expire.
  2842. This function can return a negative value and it must be handled correctly
  2843. by callers. See the documentation of System#nanoTime for caveats.]]>
  2844. </doc>
  2845. </class>
  2846. <!-- end class org.apache.hadoop.yarn.util.MonotonicClock -->
  2847. <!-- start class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  2848. <class name="ResourceCalculatorProcessTree" extends="org.apache.hadoop.conf.Configured"
  2849. abstract="true"
  2850. static="false" final="false" visibility="public"
  2851. deprecated="not deprecated">
  2852. <constructor name="ResourceCalculatorProcessTree" type="java.lang.String"
  2853. static="false" final="false" visibility="public"
  2854. deprecated="not deprecated">
  2855. <doc>
  2856. <![CDATA[Create process-tree instance with specified root process.
  2857. Subclass must override this.
  2858. @param root process-tree root-process]]>
  2859. </doc>
  2860. </constructor>
  2861. <method name="initialize"
  2862. abstract="false" native="false" synchronized="false"
  2863. static="false" final="false" visibility="public"
  2864. deprecated="not deprecated">
  2865. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  2866. <doc>
  2867. <![CDATA[Initialize the object.
  2868. @throws YarnException Throws an exception on error.]]>
  2869. </doc>
  2870. </method>
  2871. <method name="updateProcessTree"
  2872. abstract="true" native="false" synchronized="false"
  2873. static="false" final="false" visibility="public"
  2874. deprecated="not deprecated">
  2875. <doc>
  2876. <![CDATA[Update the process-tree with latest state.
  2877. Each call to this function should increment the age of the running
  2878. processes that already exist in the process tree. Age is used other API's
  2879. of the interface.]]>
  2880. </doc>
  2881. </method>
  2882. <method name="getProcessTreeDump" return="java.lang.String"
  2883. abstract="true" native="false" synchronized="false"
  2884. static="false" final="false" visibility="public"
  2885. deprecated="not deprecated">
  2886. <doc>
  2887. <![CDATA[Get a dump of the process-tree.
  2888. @return a string concatenating the dump of information of all the processes
  2889. in the process-tree]]>
  2890. </doc>
  2891. </method>
  2892. <method name="getVirtualMemorySize" return="long"
  2893. abstract="false" native="false" synchronized="false"
  2894. static="false" final="false" visibility="public"
  2895. deprecated="not deprecated">
  2896. <doc>
  2897. <![CDATA[Get the virtual memory used by all the processes in the
  2898. process-tree.
  2899. @return virtual memory used by the process-tree in bytes,
  2900. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2901. </doc>
  2902. </method>
  2903. <method name="getRssMemorySize" return="long"
  2904. abstract="false" native="false" synchronized="false"
  2905. static="false" final="false" visibility="public"
  2906. deprecated="not deprecated">
  2907. <doc>
  2908. <![CDATA[Get the resident set size (rss) memory used by all the processes
  2909. in the process-tree.
  2910. @return rss memory used by the process-tree in bytes,
  2911. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2912. </doc>
  2913. </method>
  2914. <method name="getVirtualMemorySize" return="long"
  2915. abstract="false" native="false" synchronized="false"
  2916. static="false" final="false" visibility="public"
  2917. deprecated="not deprecated">
  2918. <param name="olderThanAge" type="int"/>
  2919. <doc>
  2920. <![CDATA[Get the virtual memory used by all the processes in the
  2921. process-tree that are older than the passed in age.
  2922. @param olderThanAge processes above this age are included in the
  2923. memory addition
  2924. @return virtual memory used by the process-tree in bytes for
  2925. processes older than the specified age, {@link #UNAVAILABLE} if it
  2926. cannot be calculated.]]>
  2927. </doc>
  2928. </method>
  2929. <method name="getRssMemorySize" return="long"
  2930. abstract="false" native="false" synchronized="false"
  2931. static="false" final="false" visibility="public"
  2932. deprecated="not deprecated">
  2933. <param name="olderThanAge" type="int"/>
  2934. <doc>
  2935. <![CDATA[Get the resident set size (rss) memory used by all the processes
  2936. in the process-tree that are older than the passed in age.
  2937. @param olderThanAge processes above this age are included in the
  2938. memory addition
  2939. @return rss memory used by the process-tree in bytes for
  2940. processes older than specified age, {@link #UNAVAILABLE} if it cannot be
  2941. calculated.]]>
  2942. </doc>
  2943. </method>
  2944. <method name="getCumulativeCpuTime" return="long"
  2945. abstract="false" native="false" synchronized="false"
  2946. static="false" final="false" visibility="public"
  2947. deprecated="not deprecated">
  2948. <doc>
  2949. <![CDATA[Get the CPU time in millisecond used by all the processes in the
  2950. process-tree since the process-tree was created
  2951. @return cumulative CPU time in millisecond since the process-tree
  2952. created, {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2953. </doc>
  2954. </method>
  2955. <method name="getCpuUsagePercent" return="float"
  2956. abstract="false" native="false" synchronized="false"
  2957. static="false" final="false" visibility="public"
  2958. deprecated="not deprecated">
  2959. <doc>
  2960. <![CDATA[Get the CPU usage by all the processes in the process-tree based on
  2961. average between samples as a ratio of overall CPU cycles similar to top.
  2962. Thus, if 2 out of 4 cores are used this should return 200.0.
  2963. Note: UNAVAILABLE will be returned in case when CPU usage is not
  2964. available. It is NOT advised to return any other error code.
  2965. @return percentage CPU usage since the process-tree was created,
  2966. {@link #UNAVAILABLE} if CPU usage cannot be calculated or not available.]]>
  2967. </doc>
  2968. </method>
  2969. <method name="checkPidPgrpidForMatch" return="boolean"
  2970. abstract="true" native="false" synchronized="false"
  2971. static="false" final="false" visibility="public"
  2972. deprecated="not deprecated">
  2973. <doc>
  2974. <![CDATA[Verify that the tree process id is same as its process group id.
  2975. @return true if the process id matches else return false.]]>
  2976. </doc>
  2977. </method>
  2978. <method name="getResourceCalculatorProcessTree" return="org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree"
  2979. abstract="false" native="false" synchronized="false"
  2980. static="true" final="false" visibility="public"
  2981. deprecated="not deprecated">
  2982. <param name="pid" type="java.lang.String"/>
  2983. <param name="clazz" type="java.lang.Class"/>
  2984. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2985. <doc>
  2986. <![CDATA[Create the ResourceCalculatorProcessTree rooted to specified process
  2987. from the class name and configure it. If class name is null, this method
  2988. will try and return a process tree plugin available for this system.
  2989. @param pid process pid of the root of the process tree
  2990. @param clazz class-name
  2991. @param conf configure the plugin with this.
  2992. @return ResourceCalculatorProcessTree or null if ResourceCalculatorPluginTree
  2993. is not available for this system.]]>
  2994. </doc>
  2995. </method>
  2996. <field name="UNAVAILABLE" type="int"
  2997. transient="false" volatile="false"
  2998. static="true" final="true" visibility="public"
  2999. deprecated="not deprecated">
  3000. </field>
  3001. <doc>
  3002. <![CDATA[Interface class to obtain process resource usage
  3003. NOTE: This class should not be used by external users, but only by external
  3004. developers to extend and include their own process-tree implementation,
  3005. especially for platforms other than Linux and Windows.]]>
  3006. </doc>
  3007. </class>
  3008. <!-- end class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  3009. <!-- start class org.apache.hadoop.yarn.util.SystemClock -->
  3010. <class name="SystemClock" extends="java.lang.Object"
  3011. abstract="false"
  3012. static="false" final="true" visibility="public"
  3013. deprecated="not deprecated">
  3014. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3015. <constructor name="SystemClock"
  3016. static="false" final="false" visibility="public"
  3017. deprecated="not deprecated">
  3018. </constructor>
  3019. <method name="getInstance" return="org.apache.hadoop.yarn.util.SystemClock"
  3020. abstract="false" native="false" synchronized="false"
  3021. static="true" final="false" visibility="public"
  3022. deprecated="not deprecated">
  3023. </method>
  3024. <method name="getTime" return="long"
  3025. abstract="false" native="false" synchronized="false"
  3026. static="false" final="false" visibility="public"
  3027. deprecated="not deprecated">
  3028. </method>
  3029. <doc>
  3030. <![CDATA[Implementation of {@link Clock} that gives the current time from the system
  3031. clock in milliseconds.
  3032. NOTE: Do not use this to calculate a duration of expire or interval to sleep,
  3033. because it will be broken by settimeofday. Please use {@link MonotonicClock}
  3034. instead.]]>
  3035. </doc>
  3036. </class>
  3037. <!-- end class org.apache.hadoop.yarn.util.SystemClock -->
  3038. <!-- start class org.apache.hadoop.yarn.util.UTCClock -->
  3039. <class name="UTCClock" extends="java.lang.Object"
  3040. abstract="false"
  3041. static="false" final="false" visibility="public"
  3042. deprecated="not deprecated">
  3043. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3044. <constructor name="UTCClock"
  3045. static="false" final="false" visibility="public"
  3046. deprecated="not deprecated">
  3047. </constructor>
  3048. <method name="getTime" return="long"
  3049. abstract="false" native="false" synchronized="false"
  3050. static="false" final="false" visibility="public"
  3051. deprecated="not deprecated">
  3052. </method>
  3053. <doc>
  3054. <![CDATA[Implementation of {@link Clock} that gives the current UTC time in
  3055. milliseconds.]]>
  3056. </doc>
  3057. </class>
  3058. <!-- end class org.apache.hadoop.yarn.util.UTCClock -->
  3059. </package>
  3060. <package name="org.apache.hadoop.yarn.util.resource">
  3061. </package>
  3062. <package name="org.apache.hadoop.yarn.util.timeline">
  3063. <!-- start class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  3064. <class name="TimelineUtils" extends="java.lang.Object"
  3065. abstract="false"
  3066. static="false" final="false" visibility="public"
  3067. deprecated="not deprecated">
  3068. <constructor name="TimelineUtils"
  3069. static="false" final="false" visibility="public"
  3070. deprecated="not deprecated">
  3071. </constructor>
  3072. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  3073. abstract="false" native="false" synchronized="false"
  3074. static="true" final="false" visibility="public"
  3075. deprecated="not deprecated">
  3076. <param name="o" type="java.lang.Object"/>
  3077. <exception name="JsonGenerationException" type="com.fasterxml.jackson.core.JsonGenerationException"/>
  3078. <exception name="JsonMappingException" type="com.fasterxml.jackson.databind.JsonMappingException"/>
  3079. <exception name="IOException" type="java.io.IOException"/>
  3080. <doc>
  3081. <![CDATA[Serialize a POJO object into a JSON string not in a pretty format
  3082. @param o
  3083. an object to serialize
  3084. @return a JSON string
  3085. @throws IOException
  3086. @throws JsonMappingException
  3087. @throws JsonGenerationException]]>
  3088. </doc>
  3089. </method>
  3090. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  3091. abstract="false" native="false" synchronized="false"
  3092. static="true" final="false" visibility="public"
  3093. deprecated="not deprecated">
  3094. <param name="o" type="java.lang.Object"/>
  3095. <param name="pretty" type="boolean"/>
  3096. <exception name="JsonGenerationException" type="com.fasterxml.jackson.core.JsonGenerationException"/>
  3097. <exception name="JsonMappingException" type="com.fasterxml.jackson.databind.JsonMappingException"/>
  3098. <exception name="IOException" type="java.io.IOException"/>
  3099. <doc>
  3100. <![CDATA[Serialize a POJO object into a JSON string
  3101. @param o
  3102. an object to serialize
  3103. @param pretty
  3104. whether in a pretty format or not
  3105. @return a JSON string
  3106. @throws IOException
  3107. @throws JsonMappingException
  3108. @throws JsonGenerationException]]>
  3109. </doc>
  3110. </method>
  3111. <method name="timelineServiceEnabled" return="boolean"
  3112. abstract="false" native="false" synchronized="false"
  3113. static="true" final="false" visibility="public"
  3114. deprecated="not deprecated">
  3115. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3116. <doc>
  3117. <![CDATA[Returns whether the timeline service is enabled via configuration.
  3118. @param conf the configuration
  3119. @return whether the timeline service is enabled.]]>
  3120. </doc>
  3121. </method>
  3122. <method name="getTimelineServiceVersion" return="float"
  3123. abstract="false" native="false" synchronized="false"
  3124. static="true" final="false" visibility="public"
  3125. deprecated="not deprecated">
  3126. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3127. <doc>
  3128. <![CDATA[Returns the timeline service version. It does not check whether the
  3129. timeline service itself is enabled.
  3130. @param conf the configuration
  3131. @return the timeline service version as a float.]]>
  3132. </doc>
  3133. </method>
  3134. <method name="timelineServiceV1_5Enabled" return="boolean"
  3135. abstract="false" native="false" synchronized="false"
  3136. static="true" final="false" visibility="public"
  3137. deprecated="not deprecated">
  3138. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3139. <doc>
  3140. <![CDATA[Returns whether the timeline service v.1.5 is enabled by default via
  3141. configuration.
  3142. @param conf the configuration
  3143. @return whether the timeline service v.1.5 is enabled. V.1.5 refers to a
  3144. version equal to 1.5.]]>
  3145. </doc>
  3146. </method>
  3147. <method name="createTimelineAbout" return="org.apache.hadoop.yarn.api.records.timeline.TimelineAbout"
  3148. abstract="false" native="false" synchronized="false"
  3149. static="true" final="false" visibility="public"
  3150. deprecated="not deprecated">
  3151. <param name="about" type="java.lang.String"/>
  3152. </method>
  3153. <method name="getTimelineTokenServiceAddress" return="java.net.InetSocketAddress"
  3154. abstract="false" native="false" synchronized="false"
  3155. static="true" final="false" visibility="public"
  3156. deprecated="not deprecated">
  3157. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3158. </method>
  3159. <method name="buildTimelineTokenService" return="org.apache.hadoop.io.Text"
  3160. abstract="false" native="false" synchronized="false"
  3161. static="true" final="false" visibility="public"
  3162. deprecated="not deprecated">
  3163. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3164. </method>
  3165. <method name="generateDefaultFlowName" return="java.lang.String"
  3166. abstract="false" native="false" synchronized="false"
  3167. static="true" final="false" visibility="public"
  3168. deprecated="not deprecated">
  3169. <param name="appName" type="java.lang.String"/>
  3170. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3171. </method>
  3172. <method name="generateFlowNameTag" return="java.lang.String"
  3173. abstract="false" native="false" synchronized="false"
  3174. static="true" final="false" visibility="public"
  3175. deprecated="not deprecated">
  3176. <param name="flowName" type="java.lang.String"/>
  3177. <doc>
  3178. <![CDATA[Generate flow name tag.
  3179. @param flowName flow name that identifies a distinct flow application which
  3180. can be run repeatedly over time
  3181. @return flow name tag.]]>
  3182. </doc>
  3183. </method>
  3184. <method name="generateFlowVersionTag" return="java.lang.String"
  3185. abstract="false" native="false" synchronized="false"
  3186. static="true" final="false" visibility="public"
  3187. deprecated="not deprecated">
  3188. <param name="flowVersion" type="java.lang.String"/>
  3189. <doc>
  3190. <![CDATA[Generate flow version tag.
  3191. @param flowVersion flow version that keeps track of the changes made to the
  3192. flow
  3193. @return flow version tag.]]>
  3194. </doc>
  3195. </method>
  3196. <method name="generateFlowRunIdTag" return="java.lang.String"
  3197. abstract="false" native="false" synchronized="false"
  3198. static="true" final="false" visibility="public"
  3199. deprecated="not deprecated">
  3200. <param name="flowRunId" type="long"/>
  3201. <doc>
  3202. <![CDATA[Generate flow run ID tag.
  3203. @param flowRunId flow run ID that identifies one instance (or specific
  3204. execution) of that flow
  3205. @return flow run id tag.]]>
  3206. </doc>
  3207. </method>
  3208. <field name="FLOW_NAME_TAG_PREFIX" type="java.lang.String"
  3209. transient="false" volatile="false"
  3210. static="true" final="true" visibility="public"
  3211. deprecated="not deprecated">
  3212. </field>
  3213. <field name="FLOW_VERSION_TAG_PREFIX" type="java.lang.String"
  3214. transient="false" volatile="false"
  3215. static="true" final="true" visibility="public"
  3216. deprecated="not deprecated">
  3217. </field>
  3218. <field name="FLOW_RUN_ID_TAG_PREFIX" type="java.lang.String"
  3219. transient="false" volatile="false"
  3220. static="true" final="true" visibility="public"
  3221. deprecated="not deprecated">
  3222. </field>
  3223. <field name="DEFAULT_FLOW_VERSION" type="java.lang.String"
  3224. transient="false" volatile="false"
  3225. static="true" final="true" visibility="public"
  3226. deprecated="not deprecated">
  3227. </field>
  3228. <doc>
  3229. <![CDATA[The helper class for the timeline module.]]>
  3230. </doc>
  3231. </class>
  3232. <!-- end class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  3233. </package>
  3234. <package name="org.apache.hadoop.yarn.webapp.util">
  3235. </package>
  3236. </api>