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