Apache_Hadoop_YARN_API_2.7.2.xml 571 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692
  1. <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
  2. <!-- Generated by the JDiff Javadoc doclet -->
  3. <!-- (http://www.jdiff.org) -->
  4. <!-- on Thu May 12 17:47:18 PDT 2016 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="hadoop-yarn-api 2.7.2"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/Users/vinodkv/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/vinodkv/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/Users/vinodkv/.m2/repository/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/Users/vinodkv/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/hadoop-common-2.7.2.jar:/Users/vinodkv/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/Users/vinodkv/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/Users/vinodkv/.m2/repository/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:/Users/vinodkv/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/Users/vinodkv/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/Users/vinodkv/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/Users/vinodkv/.m2/repository/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/Users/vinodkv/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/Users/vinodkv/.m2/repository/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/Users/vinodkv/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/Users/vinodkv/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/Users/vinodkv/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/Users/vinodkv/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/Users/vinodkv/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/Users/vinodkv/.m2/repository/asm/asm/3.2/asm-3.2.jar:/Users/vinodkv/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/Users/vinodkv/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpclient/4.2.5/httpclient-4.2.5.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpcore/4.2.5/httpcore-4.2.5.jar:/Users/vinodkv/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/Users/vinodkv/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/Users/vinodkv/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/Users/vinodkv/.m2/repository/org/slf4j/slf4j-api/1.7.10/slf4j-api-1.7.10.jar:/Users/vinodkv/.m2/repository/org/slf4j/slf4j-log4j12/1.7.10/slf4j-log4j12-1.7.10.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/Users/vinodkv/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/Users/vinodkv/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/Users/vinodkv/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-auth/target/hadoop-auth-2.7.2.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar:/Users/vinodkv/.m2/repository/com/jcraft/jsch/0.1.42/jsch-0.1.42.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar:/Users/vinodkv/.m2/repository/org/apache/htrace/htrace-core/3.1.0-incubating/htrace-core-3.1.0-incubating.jar:/Users/vinodkv/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/Users/vinodkv/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/Users/vinodkv/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-2.7.2.jar:/Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk/Contents/Home/lib/tools.jar:/Users/vinodkv/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar -sourcepath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -apidir /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname hadoop-yarn-api 2.7.2 -->
  11. <package name="org.apache.hadoop.yarn.api">
  12. <!-- start interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  13. <interface name="ApplicationClientProtocol" abstract="true"
  14. static="false" final="false" visibility="public"
  15. deprecated="not deprecated">
  16. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  17. <method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
  18. abstract="false" native="false" synchronized="false"
  19. static="false" final="false" visibility="public"
  20. deprecated="not deprecated">
  21. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"/>
  22. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  23. <exception name="IOException" type="java.io.IOException"/>
  24. <doc>
  25. <![CDATA[<p>The interface used by clients to obtain a new {@link ApplicationId} for
  26. submitting new applications.</p>
  27. <p>The <code>ResourceManager</code> responds with a new, monotonically
  28. increasing, {@link ApplicationId} which is used by the client to submit
  29. a new application.</p>
  30. <p>The <code>ResourceManager</code> also responds with details such
  31. as maximum resource capabilities in the cluster as specified in
  32. {@link GetNewApplicationResponse}.</p>
  33. @param request request to get a new <code>ApplicationId</code>
  34. @return response containing the new <code>ApplicationId</code> to be used
  35. to submit an application
  36. @throws YarnException
  37. @throws IOException
  38. @see #submitApplication(SubmitApplicationRequest)]]>
  39. </doc>
  40. </method>
  41. <method name="submitApplication" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse"
  42. abstract="false" native="false" synchronized="false"
  43. static="false" final="false" visibility="public"
  44. deprecated="not deprecated">
  45. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"/>
  46. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  47. <exception name="IOException" type="java.io.IOException"/>
  48. <doc>
  49. <![CDATA[<p>The interface used by clients to submit a new application to the
  50. <code>ResourceManager.</code></p>
  51. <p>The client is required to provide details such as queue,
  52. {@link Resource} required to run the <code>ApplicationMaster</code>,
  53. the equivalent of {@link ContainerLaunchContext} for launching
  54. the <code>ApplicationMaster</code> etc. via the
  55. {@link SubmitApplicationRequest}.</p>
  56. <p>Currently the <code>ResourceManager</code> sends an immediate (empty)
  57. {@link SubmitApplicationResponse} on accepting the submission and throws
  58. an exception if it rejects the submission. However, this call needs to be
  59. followed by {@link #getApplicationReport(GetApplicationReportRequest)}
  60. to make sure that the application gets properly submitted - obtaining a
  61. {@link SubmitApplicationResponse} from ResourceManager doesn't guarantee
  62. that RM 'remembers' this application beyond failover or restart. If RM
  63. failover or RM restart happens before ResourceManager saves the
  64. application's state successfully, the subsequent
  65. {@link #getApplicationReport(GetApplicationReportRequest)} will throw
  66. a {@link ApplicationNotFoundException}. The Clients need to re-submit
  67. the application with the same {@link ApplicationSubmissionContext} when
  68. it encounters the {@link ApplicationNotFoundException} on the
  69. {@link #getApplicationReport(GetApplicationReportRequest)} call.</p>
  70. <p>During the submission process, it checks whether the application
  71. already exists. If the application exists, it will simply return
  72. SubmitApplicationResponse</p>
  73. <p> In secure mode,the <code>ResourceManager</code> verifies access to
  74. queues etc. before accepting the application submission.</p>
  75. @param request request to submit a new application
  76. @return (empty) response on accepting the submission
  77. @throws YarnException
  78. @throws IOException
  79. @see #getNewApplication(GetNewApplicationRequest)]]>
  80. </doc>
  81. </method>
  82. <method name="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
  83. abstract="false" native="false" synchronized="false"
  84. static="false" final="false" visibility="public"
  85. deprecated="not deprecated">
  86. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"/>
  87. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  88. <exception name="IOException" type="java.io.IOException"/>
  89. <doc>
  90. <![CDATA[<p>The interface used by clients to request the
  91. <code>ResourceManager</code> to abort submitted application.</p>
  92. <p>The client, via {@link KillApplicationRequest} provides the
  93. {@link ApplicationId} of the application to be aborted.</p>
  94. <p> In secure mode,the <code>ResourceManager</code> verifies access to the
  95. application, queue etc. before terminating the application.</p>
  96. <p>Currently, the <code>ResourceManager</code> returns an empty response
  97. on success and throws an exception on rejecting the request.</p>
  98. @param request request to abort a submitted application
  99. @return <code>ResourceManager</code> returns an empty response
  100. on success and throws an exception on rejecting the request
  101. @throws YarnException
  102. @throws IOException
  103. @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  104. </doc>
  105. </method>
  106. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
  107. abstract="false" native="false" synchronized="false"
  108. static="false" final="false" visibility="public"
  109. deprecated="not deprecated">
  110. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"/>
  111. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  112. <exception name="IOException" type="java.io.IOException"/>
  113. <doc>
  114. <![CDATA[<p>The interface used by clients to get metrics about the cluster from
  115. the <code>ResourceManager</code>.</p>
  116. <p>The <code>ResourceManager</code> responds with a
  117. {@link GetClusterMetricsResponse} which includes the
  118. {@link YarnClusterMetrics} with details such as number of current
  119. nodes in the cluster.</p>
  120. @param request request for cluster metrics
  121. @return cluster metrics
  122. @throws YarnException
  123. @throws IOException]]>
  124. </doc>
  125. </method>
  126. <method name="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
  127. abstract="false" native="false" synchronized="false"
  128. static="false" final="false" visibility="public"
  129. deprecated="not deprecated">
  130. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"/>
  131. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  132. <exception name="IOException" type="java.io.IOException"/>
  133. <doc>
  134. <![CDATA[<p>The interface used by clients to get a report of all nodes
  135. in the cluster from the <code>ResourceManager</code>.</p>
  136. <p>The <code>ResourceManager</code> responds with a
  137. {@link GetClusterNodesResponse} which includes the
  138. {@link NodeReport} for all the nodes in the cluster.</p>
  139. @param request request for report on all nodes
  140. @return report on all nodes
  141. @throws YarnException
  142. @throws IOException]]>
  143. </doc>
  144. </method>
  145. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse"
  146. abstract="false" native="false" synchronized="false"
  147. static="false" final="false" visibility="public"
  148. deprecated="not deprecated">
  149. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"/>
  150. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  151. <exception name="IOException" type="java.io.IOException"/>
  152. <doc>
  153. <![CDATA[<p>The interface used by clients to get information about <em>queues</em>
  154. from the <code>ResourceManager</code>.</p>
  155. <p>The client, via {@link GetQueueInfoRequest}, can ask for details such
  156. as used/total resources, child queues, running applications etc.</p>
  157. <p> In secure mode,the <code>ResourceManager</code> verifies access before
  158. providing the information.</p>
  159. @param request request to get queue information
  160. @return queue information
  161. @throws YarnException
  162. @throws IOException]]>
  163. </doc>
  164. </method>
  165. <method name="getQueueUserAcls" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse"
  166. abstract="false" native="false" synchronized="false"
  167. static="false" final="false" visibility="public"
  168. deprecated="not deprecated">
  169. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"/>
  170. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  171. <exception name="IOException" type="java.io.IOException"/>
  172. <doc>
  173. <![CDATA[<p>The interface used by clients to get information about <em>queue
  174. acls</em> for <em>current user</em> from the <code>ResourceManager</code>.
  175. </p>
  176. <p>The <code>ResourceManager</code> responds with queue acls for all
  177. existing queues.</p>
  178. @param request request to get queue acls for <em>current user</em>
  179. @return queue acls for <em>current user</em>
  180. @throws YarnException
  181. @throws IOException]]>
  182. </doc>
  183. </method>
  184. <method name="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
  185. abstract="false" native="false" synchronized="false"
  186. static="false" final="false" visibility="public"
  187. deprecated="not deprecated">
  188. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"/>
  189. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  190. <exception name="IOException" type="java.io.IOException"/>
  191. <doc>
  192. <![CDATA[Move an application to a new queue.
  193. @param request the application ID and the target queue
  194. @return an empty response
  195. @throws YarnException
  196. @throws IOException]]>
  197. </doc>
  198. </method>
  199. <method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
  200. abstract="false" native="false" synchronized="false"
  201. static="false" final="false" visibility="public"
  202. deprecated="not deprecated">
  203. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"/>
  204. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  205. <exception name="IOException" type="java.io.IOException"/>
  206. <doc>
  207. <![CDATA[<p>
  208. The interface used by clients to submit a new reservation to the
  209. {@code ResourceManager}.
  210. </p>
  211. <p>
  212. The client packages all details of its request in a
  213. {@link ReservationSubmissionRequest} object. This contains information
  214. about the amount of capacity, temporal constraints, and concurrency needs.
  215. Furthermore, the reservation might be composed of multiple stages, with
  216. ordering dependencies among them.
  217. </p>
  218. <p>
  219. In order to respond, a new admission control component in the
  220. {@code ResourceManager} performs an analysis of the resources that have
  221. been committed over the period of time the user is requesting, verify that
  222. the user requests can be fulfilled, and that it respect a sharing policy
  223. (e.g., {@code CapacityOverTimePolicy}). Once it has positively determined
  224. that the ReservationSubmissionRequest is satisfiable the
  225. {@code ResourceManager} answers with a
  226. {@link ReservationSubmissionResponse} that include a non-null
  227. {@link ReservationId}. Upon failure to find a valid allocation the response
  228. is an exception with the reason.
  229. On application submission the client can use this {@link ReservationId} to
  230. obtain access to the reserved resources.
  231. </p>
  232. <p>
  233. The system guarantees that during the time-range specified by the user, the
  234. reservationID will be corresponding to a valid reservation. The amount of
  235. capacity dedicated to such queue can vary overtime, depending of the
  236. allocation that has been determined. But it is guaranteed to satisfy all
  237. the constraint expressed by the user in the
  238. {@link ReservationSubmissionRequest}.
  239. </p>
  240. @param request the request to submit a new Reservation
  241. @return response the {@link ReservationId} on accepting the submission
  242. @throws YarnException if the request is invalid or reservation cannot be
  243. created successfully
  244. @throws IOException]]>
  245. </doc>
  246. </method>
  247. <method name="updateReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse"
  248. abstract="false" native="false" synchronized="false"
  249. static="false" final="false" visibility="public"
  250. deprecated="not deprecated">
  251. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"/>
  252. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  253. <exception name="IOException" type="java.io.IOException"/>
  254. <doc>
  255. <![CDATA[<p>
  256. The interface used by clients to update an existing Reservation. This is
  257. referred to as a re-negotiation process, in which a user that has
  258. previously submitted a Reservation.
  259. </p>
  260. <p>
  261. The allocation is attempted by virtually substituting all previous
  262. allocations related to this Reservation with new ones, that satisfy the new
  263. {@link ReservationUpdateRequest}. Upon success the previous allocation is
  264. substituted by the new one, and on failure (i.e., if the system cannot find
  265. a valid allocation for the updated request), the previous allocation
  266. remains valid.
  267. The {@link ReservationId} is not changed, and applications currently
  268. running within this reservation will automatically receive the resources
  269. based on the new allocation.
  270. </p>
  271. @param request to update an existing Reservation (the ReservationRequest
  272. should refer to an existing valid {@link ReservationId})
  273. @return response empty on successfully updating the existing reservation
  274. @throws YarnException if the request is invalid or reservation cannot be
  275. updated successfully
  276. @throws IOException]]>
  277. </doc>
  278. </method>
  279. <method name="deleteReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse"
  280. abstract="false" native="false" synchronized="false"
  281. static="false" final="false" visibility="public"
  282. deprecated="not deprecated">
  283. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"/>
  284. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  285. <exception name="IOException" type="java.io.IOException"/>
  286. <doc>
  287. <![CDATA[<p>
  288. The interface used by clients to remove an existing Reservation.
  289. Upon deletion of a reservation applications running with this reservation,
  290. are automatically downgraded to normal jobs running without any dedicated
  291. reservation.
  292. </p>
  293. @param request to remove an existing Reservation (the ReservationRequest
  294. should refer to an existing valid {@link ReservationId})
  295. @return response empty on successfully deleting the existing reservation
  296. @throws YarnException if the request is invalid or reservation cannot be
  297. deleted successfully
  298. @throws IOException]]>
  299. </doc>
  300. </method>
  301. <method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
  302. abstract="false" native="false" synchronized="false"
  303. static="false" final="false" visibility="public"
  304. deprecated="not deprecated">
  305. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"/>
  306. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  307. <exception name="IOException" type="java.io.IOException"/>
  308. <doc>
  309. <![CDATA[<p>
  310. The interface used by client to get node to labels mappings in existing cluster
  311. </p>
  312. @param request
  313. @return node to labels mappings
  314. @throws YarnException
  315. @throws IOException]]>
  316. </doc>
  317. </method>
  318. <method name="getLabelsToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse"
  319. abstract="false" native="false" synchronized="false"
  320. static="false" final="false" visibility="public"
  321. deprecated="not deprecated">
  322. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"/>
  323. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  324. <exception name="IOException" type="java.io.IOException"/>
  325. <doc>
  326. <![CDATA[<p>
  327. The interface used by client to get labels to nodes mappings
  328. in existing cluster
  329. </p>
  330. @param request
  331. @return labels to nodes mappings
  332. @throws YarnException
  333. @throws IOException]]>
  334. </doc>
  335. </method>
  336. <method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  337. abstract="false" native="false" synchronized="false"
  338. static="false" final="false" visibility="public"
  339. deprecated="not deprecated">
  340. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"/>
  341. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  342. <exception name="IOException" type="java.io.IOException"/>
  343. <doc>
  344. <![CDATA[<p>
  345. The interface used by client to get node labels in the cluster
  346. </p>
  347. @param request to get node labels collection of this cluster
  348. @return node labels collection of this cluster
  349. @throws YarnException
  350. @throws IOException]]>
  351. </doc>
  352. </method>
  353. <doc>
  354. <![CDATA[<p>The protocol between clients and the <code>ResourceManager</code>
  355. to submit/abort jobs and to get information on applications, cluster metrics,
  356. nodes, queues and ACLs.</p>]]>
  357. </doc>
  358. </interface>
  359. <!-- end interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
  360. <!-- start interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  361. <interface name="ApplicationConstants" abstract="true"
  362. static="false" final="false" visibility="public"
  363. deprecated="not deprecated">
  364. <field name="APP_SUBMIT_TIME_ENV" type="java.lang.String"
  365. transient="false" volatile="false"
  366. static="true" final="true" visibility="public"
  367. deprecated="not deprecated">
  368. <doc>
  369. <![CDATA[The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment
  370. only]]>
  371. </doc>
  372. </field>
  373. <field name="CONTAINER_TOKEN_FILE_ENV_NAME" type="java.lang.String"
  374. transient="false" volatile="false"
  375. static="true" final="true" visibility="public"
  376. deprecated="not deprecated">
  377. <doc>
  378. <![CDATA[The cache file into which container token is written]]>
  379. </doc>
  380. </field>
  381. <field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
  382. transient="false" volatile="false"
  383. static="true" final="true" visibility="public"
  384. deprecated="not deprecated">
  385. <doc>
  386. <![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
  387. ApplicationMaster's environment only. This states that for all non-relative
  388. web URLs in the app masters web UI what base should they have.]]>
  389. </doc>
  390. </field>
  391. <field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
  392. transient="false" volatile="false"
  393. static="true" final="true" visibility="public"
  394. deprecated="not deprecated">
  395. <doc>
  396. <![CDATA[The temporary environmental variable for container log directory. This
  397. should be replaced by real container log directory on container launch.]]>
  398. </doc>
  399. </field>
  400. <field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
  401. transient="false" volatile="false"
  402. static="true" final="true" visibility="public"
  403. deprecated="not deprecated">
  404. <doc>
  405. <![CDATA[This constant is used to construct class path and it will be replaced with
  406. real class path separator(':' for Linux and ';' for Windows) by
  407. NodeManager on container launch. User has to use this constant to construct
  408. class path if user wants cross-platform practice i.e. submit an application
  409. from a Windows client to a Linux/Unix server or vice versa.]]>
  410. </doc>
  411. </field>
  412. <field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
  413. transient="false" volatile="false"
  414. static="true" final="true" visibility="public"
  415. deprecated="not deprecated">
  416. <doc>
  417. <![CDATA[The following two constants are used to expand parameter and it will be
  418. replaced with real parameter expansion marker ('%' for Windows and '$' for
  419. Linux) by NodeManager on container launch. For example: {{VAR}} will be
  420. replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
  421. constant to construct class path if user wants cross-platform practice i.e.
  422. submit an application from a Windows client to a Linux/Unix server or vice
  423. versa.]]>
  424. </doc>
  425. </field>
  426. <field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
  427. transient="false" volatile="false"
  428. static="true" final="true" visibility="public"
  429. deprecated="not deprecated">
  430. <doc>
  431. <![CDATA[User has to use this constant to construct class path if user wants
  432. cross-platform practice i.e. submit an application from a Windows client to
  433. a Linux/Unix server or vice versa.]]>
  434. </doc>
  435. </field>
  436. <field name="STDERR" type="java.lang.String"
  437. transient="false" volatile="false"
  438. static="true" final="true" visibility="public"
  439. deprecated="not deprecated">
  440. </field>
  441. <field name="STDOUT" type="java.lang.String"
  442. transient="false" volatile="false"
  443. static="true" final="true" visibility="public"
  444. deprecated="not deprecated">
  445. </field>
  446. <field name="MAX_APP_ATTEMPTS_ENV" type="java.lang.String"
  447. transient="false" volatile="false"
  448. static="true" final="true" visibility="public"
  449. deprecated="not deprecated">
  450. <doc>
  451. <![CDATA[The environment variable for MAX_APP_ATTEMPTS. Set in AppMaster environment
  452. only]]>
  453. </doc>
  454. </field>
  455. <doc>
  456. <![CDATA[This is the API for the applications comprising of constants that YARN sets
  457. up for the applications and the containers.
  458. TODO: Investigate the semantics and security of each cross-boundary refs.]]>
  459. </doc>
  460. </interface>
  461. <!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
  462. <!-- start class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
  463. <class name="ApplicationConstants.Environment" extends="java.lang.Enum"
  464. abstract="false"
  465. static="true" final="true" visibility="public"
  466. deprecated="not deprecated">
  467. <method name="values" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment[]"
  468. abstract="false" native="false" synchronized="false"
  469. static="true" final="false" visibility="public"
  470. deprecated="not deprecated">
  471. </method>
  472. <method name="valueOf" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment"
  473. abstract="false" native="false" synchronized="false"
  474. static="true" final="false" visibility="public"
  475. deprecated="not deprecated">
  476. <param name="name" type="java.lang.String"/>
  477. </method>
  478. <method name="key" return="java.lang.String"
  479. abstract="false" native="false" synchronized="false"
  480. static="false" final="false" visibility="public"
  481. deprecated="not deprecated">
  482. </method>
  483. <method name="toString" return="java.lang.String"
  484. abstract="false" native="false" synchronized="false"
  485. static="false" final="false" visibility="public"
  486. deprecated="not deprecated">
  487. </method>
  488. <method name="$" return="java.lang.String"
  489. abstract="false" native="false" synchronized="false"
  490. static="false" final="false" visibility="public"
  491. deprecated="not deprecated">
  492. <doc>
  493. <![CDATA[Expand the environment variable based on client OS environment variable
  494. expansion syntax (e.g. $VAR for Linux and %VAR% for Windows).
  495. <p>
  496. Note: Use $$() method for cross-platform practice i.e. submit an
  497. application from a Windows client to a Linux/Unix server or vice versa.
  498. </p>]]>
  499. </doc>
  500. </method>
  501. <method name="$$" return="java.lang.String"
  502. abstract="false" native="false" synchronized="false"
  503. static="false" final="false" visibility="public"
  504. deprecated="not deprecated">
  505. <doc>
  506. <![CDATA[Expand the environment variable in platform-agnostic syntax. The
  507. parameter expansion marker "{{VAR}}" will be replaced with real parameter
  508. expansion marker ('%' for Windows and '$' for Linux) by NodeManager on
  509. container launch. For example: {{VAR}} will be replaced as $VAR on Linux,
  510. and %VAR% on Windows.]]>
  511. </doc>
  512. </method>
  513. <doc>
  514. <![CDATA[Environment for Applications.
  515. Some of the environment variables for applications are <em>final</em>
  516. i.e. they cannot be modified by the applications.]]>
  517. </doc>
  518. </class>
  519. <!-- end class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
  520. <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  521. <interface name="ApplicationHistoryProtocol" abstract="true"
  522. static="false" final="false" visibility="public"
  523. deprecated="not deprecated">
  524. <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
  525. <doc>
  526. <![CDATA[<p>
  527. The protocol between clients and the <code>ApplicationHistoryServer</code> to
  528. get the information of completed applications etc.
  529. </p>]]>
  530. </doc>
  531. </interface>
  532. <!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
  533. <!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  534. <interface name="ApplicationMasterProtocol" abstract="true"
  535. static="false" final="false" visibility="public"
  536. deprecated="not deprecated">
  537. <method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
  538. abstract="false" native="false" synchronized="false"
  539. static="false" final="false" visibility="public"
  540. deprecated="not deprecated">
  541. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
  542. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  543. <exception name="IOException" type="java.io.IOException"/>
  544. <doc>
  545. <![CDATA[<p>
  546. The interface used by a new <code>ApplicationMaster</code> to register with
  547. the <code>ResourceManager</code>.
  548. </p>
  549. <p>
  550. The <code>ApplicationMaster</code> needs to provide details such as RPC
  551. Port, HTTP tracking url etc. as specified in
  552. {@link RegisterApplicationMasterRequest}.
  553. </p>
  554. <p>
  555. The <code>ResourceManager</code> responds with critical details such as
  556. maximum resource capabilities in the cluster as specified in
  557. {@link RegisterApplicationMasterResponse}.
  558. </p>
  559. @param request
  560. registration request
  561. @return registration respose
  562. @throws YarnException
  563. @throws IOException
  564. @throws InvalidApplicationMasterRequestException
  565. The exception is thrown when an ApplicationMaster tries to
  566. register more then once.
  567. @see RegisterApplicationMasterRequest
  568. @see RegisterApplicationMasterResponse]]>
  569. </doc>
  570. </method>
  571. <method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
  572. abstract="false" native="false" synchronized="false"
  573. static="false" final="false" visibility="public"
  574. deprecated="not deprecated">
  575. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
  576. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  577. <exception name="IOException" type="java.io.IOException"/>
  578. <doc>
  579. <![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
  580. <code>ResourceManager</code> about its completion (success or failed).</p>
  581. <p>The <code>ApplicationMaster</code> has to provide details such as
  582. final state, diagnostics (in case of failures) etc. as specified in
  583. {@link FinishApplicationMasterRequest}.</p>
  584. <p>The <code>ResourceManager</code> responds with
  585. {@link FinishApplicationMasterResponse}.</p>
  586. @param request completion request
  587. @return completion response
  588. @throws YarnException
  589. @throws IOException
  590. @see FinishApplicationMasterRequest
  591. @see FinishApplicationMasterResponse]]>
  592. </doc>
  593. </method>
  594. <method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  595. abstract="false" native="false" synchronized="false"
  596. static="false" final="false" visibility="public"
  597. deprecated="not deprecated">
  598. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
  599. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  600. <exception name="IOException" type="java.io.IOException"/>
  601. <doc>
  602. <![CDATA[<p>
  603. The main interface between an <code>ApplicationMaster</code> and the
  604. <code>ResourceManager</code>.
  605. </p>
  606. <p>
  607. The <code>ApplicationMaster</code> uses this interface to provide a list of
  608. {@link ResourceRequest} and returns unused {@link Container} allocated to
  609. it via {@link AllocateRequest}. Optionally, the
  610. <code>ApplicationMaster</code> can also <em>blacklist</em> resources which
  611. it doesn't want to use.
  612. </p>
  613. <p>
  614. This also doubles up as a <em>heartbeat</em> to let the
  615. <code>ResourceManager</code> know that the <code>ApplicationMaster</code>
  616. is alive. Thus, applications should periodically make this call to be kept
  617. alive. The frequency depends on
  618. {@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
  619. {@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
  620. </p>
  621. <p>
  622. The <code>ResourceManager</code> responds with list of allocated
  623. {@link Container}, status of completed containers and headroom information
  624. for the application.
  625. </p>
  626. <p>
  627. The <code>ApplicationMaster</code> can use the available headroom
  628. (resources) to decide how to utilized allocated resources and make informed
  629. decisions about future resource requests.
  630. </p>
  631. @param request
  632. allocation request
  633. @return allocation response
  634. @throws YarnException
  635. @throws IOException
  636. @throws InvalidApplicationMasterRequestException
  637. This exception is thrown when an ApplicationMaster calls allocate
  638. without registering first.
  639. @throws InvalidResourceBlacklistRequestException
  640. This exception is thrown when an application provides an invalid
  641. specification for blacklist of resources.
  642. @throws InvalidResourceRequestException
  643. This exception is thrown when a {@link ResourceRequest} is out of
  644. the range of the configured lower and upper limits on the
  645. resources.
  646. @see AllocateRequest
  647. @see AllocateResponse]]>
  648. </doc>
  649. </method>
  650. <doc>
  651. <![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
  652. and the <code>ResourceManager</code>.</p>
  653. <p>This is used by the <code>ApplicationMaster</code> to register/unregister
  654. and to request and obtain resources in the cluster from the
  655. <code>ResourceManager</code>.</p>]]>
  656. </doc>
  657. </interface>
  658. <!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
  659. <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  660. <interface name="ClientSCMProtocol" abstract="true"
  661. static="false" final="false" visibility="public"
  662. deprecated="not deprecated">
  663. <method name="use" return="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse"
  664. abstract="false" native="false" synchronized="false"
  665. static="false" final="false" visibility="public"
  666. deprecated="not deprecated">
  667. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest"/>
  668. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  669. <exception name="IOException" type="java.io.IOException"/>
  670. <doc>
  671. <![CDATA[<p>
  672. The interface used by clients to claim a resource with the
  673. <code>SharedCacheManager.</code> The client uses a checksum to identify the
  674. resource and an {@link ApplicationId} to identify which application will be
  675. using the resource.
  676. </p>
  677. <p>
  678. The <code>SharedCacheManager</code> responds with whether or not the
  679. resource exists in the cache. If the resource exists, a <code>Path</code>
  680. to the resource in the shared cache is returned. If the resource does not
  681. exist, the response is empty.
  682. </p>
  683. @param request request to claim a resource in the shared cache
  684. @return response indicating if the resource is already in the cache
  685. @throws YarnException
  686. @throws IOException]]>
  687. </doc>
  688. </method>
  689. <method name="release" return="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse"
  690. abstract="false" native="false" synchronized="false"
  691. static="false" final="false" visibility="public"
  692. deprecated="not deprecated">
  693. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest"/>
  694. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  695. <exception name="IOException" type="java.io.IOException"/>
  696. <doc>
  697. <![CDATA[<p>
  698. The interface used by clients to release a resource with the
  699. <code>SharedCacheManager.</code> This method is called once an application
  700. is no longer using a claimed resource in the shared cache. The client uses
  701. a checksum to identify the resource and an {@link ApplicationId} to
  702. identify which application is releasing the resource.
  703. </p>
  704. <p>
  705. Note: This method is an optimization and the client is not required to call
  706. it for correctness.
  707. </p>
  708. <p>
  709. Currently the <code>SharedCacheManager</code> sends an empty response.
  710. </p>
  711. @param request request to release a resource in the shared cache
  712. @return (empty) response on releasing the resource
  713. @throws YarnException
  714. @throws IOException]]>
  715. </doc>
  716. </method>
  717. <doc>
  718. <![CDATA[<p>
  719. The protocol between clients and the <code>SharedCacheManager</code> to claim
  720. and release resources in the shared cache.
  721. </p>]]>
  722. </doc>
  723. </interface>
  724. <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
  725. <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocolPB -->
  726. <interface name="ClientSCMProtocolPB" abstract="true"
  727. static="false" final="false" visibility="public"
  728. deprecated="not deprecated">
  729. <implements name="org.apache.hadoop.yarn.proto.ClientSCMProtocol.ClientSCMProtocolService.BlockingInterface"/>
  730. </interface>
  731. <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocolPB -->
  732. <!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  733. <interface name="ContainerManagementProtocol" abstract="true"
  734. static="false" final="false" visibility="public"
  735. deprecated="not deprecated">
  736. <method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
  737. abstract="false" native="false" synchronized="false"
  738. static="false" final="false" visibility="public"
  739. deprecated="not deprecated">
  740. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
  741. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  742. <exception name="IOException" type="java.io.IOException"/>
  743. <doc>
  744. <![CDATA[<p>
  745. The <code>ApplicationMaster</code> provides a list of
  746. {@link StartContainerRequest}s to a <code>NodeManager</code> to
  747. <em>start</em> {@link Container}s allocated to it using this interface.
  748. </p>
  749. <p>
  750. The <code>ApplicationMaster</code> has to provide details such as allocated
  751. resource capability, security tokens (if enabled), command to be executed
  752. to start the container, environment for the process, necessary
  753. binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
  754. the {@link StartContainerRequest}.
  755. </p>
  756. <p>
  757. The <code>NodeManager</code> sends a response via
  758. {@link StartContainersResponse} which includes a list of
  759. {@link Container}s of successfully launched {@link Container}s, a
  760. containerId-to-exception map for each failed {@link StartContainerRequest} in
  761. which the exception indicates errors from per container and a
  762. allServicesMetaData map between the names of auxiliary services and their
  763. corresponding meta-data. Note: None-container-specific exceptions will
  764. still be thrown by the API method itself.
  765. </p>
  766. <p>
  767. The <code>ApplicationMaster</code> can use
  768. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  769. statuses of the to-be-launched or launched containers.
  770. </p>
  771. @param request
  772. request to start a list of containers
  773. @return response including conatinerIds of all successfully launched
  774. containers, a containerId-to-exception map for failed requests and
  775. a allServicesMetaData map.
  776. @throws YarnException
  777. @throws IOException
  778. @throws NMNotYetReadyException
  779. This exception is thrown when NM starts from scratch but has not
  780. yet connected with RM.]]>
  781. </doc>
  782. </method>
  783. <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
  784. abstract="false" native="false" synchronized="false"
  785. static="false" final="false" visibility="public"
  786. deprecated="not deprecated">
  787. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
  788. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  789. <exception name="IOException" type="java.io.IOException"/>
  790. <doc>
  791. <![CDATA[<p>
  792. The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
  793. <em>stop</em> a list of {@link Container}s allocated to it using this
  794. interface.
  795. </p>
  796. <p>
  797. The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
  798. which includes the {@link ContainerId}s of the containers to be stopped.
  799. </p>
  800. <p>
  801. The <code>NodeManager</code> sends a response via
  802. {@link StopContainersResponse} which includes a list of {@link ContainerId}
  803. s of successfully stopped containers, a containerId-to-exception map for
  804. each failed request in which the exception indicates errors from per
  805. container. Note: None-container-specific exceptions will still be thrown by
  806. the API method itself. <code>ApplicationMaster</code> can use
  807. {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
  808. statuses of the containers.
  809. </p>
  810. @param request
  811. request to stop a list of containers
  812. @return response which includes a list of containerIds of successfully
  813. stopped containers, a containerId-to-exception map for failed
  814. requests.
  815. @throws YarnException
  816. @throws IOException]]>
  817. </doc>
  818. </method>
  819. <method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
  820. abstract="false" native="false" synchronized="false"
  821. static="false" final="false" visibility="public"
  822. deprecated="not deprecated">
  823. <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
  824. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  825. <exception name="IOException" type="java.io.IOException"/>
  826. <doc>
  827. <![CDATA[<p>
  828. The API used by the <code>ApplicationMaster</code> to request for current
  829. statuses of <code>Container</code>s from the <code>NodeManager</code>.
  830. </p>
  831. <p>
  832. The <code>ApplicationMaster</code> sends a
  833. {@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
  834. of all containers whose statuses are needed.
  835. </p>
  836. <p>
  837. The <code>NodeManager</code> responds with
  838. {@link GetContainerStatusesResponse} which includes a list of
  839. {@link ContainerStatus} of the successfully queried containers and a
  840. containerId-to-exception map for each failed request in which the exception
  841. indicates errors from per container. Note: None-container-specific
  842. exceptions will still be thrown by the API method itself.
  843. </p>
  844. @param request
  845. request to get <code>ContainerStatus</code>es of containers with
  846. the specified <code>ContainerId</code>s
  847. @return response containing the list of <code>ContainerStatus</code> of the
  848. successfully queried containers and a containerId-to-exception map
  849. for failed requests.
  850. @throws YarnException
  851. @throws IOException]]>
  852. </doc>
  853. </method>
  854. <doc>
  855. <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
  856. <code>NodeManager</code> to start/stop containers and to get status
  857. of running containers.</p>
  858. <p>If security is enabled the <code>NodeManager</code> verifies that the
  859. <code>ApplicationMaster</code> has truly been allocated the container
  860. by the <code>ResourceManager</code> and also verifies all interactions such
  861. as stopping the container or obtaining status information for the container.
  862. </p>]]>
  863. </doc>
  864. </interface>
  865. <!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
  866. </package>
  867. <package name="org.apache.hadoop.yarn.api.protocolrecords">
  868. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  869. <class name="AllocateRequest" extends="java.lang.Object"
  870. abstract="true"
  871. static="false" final="false" visibility="public"
  872. deprecated="not deprecated">
  873. <constructor name="AllocateRequest"
  874. static="false" final="false" visibility="public"
  875. deprecated="not deprecated">
  876. </constructor>
  877. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  878. abstract="false" native="false" synchronized="false"
  879. static="true" final="false" visibility="public"
  880. deprecated="not deprecated">
  881. <param name="responseID" type="int"/>
  882. <param name="appProgress" type="float"/>
  883. <param name="resourceAsk" type="java.util.List"/>
  884. <param name="containersToBeReleased" type="java.util.List"/>
  885. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  886. </method>
  887. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
  888. abstract="false" native="false" synchronized="false"
  889. static="true" final="false" visibility="public"
  890. deprecated="not deprecated">
  891. <param name="responseID" type="int"/>
  892. <param name="appProgress" type="float"/>
  893. <param name="resourceAsk" type="java.util.List"/>
  894. <param name="containersToBeReleased" type="java.util.List"/>
  895. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  896. <param name="increaseRequests" type="java.util.List"/>
  897. </method>
  898. <method name="getResponseId" return="int"
  899. abstract="true" native="false" synchronized="false"
  900. static="false" final="false" visibility="public"
  901. deprecated="not deprecated">
  902. <doc>
  903. <![CDATA[Get the <em>response id</em> used to track duplicate responses.
  904. @return <em>response id</em>]]>
  905. </doc>
  906. </method>
  907. <method name="setResponseId"
  908. abstract="true" native="false" synchronized="false"
  909. static="false" final="false" visibility="public"
  910. deprecated="not deprecated">
  911. <param name="id" type="int"/>
  912. <doc>
  913. <![CDATA[Set the <em>response id</em> used to track duplicate responses.
  914. @param id <em>response id</em>]]>
  915. </doc>
  916. </method>
  917. <method name="getProgress" return="float"
  918. abstract="true" native="false" synchronized="false"
  919. static="false" final="false" visibility="public"
  920. deprecated="not deprecated">
  921. <doc>
  922. <![CDATA[Get the <em>current progress</em> of application.
  923. @return <em>current progress</em> of application]]>
  924. </doc>
  925. </method>
  926. <method name="setProgress"
  927. abstract="true" native="false" synchronized="false"
  928. static="false" final="false" visibility="public"
  929. deprecated="not deprecated">
  930. <param name="progress" type="float"/>
  931. <doc>
  932. <![CDATA[Set the <em>current progress</em> of application
  933. @param progress <em>current progress</em> of application]]>
  934. </doc>
  935. </method>
  936. <method name="getAskList" return="java.util.List"
  937. abstract="true" native="false" synchronized="false"
  938. static="false" final="false" visibility="public"
  939. deprecated="not deprecated">
  940. <doc>
  941. <![CDATA[Get the list of <code>ResourceRequest</code> to update the
  942. <code>ResourceManager</code> about the application's resource requirements.
  943. @return the list of <code>ResourceRequest</code>
  944. @see ResourceRequest]]>
  945. </doc>
  946. </method>
  947. <method name="setAskList"
  948. abstract="true" native="false" synchronized="false"
  949. static="false" final="false" visibility="public"
  950. deprecated="not deprecated">
  951. <param name="resourceRequests" type="java.util.List"/>
  952. <doc>
  953. <![CDATA[Set list of <code>ResourceRequest</code> to update the
  954. <code>ResourceManager</code> about the application's resource requirements.
  955. @param resourceRequests list of <code>ResourceRequest</code> to update the
  956. <code>ResourceManager</code> about the application's
  957. resource requirements
  958. @see ResourceRequest]]>
  959. </doc>
  960. </method>
  961. <method name="getReleaseList" return="java.util.List"
  962. abstract="true" native="false" synchronized="false"
  963. static="false" final="false" visibility="public"
  964. deprecated="not deprecated">
  965. <doc>
  966. <![CDATA[Get the list of <code>ContainerId</code> of containers being
  967. released by the <code>ApplicationMaster</code>.
  968. @return list of <code>ContainerId</code> of containers being
  969. released by the <code>ApplicationMaster</code>]]>
  970. </doc>
  971. </method>
  972. <method name="setReleaseList"
  973. abstract="true" native="false" synchronized="false"
  974. static="false" final="false" visibility="public"
  975. deprecated="not deprecated">
  976. <param name="releaseContainers" type="java.util.List"/>
  977. <doc>
  978. <![CDATA[Set the list of <code>ContainerId</code> of containers being
  979. released by the <code>ApplicationMaster</code>
  980. @param releaseContainers list of <code>ContainerId</code> of
  981. containers being released by the
  982. <code>ApplicationMaster</code>]]>
  983. </doc>
  984. </method>
  985. <method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  986. abstract="true" native="false" synchronized="false"
  987. static="false" final="false" visibility="public"
  988. deprecated="not deprecated">
  989. <doc>
  990. <![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
  991. <code>ApplicationMaster</code>.
  992. @return the <code>ResourceBlacklistRequest</code> being sent by the
  993. <code>ApplicationMaster</code>
  994. @see ResourceBlacklistRequest]]>
  995. </doc>
  996. </method>
  997. <method name="setResourceBlacklistRequest"
  998. abstract="true" native="false" synchronized="false"
  999. static="false" final="false" visibility="public"
  1000. deprecated="not deprecated">
  1001. <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
  1002. <doc>
  1003. <![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
  1004. <code>ResourceManager</code> about the blacklist additions and removals
  1005. per the <code>ApplicationMaster</code>.
  1006. @param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
  1007. to inform the <code>ResourceManager</code> about
  1008. the blacklist additions and removals
  1009. per the <code>ApplicationMaster</code>
  1010. @see ResourceBlacklistRequest]]>
  1011. </doc>
  1012. </method>
  1013. <method name="getIncreaseRequests" return="java.util.List"
  1014. abstract="true" native="false" synchronized="false"
  1015. static="false" final="false" visibility="public"
  1016. deprecated="not deprecated">
  1017. <doc>
  1018. <![CDATA[Get the <code>ContainerResourceIncreaseRequest</code> being sent by the
  1019. <code>ApplicationMaster</code>]]>
  1020. </doc>
  1021. </method>
  1022. <method name="setIncreaseRequests"
  1023. abstract="true" native="false" synchronized="false"
  1024. static="false" final="false" visibility="public"
  1025. deprecated="not deprecated">
  1026. <param name="increaseRequests" type="java.util.List"/>
  1027. <doc>
  1028. <![CDATA[Set the <code>ContainerResourceIncreaseRequest</code> to inform the
  1029. <code>ResourceManager</code> about some container's resources need to be
  1030. increased]]>
  1031. </doc>
  1032. </method>
  1033. <doc>
  1034. <![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
  1035. <code>ResourceManager</code> to obtain resources in the cluster.</p>
  1036. <p>The request includes:
  1037. <ul>
  1038. <li>A response id to track duplicate responses.</li>
  1039. <li>Progress information.</li>
  1040. <li>
  1041. A list of {@link ResourceRequest} to inform the
  1042. <code>ResourceManager</code> about the application's
  1043. resource requirements.
  1044. </li>
  1045. <li>
  1046. A list of unused {@link Container} which are being returned.
  1047. </li>
  1048. </ul>
  1049. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1050. </doc>
  1051. </class>
  1052. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
  1053. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1054. <class name="AllocateResponse" extends="java.lang.Object"
  1055. abstract="true"
  1056. static="false" final="false" visibility="public"
  1057. deprecated="not deprecated">
  1058. <constructor name="AllocateResponse"
  1059. static="false" final="false" visibility="public"
  1060. deprecated="not deprecated">
  1061. </constructor>
  1062. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1063. abstract="false" native="false" synchronized="false"
  1064. static="true" final="false" visibility="public"
  1065. deprecated="not deprecated">
  1066. <param name="responseId" type="int"/>
  1067. <param name="completedContainers" type="java.util.List"/>
  1068. <param name="allocatedContainers" type="java.util.List"/>
  1069. <param name="updatedNodes" type="java.util.List"/>
  1070. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1071. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1072. <param name="numClusterNodes" type="int"/>
  1073. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1074. <param name="nmTokens" type="java.util.List"/>
  1075. </method>
  1076. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
  1077. abstract="false" native="false" synchronized="false"
  1078. static="true" final="false" visibility="public"
  1079. deprecated="not deprecated">
  1080. <param name="responseId" type="int"/>
  1081. <param name="completedContainers" type="java.util.List"/>
  1082. <param name="allocatedContainers" type="java.util.List"/>
  1083. <param name="updatedNodes" type="java.util.List"/>
  1084. <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1085. <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
  1086. <param name="numClusterNodes" type="int"/>
  1087. <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
  1088. <param name="nmTokens" type="java.util.List"/>
  1089. <param name="increasedContainers" type="java.util.List"/>
  1090. <param name="decreasedContainers" type="java.util.List"/>
  1091. </method>
  1092. <method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
  1093. abstract="true" native="false" synchronized="false"
  1094. static="false" final="false" visibility="public"
  1095. deprecated="not deprecated">
  1096. <doc>
  1097. <![CDATA[If the <code>ResourceManager</code> needs the
  1098. <code>ApplicationMaster</code> to take some action then it will send an
  1099. AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
  1100. for details on commands and actions for them.
  1101. @return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
  1102. take action, <code>null</code> otherwise
  1103. @see AMCommand]]>
  1104. </doc>
  1105. </method>
  1106. <method name="getResponseId" return="int"
  1107. abstract="true" native="false" synchronized="false"
  1108. static="false" final="false" visibility="public"
  1109. deprecated="not deprecated">
  1110. <doc>
  1111. <![CDATA[Get the <em>last response id</em>.
  1112. @return <em>last response id</em>]]>
  1113. </doc>
  1114. </method>
  1115. <method name="getAllocatedContainers" return="java.util.List"
  1116. abstract="true" native="false" synchronized="false"
  1117. static="false" final="false" visibility="public"
  1118. deprecated="not deprecated">
  1119. <doc>
  1120. <![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
  1121. <code>ResourceManager</code>.
  1122. @return list of <em>newly allocated</em> <code>Container</code>]]>
  1123. </doc>
  1124. </method>
  1125. <method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
  1126. abstract="true" native="false" synchronized="false"
  1127. static="false" final="false" visibility="public"
  1128. deprecated="not deprecated">
  1129. <doc>
  1130. <![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
  1131. application.
  1132. @return limit of available headroom for resources in the cluster for the
  1133. application]]>
  1134. </doc>
  1135. </method>
  1136. <method name="getCompletedContainersStatuses" return="java.util.List"
  1137. abstract="true" native="false" synchronized="false"
  1138. static="false" final="false" visibility="public"
  1139. deprecated="not deprecated">
  1140. <doc>
  1141. <![CDATA[Get the list of <em>completed containers' statuses</em>.
  1142. @return the list of <em>completed containers' statuses</em>]]>
  1143. </doc>
  1144. </method>
  1145. <method name="getUpdatedNodes" return="java.util.List"
  1146. abstract="true" native="false" synchronized="false"
  1147. static="false" final="false" visibility="public"
  1148. deprecated="not deprecated">
  1149. <doc>
  1150. <![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
  1151. be changes in health, availability etc of the nodes.
  1152. @return The delta of updated nodes since the last response]]>
  1153. </doc>
  1154. </method>
  1155. <method name="getNumClusterNodes" return="int"
  1156. abstract="true" native="false" synchronized="false"
  1157. static="false" final="false" visibility="public"
  1158. deprecated="not deprecated">
  1159. <doc>
  1160. <![CDATA[Get the number of hosts available on the cluster.
  1161. @return the available host count.]]>
  1162. </doc>
  1163. </method>
  1164. <method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
  1165. abstract="true" native="false" synchronized="false"
  1166. static="false" final="false" visibility="public"
  1167. deprecated="not deprecated">
  1168. <doc>
  1169. <![CDATA[Get the description of containers owned by the AM, but requested back by
  1170. the cluster. Note that the RM may have an inconsistent view of the
  1171. resources owned by the AM. These messages are advisory, and the AM may
  1172. elect to ignore them.
  1173. <p>
  1174. The message is a snapshot of the resources the RM wants back from the AM.
  1175. While demand persists, the RM will repeat its request; applications should
  1176. not interpret each message as a request for <em>additional</em>
  1177. resources on top of previous messages. Resources requested consistently
  1178. over some duration may be forcibly killed by the RM.
  1179. @return A specification of the resources to reclaim from this AM.]]>
  1180. </doc>
  1181. </method>
  1182. <method name="getNMTokens" return="java.util.List"
  1183. abstract="true" native="false" synchronized="false"
  1184. static="false" final="false" visibility="public"
  1185. deprecated="not deprecated">
  1186. <doc>
  1187. <![CDATA[Get the list of NMTokens required for communicating with NM. New NMTokens
  1188. issued only if
  1189. <p>
  1190. 1) AM is receiving first container on underlying NodeManager.<br>
  1191. OR<br>
  1192. 2) NMToken master key rolled over in ResourceManager and AM is getting new
  1193. container on the same underlying NodeManager.
  1194. <p>
  1195. AM will receive one NMToken per NM irrespective of the number of containers
  1196. issued on same NM. AM is expected to store these tokens until issued a
  1197. new token for the same NM.]]>
  1198. </doc>
  1199. </method>
  1200. <method name="getIncreasedContainers" return="java.util.List"
  1201. abstract="true" native="false" synchronized="false"
  1202. static="false" final="false" visibility="public"
  1203. deprecated="not deprecated">
  1204. <doc>
  1205. <![CDATA[Get the list of newly increased containers by <code>ResourceManager</code>]]>
  1206. </doc>
  1207. </method>
  1208. <method name="getDecreasedContainers" return="java.util.List"
  1209. abstract="true" native="false" synchronized="false"
  1210. static="false" final="false" visibility="public"
  1211. deprecated="not deprecated">
  1212. <doc>
  1213. <![CDATA[Get the list of newly decreased containers by <code>NodeManager</code>]]>
  1214. </doc>
  1215. </method>
  1216. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  1217. abstract="true" native="false" synchronized="false"
  1218. static="false" final="false" visibility="public"
  1219. deprecated="not deprecated">
  1220. <doc>
  1221. <![CDATA[The AMRMToken that belong to this attempt
  1222. @return The AMRMToken that belong to this attempt]]>
  1223. </doc>
  1224. </method>
  1225. <doc>
  1226. <![CDATA[The response sent by the <code>ResourceManager</code> the
  1227. <code>ApplicationMaster</code> during resource negotiation.
  1228. <p>
  1229. The response, includes:
  1230. <ul>
  1231. <li>Response ID to track duplicate responses.</li>
  1232. <li>
  1233. An AMCommand sent by ResourceManager to let the
  1234. {@code ApplicationMaster} take some actions (resync, shutdown etc.).
  1235. </li>
  1236. <li>A list of newly allocated {@link Container}.</li>
  1237. <li>A list of completed {@link Container}s' statuses.</li>
  1238. <li>
  1239. The available headroom for resources in the cluster for the
  1240. application.
  1241. </li>
  1242. <li>A list of nodes whose status has been updated.</li>
  1243. <li>The number of available nodes in a cluster.</li>
  1244. <li>A description of resources requested back by the cluster</li>
  1245. <li>AMRMToken, if AMRMToken has been rolled over</li>
  1246. </ul>
  1247. @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
  1248. </doc>
  1249. </class>
  1250. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
  1251. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1252. <class name="ApplicationsRequestScope" extends="java.lang.Enum"
  1253. abstract="false"
  1254. static="false" final="true" visibility="public"
  1255. deprecated="not deprecated">
  1256. <method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
  1257. abstract="false" native="false" synchronized="false"
  1258. static="true" final="false" visibility="public"
  1259. deprecated="not deprecated">
  1260. </method>
  1261. <method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
  1262. abstract="false" native="false" synchronized="false"
  1263. static="true" final="false" visibility="public"
  1264. deprecated="not deprecated">
  1265. <param name="name" type="java.lang.String"/>
  1266. </method>
  1267. <doc>
  1268. <![CDATA[Enumeration that controls the scope of applications fetched]]>
  1269. </doc>
  1270. </class>
  1271. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
  1272. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  1273. <class name="FinishApplicationMasterRequest" extends="java.lang.Object"
  1274. abstract="true"
  1275. static="false" final="false" visibility="public"
  1276. deprecated="not deprecated">
  1277. <constructor name="FinishApplicationMasterRequest"
  1278. static="false" final="false" visibility="public"
  1279. deprecated="not deprecated">
  1280. </constructor>
  1281. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
  1282. abstract="false" native="false" synchronized="false"
  1283. static="true" final="false" visibility="public"
  1284. deprecated="not deprecated">
  1285. <param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1286. <param name="diagnostics" type="java.lang.String"/>
  1287. <param name="url" type="java.lang.String"/>
  1288. </method>
  1289. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  1290. abstract="true" native="false" synchronized="false"
  1291. static="false" final="false" visibility="public"
  1292. deprecated="not deprecated">
  1293. <doc>
  1294. <![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
  1295. @return <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1296. </doc>
  1297. </method>
  1298. <method name="setFinalApplicationStatus"
  1299. abstract="true" native="false" synchronized="false"
  1300. static="false" final="false" visibility="public"
  1301. deprecated="not deprecated">
  1302. <param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
  1303. <doc>
  1304. <![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
  1305. @param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
  1306. </doc>
  1307. </method>
  1308. <method name="getDiagnostics" return="java.lang.String"
  1309. abstract="true" native="false" synchronized="false"
  1310. static="false" final="false" visibility="public"
  1311. deprecated="not deprecated">
  1312. <doc>
  1313. <![CDATA[Get <em>diagnostic information</em> on application failure.
  1314. @return <em>diagnostic information</em> on application failure]]>
  1315. </doc>
  1316. </method>
  1317. <method name="setDiagnostics"
  1318. abstract="true" native="false" synchronized="false"
  1319. static="false" final="false" visibility="public"
  1320. deprecated="not deprecated">
  1321. <param name="diagnostics" type="java.lang.String"/>
  1322. <doc>
  1323. <![CDATA[Set <em>diagnostic information</em> on application failure.
  1324. @param diagnostics <em>diagnostic information</em> on application failure]]>
  1325. </doc>
  1326. </method>
  1327. <method name="getTrackingUrl" return="java.lang.String"
  1328. abstract="true" native="false" synchronized="false"
  1329. static="false" final="false" visibility="public"
  1330. deprecated="not deprecated">
  1331. <doc>
  1332. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  1333. This url if contains scheme then that will be used by resource manager
  1334. web application proxy otherwise it will default to http.
  1335. @return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  1336. </doc>
  1337. </method>
  1338. <method name="setTrackingUrl"
  1339. abstract="true" native="false" synchronized="false"
  1340. static="false" final="false" visibility="public"
  1341. deprecated="not deprecated">
  1342. <param name="url" type="java.lang.String"/>
  1343. <doc>
  1344. <![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
  1345. This is the web-URL to which ResourceManager or web-application proxy will
  1346. redirect client/users once the application is finished and the
  1347. <code>ApplicationMaster</code> is gone.
  1348. <p>
  1349. If the passed url has a scheme then that will be used by the
  1350. ResourceManager and web-application proxy, otherwise the scheme will
  1351. default to http.
  1352. </p>
  1353. <p>
  1354. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  1355. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  1356. <p>
  1357. @param url
  1358. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  1359. </doc>
  1360. </method>
  1361. <doc>
  1362. <![CDATA[The finalization request sent by the {@code ApplicationMaster} to
  1363. inform the {@code ResourceManager} about its completion.
  1364. <p>
  1365. The final request includes details such:
  1366. <ul>
  1367. <li>Final state of the {@code ApplicationMaster}</li>
  1368. <li>
  1369. Diagnostic information in case of failure of the
  1370. {@code ApplicationMaster}
  1371. </li>
  1372. <li>Tracking URL</li>
  1373. </ul>
  1374. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  1375. </doc>
  1376. </class>
  1377. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
  1378. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  1379. <class name="FinishApplicationMasterResponse" extends="java.lang.Object"
  1380. abstract="true"
  1381. static="false" final="false" visibility="public"
  1382. deprecated="not deprecated">
  1383. <constructor name="FinishApplicationMasterResponse"
  1384. static="false" final="false" visibility="public"
  1385. deprecated="not deprecated">
  1386. </constructor>
  1387. <method name="getIsUnregistered" return="boolean"
  1388. abstract="true" native="false" synchronized="false"
  1389. static="false" final="false" visibility="public"
  1390. deprecated="not deprecated">
  1391. <doc>
  1392. <![CDATA[Get the flag which indicates that the application has successfully
  1393. unregistered with the RM and the application can safely stop.]]>
  1394. </doc>
  1395. </method>
  1396. <doc>
  1397. <![CDATA[The response sent by the <code>ResourceManager</code> to a
  1398. <code>ApplicationMaster</code> on it's completion.
  1399. <p>
  1400. The response, includes:
  1401. <ul>
  1402. <li>A flag which indicates that the application has successfully unregistered
  1403. with the RM and the application can safely stop.</li>
  1404. </ul>
  1405. <p>
  1406. Note: The flag indicates whether the application has successfully
  1407. unregistered and is safe to stop. The application may stop after the flag is
  1408. true. If the application stops before the flag is true then the RM may retry
  1409. the application.
  1410. @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
  1411. </doc>
  1412. </class>
  1413. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
  1414. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  1415. <class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
  1416. abstract="true"
  1417. static="false" final="false" visibility="public"
  1418. deprecated="not deprecated">
  1419. <constructor name="GetApplicationAttemptReportRequest"
  1420. static="false" final="false" visibility="public"
  1421. deprecated="not deprecated">
  1422. </constructor>
  1423. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
  1424. abstract="false" native="false" synchronized="false"
  1425. static="true" final="false" visibility="public"
  1426. deprecated="not deprecated">
  1427. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1428. </method>
  1429. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1430. abstract="true" native="false" synchronized="false"
  1431. static="false" final="false" visibility="public"
  1432. deprecated="not deprecated">
  1433. <doc>
  1434. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  1435. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  1436. </doc>
  1437. </method>
  1438. <method name="setApplicationAttemptId"
  1439. abstract="true" native="false" synchronized="false"
  1440. static="false" final="false" visibility="public"
  1441. deprecated="not deprecated">
  1442. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1443. <doc>
  1444. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  1445. @param applicationAttemptId
  1446. <code>ApplicationAttemptId</code> of an application attempt]]>
  1447. </doc>
  1448. </method>
  1449. <doc>
  1450. <![CDATA[<p>
  1451. The request sent by a client to the <code>ResourceManager</code> to get an
  1452. {@link ApplicationAttemptReport} for an application attempt.
  1453. </p>
  1454. <p>
  1455. The request should include the {@link ApplicationAttemptId} of the
  1456. application attempt.
  1457. </p>
  1458. @see ApplicationAttemptReport
  1459. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  1460. </doc>
  1461. </class>
  1462. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
  1463. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  1464. <class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
  1465. abstract="true"
  1466. static="false" final="false" visibility="public"
  1467. deprecated="not deprecated">
  1468. <constructor name="GetApplicationAttemptReportResponse"
  1469. static="false" final="false" visibility="public"
  1470. deprecated="not deprecated">
  1471. </constructor>
  1472. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
  1473. abstract="false" native="false" synchronized="false"
  1474. static="true" final="false" visibility="public"
  1475. deprecated="not deprecated">
  1476. <param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  1477. </method>
  1478. <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
  1479. abstract="true" native="false" synchronized="false"
  1480. static="false" final="false" visibility="public"
  1481. deprecated="not deprecated">
  1482. <doc>
  1483. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  1484. @return <code>ApplicationAttemptReport</code> for the application attempt]]>
  1485. </doc>
  1486. </method>
  1487. <method name="setApplicationAttemptReport"
  1488. abstract="true" native="false" synchronized="false"
  1489. static="false" final="false" visibility="public"
  1490. deprecated="not deprecated">
  1491. <param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
  1492. <doc>
  1493. <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
  1494. @param applicationAttemptReport
  1495. <code>ApplicationAttemptReport</code> for the application attempt]]>
  1496. </doc>
  1497. </method>
  1498. <doc>
  1499. <![CDATA[<p>
  1500. The response sent by the <code>ResourceManager</code> to a client requesting
  1501. an application attempt report.
  1502. </p>
  1503. <p>
  1504. The response includes an {@link ApplicationAttemptReport} which has the
  1505. details about the particular application attempt
  1506. </p>
  1507. @see ApplicationAttemptReport
  1508. @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
  1509. </doc>
  1510. </class>
  1511. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
  1512. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  1513. <class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
  1514. abstract="true"
  1515. static="false" final="false" visibility="public"
  1516. deprecated="not deprecated">
  1517. <constructor name="GetApplicationAttemptsRequest"
  1518. static="false" final="false" visibility="public"
  1519. deprecated="not deprecated">
  1520. </constructor>
  1521. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
  1522. abstract="false" native="false" synchronized="false"
  1523. static="true" final="false" visibility="public"
  1524. deprecated="not deprecated">
  1525. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1526. </method>
  1527. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  1528. abstract="true" native="false" synchronized="false"
  1529. static="false" final="false" visibility="public"
  1530. deprecated="not deprecated">
  1531. <doc>
  1532. <![CDATA[Get the <code>ApplicationId</code> of an application
  1533. @return <code>ApplicationId</code> of an application]]>
  1534. </doc>
  1535. </method>
  1536. <method name="setApplicationId"
  1537. abstract="true" native="false" synchronized="false"
  1538. static="false" final="false" visibility="public"
  1539. deprecated="not deprecated">
  1540. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1541. <doc>
  1542. <![CDATA[Set the <code>ApplicationId</code> of an application
  1543. @param applicationId
  1544. <code>ApplicationId</code> of an application]]>
  1545. </doc>
  1546. </method>
  1547. <doc>
  1548. <![CDATA[<p>
  1549. The request from clients to get a list of application attempt reports of an
  1550. application from the <code>ResourceManager</code>.
  1551. </p>
  1552. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  1553. </doc>
  1554. </class>
  1555. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
  1556. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  1557. <class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
  1558. abstract="true"
  1559. static="false" final="false" visibility="public"
  1560. deprecated="not deprecated">
  1561. <constructor name="GetApplicationAttemptsResponse"
  1562. static="false" final="false" visibility="public"
  1563. deprecated="not deprecated">
  1564. </constructor>
  1565. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
  1566. abstract="false" native="false" synchronized="false"
  1567. static="true" final="false" visibility="public"
  1568. deprecated="not deprecated">
  1569. <param name="applicationAttempts" type="java.util.List"/>
  1570. </method>
  1571. <method name="getApplicationAttemptList" return="java.util.List"
  1572. abstract="true" native="false" synchronized="false"
  1573. static="false" final="false" visibility="public"
  1574. deprecated="not deprecated">
  1575. <doc>
  1576. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  1577. @return a list of <code>ApplicationReport</code> of an application]]>
  1578. </doc>
  1579. </method>
  1580. <method name="setApplicationAttemptList"
  1581. abstract="true" native="false" synchronized="false"
  1582. static="false" final="false" visibility="public"
  1583. deprecated="not deprecated">
  1584. <param name="applicationAttempts" type="java.util.List"/>
  1585. <doc>
  1586. <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
  1587. @param applicationAttempts
  1588. a list of <code>ApplicationReport</code> of an application]]>
  1589. </doc>
  1590. </method>
  1591. <doc>
  1592. <![CDATA[<p>
  1593. The response sent by the <code>ResourceManager</code> to a client requesting
  1594. a list of {@link ApplicationAttemptReport} for application attempts.
  1595. </p>
  1596. <p>
  1597. The <code>ApplicationAttemptReport</code> for each application includes the
  1598. details of an application attempt.
  1599. </p>
  1600. @see ApplicationAttemptReport
  1601. @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
  1602. </doc>
  1603. </class>
  1604. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
  1605. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  1606. <class name="GetApplicationReportRequest" extends="java.lang.Object"
  1607. abstract="true"
  1608. static="false" final="false" visibility="public"
  1609. deprecated="not deprecated">
  1610. <constructor name="GetApplicationReportRequest"
  1611. static="false" final="false" visibility="public"
  1612. deprecated="not deprecated">
  1613. </constructor>
  1614. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
  1615. abstract="false" native="false" synchronized="false"
  1616. static="true" final="false" visibility="public"
  1617. deprecated="not deprecated">
  1618. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1619. </method>
  1620. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  1621. abstract="true" native="false" synchronized="false"
  1622. static="false" final="false" visibility="public"
  1623. deprecated="not deprecated">
  1624. <doc>
  1625. <![CDATA[Get the <code>ApplicationId</code> of the application.
  1626. @return <code>ApplicationId</code> of the application]]>
  1627. </doc>
  1628. </method>
  1629. <method name="setApplicationId"
  1630. abstract="true" native="false" synchronized="false"
  1631. static="false" final="false" visibility="public"
  1632. deprecated="not deprecated">
  1633. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1634. <doc>
  1635. <![CDATA[Set the <code>ApplicationId</code> of the application
  1636. @param applicationId <code>ApplicationId</code> of the application]]>
  1637. </doc>
  1638. </method>
  1639. <doc>
  1640. <![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
  1641. get an {@link ApplicationReport} for an application.</p>
  1642. <p>The request should include the {@link ApplicationId} of the
  1643. application.</p>
  1644. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
  1645. @see ApplicationReport]]>
  1646. </doc>
  1647. </class>
  1648. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
  1649. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  1650. <class name="GetApplicationReportResponse" extends="java.lang.Object"
  1651. abstract="true"
  1652. static="false" final="false" visibility="public"
  1653. deprecated="not deprecated">
  1654. <constructor name="GetApplicationReportResponse"
  1655. static="false" final="false" visibility="public"
  1656. deprecated="not deprecated">
  1657. </constructor>
  1658. <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
  1659. abstract="true" native="false" synchronized="false"
  1660. static="false" final="false" visibility="public"
  1661. deprecated="not deprecated">
  1662. <doc>
  1663. <![CDATA[Get the <code>ApplicationReport</code> for the application.
  1664. @return <code>ApplicationReport</code> for the application]]>
  1665. </doc>
  1666. </method>
  1667. <doc>
  1668. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  1669. requesting an application report.</p>
  1670. <p>The response includes an {@link ApplicationReport} which has details such
  1671. as user, queue, name, host on which the <code>ApplicationMaster</code> is
  1672. running, RPC port, tracking URL, diagnostics, start time etc.</p>
  1673. @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
  1674. </doc>
  1675. </class>
  1676. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
  1677. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  1678. <class name="GetApplicationsRequest" extends="java.lang.Object"
  1679. abstract="true"
  1680. static="false" final="false" visibility="public"
  1681. deprecated="not deprecated">
  1682. <constructor name="GetApplicationsRequest"
  1683. static="false" final="false" visibility="public"
  1684. deprecated="not deprecated">
  1685. </constructor>
  1686. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1687. abstract="false" native="false" synchronized="false"
  1688. static="true" final="false" visibility="public"
  1689. deprecated="not deprecated">
  1690. </method>
  1691. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1692. abstract="false" native="false" synchronized="false"
  1693. static="true" final="false" visibility="public"
  1694. deprecated="not deprecated">
  1695. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  1696. <param name="users" type="java.util.Set"/>
  1697. <param name="queues" type="java.util.Set"/>
  1698. <param name="applicationTypes" type="java.util.Set"/>
  1699. <param name="applicationTags" type="java.util.Set"/>
  1700. <param name="applicationStates" type="java.util.EnumSet"/>
  1701. <param name="startRange" type="org.apache.commons.lang.math.LongRange"/>
  1702. <param name="finishRange" type="org.apache.commons.lang.math.LongRange"/>
  1703. <param name="limit" type="java.lang.Long"/>
  1704. <doc>
  1705. <![CDATA[<p>
  1706. The request from clients to get a report of Applications matching the
  1707. giving application types in the cluster from the
  1708. <code>ResourceManager</code>.
  1709. </p>
  1710. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
  1711. <p>Setting any of the parameters to null, would just disable that
  1712. filter</p>
  1713. @param scope {@link ApplicationsRequestScope} to filter by
  1714. @param users list of users to filter by
  1715. @param queues list of scheduler queues to filter by
  1716. @param applicationTypes types of applications
  1717. @param applicationTags application tags to filter by
  1718. @param applicationStates application states to filter by
  1719. @param startRange range of application start times to filter by
  1720. @param finishRange range of application finish times to filter by
  1721. @param limit number of applications to limit to
  1722. @return {@link GetApplicationsRequest} to be used with
  1723. {@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
  1724. </doc>
  1725. </method>
  1726. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1727. abstract="false" native="false" synchronized="false"
  1728. static="true" final="false" visibility="public"
  1729. deprecated="not deprecated">
  1730. <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
  1731. <doc>
  1732. <![CDATA[<p>
  1733. The request from clients to get a report of Applications matching the
  1734. giving application types in the cluster from the
  1735. <code>ResourceManager</code>.
  1736. </p>
  1737. @param scope {@link ApplicationsRequestScope} to filter by
  1738. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1739. </doc>
  1740. </method>
  1741. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1742. abstract="false" native="false" synchronized="false"
  1743. static="true" final="false" visibility="public"
  1744. deprecated="not deprecated">
  1745. <param name="applicationTypes" type="java.util.Set"/>
  1746. <doc>
  1747. <![CDATA[<p>
  1748. The request from clients to get a report of Applications matching the
  1749. giving application types in the cluster from the
  1750. <code>ResourceManager</code>.
  1751. </p>
  1752. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1753. </doc>
  1754. </method>
  1755. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1756. abstract="false" native="false" synchronized="false"
  1757. static="true" final="false" visibility="public"
  1758. deprecated="not deprecated">
  1759. <param name="applicationStates" type="java.util.EnumSet"/>
  1760. <doc>
  1761. <![CDATA[<p>
  1762. The request from clients to get a report of Applications matching the
  1763. giving application states in the cluster from the
  1764. <code>ResourceManager</code>.
  1765. </p>
  1766. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1767. </doc>
  1768. </method>
  1769. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
  1770. abstract="false" native="false" synchronized="false"
  1771. static="true" final="false" visibility="public"
  1772. deprecated="not deprecated">
  1773. <param name="applicationTypes" type="java.util.Set"/>
  1774. <param name="applicationStates" type="java.util.EnumSet"/>
  1775. <doc>
  1776. <![CDATA[<p>
  1777. The request from clients to get a report of Applications matching the
  1778. giving and application types and application types in the cluster from the
  1779. <code>ResourceManager</code>.
  1780. </p>
  1781. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1782. </doc>
  1783. </method>
  1784. <method name="getApplicationTypes" return="java.util.Set"
  1785. abstract="true" native="false" synchronized="false"
  1786. static="false" final="false" visibility="public"
  1787. deprecated="not deprecated">
  1788. <doc>
  1789. <![CDATA[Get the application types to filter applications on
  1790. @return Set of Application Types to filter on]]>
  1791. </doc>
  1792. </method>
  1793. <method name="getApplicationStates" return="java.util.EnumSet"
  1794. abstract="true" native="false" synchronized="false"
  1795. static="false" final="false" visibility="public"
  1796. deprecated="not deprecated">
  1797. <doc>
  1798. <![CDATA[Get the application states to filter applications on
  1799. @return Set of Application states to filter on]]>
  1800. </doc>
  1801. </method>
  1802. <doc>
  1803. <![CDATA[<p>The request from clients to get a report of Applications
  1804. in the cluster from the <code>ResourceManager</code>.</p>
  1805. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1806. </doc>
  1807. </class>
  1808. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
  1809. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  1810. <class name="GetApplicationsResponse" extends="java.lang.Object"
  1811. abstract="true"
  1812. static="false" final="false" visibility="public"
  1813. deprecated="not deprecated">
  1814. <constructor name="GetApplicationsResponse"
  1815. static="false" final="false" visibility="public"
  1816. deprecated="not deprecated">
  1817. </constructor>
  1818. <method name="getApplicationList" return="java.util.List"
  1819. abstract="true" native="false" synchronized="false"
  1820. static="false" final="false" visibility="public"
  1821. deprecated="not deprecated">
  1822. <doc>
  1823. <![CDATA[Get <code>ApplicationReport</code> for applications.
  1824. @return <code>ApplicationReport</code> for applications]]>
  1825. </doc>
  1826. </method>
  1827. <doc>
  1828. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  1829. requesting an {@link ApplicationReport} for applications.</p>
  1830. <p>The <code>ApplicationReport</code> for each application includes details
  1831. such as user, queue, name, host on which the <code>ApplicationMaster</code>
  1832. is running, RPC port, tracking URL, diagnostics, start time etc.</p>
  1833. @see ApplicationReport
  1834. @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
  1835. </doc>
  1836. </class>
  1837. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
  1838. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  1839. <class name="GetClusterMetricsRequest" extends="java.lang.Object"
  1840. abstract="true"
  1841. static="false" final="false" visibility="public"
  1842. deprecated="not deprecated">
  1843. <constructor name="GetClusterMetricsRequest"
  1844. static="false" final="false" visibility="public"
  1845. deprecated="not deprecated">
  1846. </constructor>
  1847. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
  1848. abstract="false" native="false" synchronized="false"
  1849. static="true" final="false" visibility="public"
  1850. deprecated="not deprecated">
  1851. </method>
  1852. <doc>
  1853. <![CDATA[<p>The request sent by clients to get cluster metrics from the
  1854. <code>ResourceManager</code>.</p>
  1855. <p>Currently, this is empty.</p>
  1856. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  1857. </doc>
  1858. </class>
  1859. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
  1860. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  1861. <class name="GetClusterMetricsResponse" extends="java.lang.Object"
  1862. abstract="true"
  1863. static="false" final="false" visibility="public"
  1864. deprecated="not deprecated">
  1865. <constructor name="GetClusterMetricsResponse"
  1866. static="false" final="false" visibility="public"
  1867. deprecated="not deprecated">
  1868. </constructor>
  1869. <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
  1870. abstract="true" native="false" synchronized="false"
  1871. static="false" final="false" visibility="public"
  1872. deprecated="not deprecated">
  1873. <doc>
  1874. <![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
  1875. @return <code>YarnClusterMetrics</code> for the cluster]]>
  1876. </doc>
  1877. </method>
  1878. <doc>
  1879. <![CDATA[The response sent by the <code>ResourceManager</code> to a client
  1880. requesting cluster metrics.
  1881. @see YarnClusterMetrics
  1882. @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
  1883. </doc>
  1884. </class>
  1885. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
  1886. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  1887. <class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
  1888. abstract="true"
  1889. static="false" final="false" visibility="public"
  1890. deprecated="not deprecated">
  1891. <constructor name="GetClusterNodeLabelsRequest"
  1892. static="false" final="false" visibility="public"
  1893. deprecated="not deprecated">
  1894. </constructor>
  1895. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
  1896. abstract="false" native="false" synchronized="false"
  1897. static="true" final="false" visibility="public"
  1898. deprecated="not deprecated">
  1899. </method>
  1900. </class>
  1901. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
  1902. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  1903. <class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
  1904. abstract="true"
  1905. static="false" final="false" visibility="public"
  1906. deprecated="not deprecated">
  1907. <constructor name="GetClusterNodeLabelsResponse"
  1908. static="false" final="false" visibility="public"
  1909. deprecated="not deprecated">
  1910. </constructor>
  1911. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
  1912. abstract="false" native="false" synchronized="false"
  1913. static="true" final="false" visibility="public"
  1914. deprecated="not deprecated">
  1915. <param name="labels" type="java.util.Set"/>
  1916. </method>
  1917. <method name="setNodeLabels"
  1918. abstract="true" native="false" synchronized="false"
  1919. static="false" final="false" visibility="public"
  1920. deprecated="not deprecated">
  1921. <param name="labels" type="java.util.Set"/>
  1922. </method>
  1923. <method name="getNodeLabels" return="java.util.Set"
  1924. abstract="true" native="false" synchronized="false"
  1925. static="false" final="false" visibility="public"
  1926. deprecated="not deprecated">
  1927. </method>
  1928. </class>
  1929. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
  1930. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  1931. <class name="GetClusterNodesRequest" extends="java.lang.Object"
  1932. abstract="true"
  1933. static="false" final="false" visibility="public"
  1934. deprecated="not deprecated">
  1935. <constructor name="GetClusterNodesRequest"
  1936. static="false" final="false" visibility="public"
  1937. deprecated="not deprecated">
  1938. </constructor>
  1939. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  1940. abstract="false" native="false" synchronized="false"
  1941. static="true" final="false" visibility="public"
  1942. deprecated="not deprecated">
  1943. <param name="states" type="java.util.EnumSet"/>
  1944. </method>
  1945. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
  1946. abstract="false" native="false" synchronized="false"
  1947. static="true" final="false" visibility="public"
  1948. deprecated="not deprecated">
  1949. </method>
  1950. <method name="getNodeStates" return="java.util.EnumSet"
  1951. abstract="true" native="false" synchronized="false"
  1952. static="false" final="false" visibility="public"
  1953. deprecated="not deprecated">
  1954. <doc>
  1955. <![CDATA[The state to filter the cluster nodes with.]]>
  1956. </doc>
  1957. </method>
  1958. <method name="setNodeStates"
  1959. abstract="true" native="false" synchronized="false"
  1960. static="false" final="false" visibility="public"
  1961. deprecated="not deprecated">
  1962. <param name="states" type="java.util.EnumSet"/>
  1963. <doc>
  1964. <![CDATA[The state to filter the cluster nodes with.]]>
  1965. </doc>
  1966. </method>
  1967. <doc>
  1968. <![CDATA[<p>The request from clients to get a report of all nodes
  1969. in the cluster from the <code>ResourceManager</code>.</p>
  1970. The request will ask for all nodes in the given {@link NodeState}s.
  1971. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  1972. </doc>
  1973. </class>
  1974. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
  1975. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  1976. <class name="GetClusterNodesResponse" extends="java.lang.Object"
  1977. abstract="true"
  1978. static="false" final="false" visibility="public"
  1979. deprecated="not deprecated">
  1980. <constructor name="GetClusterNodesResponse"
  1981. static="false" final="false" visibility="public"
  1982. deprecated="not deprecated">
  1983. </constructor>
  1984. <method name="getNodeReports" return="java.util.List"
  1985. abstract="true" native="false" synchronized="false"
  1986. static="false" final="false" visibility="public"
  1987. deprecated="not deprecated">
  1988. <doc>
  1989. <![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
  1990. @return <code>NodeReport</code> for all nodes in the cluster]]>
  1991. </doc>
  1992. </method>
  1993. <doc>
  1994. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
  1995. requesting a {@link NodeReport} for all nodes.</p>
  1996. <p>The <code>NodeReport</code> contains per-node information such as
  1997. available resources, number of containers, tracking url, rack name, health
  1998. status etc.
  1999. @see NodeReport
  2000. @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
  2001. </doc>
  2002. </class>
  2003. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
  2004. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  2005. <class name="GetContainerReportRequest" extends="java.lang.Object"
  2006. abstract="true"
  2007. static="false" final="false" visibility="public"
  2008. deprecated="not deprecated">
  2009. <constructor name="GetContainerReportRequest"
  2010. static="false" final="false" visibility="public"
  2011. deprecated="not deprecated">
  2012. </constructor>
  2013. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
  2014. abstract="false" native="false" synchronized="false"
  2015. static="true" final="false" visibility="public"
  2016. deprecated="not deprecated">
  2017. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2018. </method>
  2019. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  2020. abstract="true" native="false" synchronized="false"
  2021. static="false" final="false" visibility="public"
  2022. deprecated="not deprecated">
  2023. <doc>
  2024. <![CDATA[Get the <code>ContainerId</code> of the Container.
  2025. @return <code>ContainerId</code> of the Container]]>
  2026. </doc>
  2027. </method>
  2028. <method name="setContainerId"
  2029. abstract="true" native="false" synchronized="false"
  2030. static="false" final="false" visibility="public"
  2031. deprecated="not deprecated">
  2032. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2033. <doc>
  2034. <![CDATA[Set the <code>ContainerId</code> of the container
  2035. @param containerId
  2036. <code>ContainerId</code> of the container]]>
  2037. </doc>
  2038. </method>
  2039. <doc>
  2040. <![CDATA[<p>
  2041. The request sent by a client to the <code>ResourceManager</code> to get an
  2042. {@link ContainerReport} for a container.
  2043. </p>]]>
  2044. </doc>
  2045. </class>
  2046. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
  2047. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  2048. <class name="GetContainerReportResponse" extends="java.lang.Object"
  2049. abstract="true"
  2050. static="false" final="false" visibility="public"
  2051. deprecated="not deprecated">
  2052. <constructor name="GetContainerReportResponse"
  2053. static="false" final="false" visibility="public"
  2054. deprecated="not deprecated">
  2055. </constructor>
  2056. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
  2057. abstract="false" native="false" synchronized="false"
  2058. static="true" final="false" visibility="public"
  2059. deprecated="not deprecated">
  2060. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  2061. </method>
  2062. <method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
  2063. abstract="true" native="false" synchronized="false"
  2064. static="false" final="false" visibility="public"
  2065. deprecated="not deprecated">
  2066. <doc>
  2067. <![CDATA[Get the <code>ContainerReport</code> for the container.
  2068. @return <code>ContainerReport</code> for the container]]>
  2069. </doc>
  2070. </method>
  2071. <method name="setContainerReport"
  2072. abstract="true" native="false" synchronized="false"
  2073. static="false" final="false" visibility="public"
  2074. deprecated="not deprecated">
  2075. <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
  2076. </method>
  2077. <doc>
  2078. <![CDATA[<p>
  2079. The response sent by the <code>ResourceManager</code> to a client requesting
  2080. a container report.
  2081. </p>
  2082. <p>
  2083. The response includes a {@link ContainerReport} which has details of a
  2084. container.
  2085. </p>]]>
  2086. </doc>
  2087. </class>
  2088. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
  2089. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2090. <class name="GetContainersRequest" extends="java.lang.Object"
  2091. abstract="true"
  2092. static="false" final="false" visibility="public"
  2093. deprecated="not deprecated">
  2094. <constructor name="GetContainersRequest"
  2095. static="false" final="false" visibility="public"
  2096. deprecated="not deprecated">
  2097. </constructor>
  2098. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
  2099. abstract="false" native="false" synchronized="false"
  2100. static="true" final="false" visibility="public"
  2101. deprecated="not deprecated">
  2102. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2103. </method>
  2104. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2105. abstract="true" native="false" synchronized="false"
  2106. static="false" final="false" visibility="public"
  2107. deprecated="not deprecated">
  2108. <doc>
  2109. <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
  2110. @return <code>ApplicationAttemptId</code> of an application attempt]]>
  2111. </doc>
  2112. </method>
  2113. <method name="setApplicationAttemptId"
  2114. abstract="true" native="false" synchronized="false"
  2115. static="false" final="false" visibility="public"
  2116. deprecated="not deprecated">
  2117. <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2118. <doc>
  2119. <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
  2120. @param applicationAttemptId
  2121. <code>ApplicationAttemptId</code> of an application attempt]]>
  2122. </doc>
  2123. </method>
  2124. <doc>
  2125. <![CDATA[<p>
  2126. The request from clients to get a list of container reports, which belong to
  2127. an application attempt from the <code>ResourceManager</code>.
  2128. </p>
  2129. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2130. </doc>
  2131. </class>
  2132. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
  2133. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2134. <class name="GetContainersResponse" extends="java.lang.Object"
  2135. abstract="true"
  2136. static="false" final="false" visibility="public"
  2137. deprecated="not deprecated">
  2138. <constructor name="GetContainersResponse"
  2139. static="false" final="false" visibility="public"
  2140. deprecated="not deprecated">
  2141. </constructor>
  2142. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
  2143. abstract="false" native="false" synchronized="false"
  2144. static="true" final="false" visibility="public"
  2145. deprecated="not deprecated">
  2146. <param name="containers" type="java.util.List"/>
  2147. </method>
  2148. <method name="getContainerList" return="java.util.List"
  2149. abstract="true" native="false" synchronized="false"
  2150. static="false" final="false" visibility="public"
  2151. deprecated="not deprecated">
  2152. <doc>
  2153. <![CDATA[Get a list of <code>ContainerReport</code> for all the containers of an
  2154. application attempt.
  2155. @return a list of <code>ContainerReport</code> for all the containers of an
  2156. application attempt]]>
  2157. </doc>
  2158. </method>
  2159. <method name="setContainerList"
  2160. abstract="true" native="false" synchronized="false"
  2161. static="false" final="false" visibility="public"
  2162. deprecated="not deprecated">
  2163. <param name="containers" type="java.util.List"/>
  2164. <doc>
  2165. <![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
  2166. application attempt.
  2167. @param containers
  2168. a list of <code>ContainerReport</code> for all the containers of
  2169. an application attempt]]>
  2170. </doc>
  2171. </method>
  2172. <doc>
  2173. <![CDATA[<p>
  2174. The response sent by the <code>ResourceManager</code> to a client requesting
  2175. a list of {@link ContainerReport} for containers.
  2176. </p>
  2177. <p>
  2178. The <code>ContainerReport</code> for each container includes the container
  2179. details.
  2180. </p>
  2181. @see ContainerReport
  2182. @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
  2183. </doc>
  2184. </class>
  2185. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
  2186. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  2187. <class name="GetContainerStatusesRequest" extends="java.lang.Object"
  2188. abstract="true"
  2189. static="false" final="false" visibility="public"
  2190. deprecated="not deprecated">
  2191. <constructor name="GetContainerStatusesRequest"
  2192. static="false" final="false" visibility="public"
  2193. deprecated="not deprecated">
  2194. </constructor>
  2195. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
  2196. abstract="false" native="false" synchronized="false"
  2197. static="true" final="false" visibility="public"
  2198. deprecated="not deprecated">
  2199. <param name="containerIds" type="java.util.List"/>
  2200. </method>
  2201. <method name="getContainerIds" return="java.util.List"
  2202. abstract="true" native="false" synchronized="false"
  2203. static="false" final="false" visibility="public"
  2204. deprecated="not deprecated">
  2205. <doc>
  2206. <![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
  2207. the <code>ContainerStatus</code>.
  2208. @return the list of <code>ContainerId</code>s of containers for which to
  2209. obtain the <code>ContainerStatus</code>.]]>
  2210. </doc>
  2211. </method>
  2212. <method name="setContainerIds"
  2213. abstract="true" native="false" synchronized="false"
  2214. static="false" final="false" visibility="public"
  2215. deprecated="not deprecated">
  2216. <param name="containerIds" type="java.util.List"/>
  2217. <doc>
  2218. <![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
  2219. the <code>ContainerStatus</code>
  2220. @param containerIds
  2221. a list of <code>ContainerId</code>s of containers for which to
  2222. obtain the <code>ContainerStatus</code>]]>
  2223. </doc>
  2224. </method>
  2225. <doc>
  2226. <![CDATA[The request sent by the <code>ApplicationMaster</code> to the
  2227. <code>NodeManager</code> to get {@link ContainerStatus} of requested
  2228. containers.
  2229. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  2230. </doc>
  2231. </class>
  2232. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
  2233. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  2234. <class name="GetContainerStatusesResponse" extends="java.lang.Object"
  2235. abstract="true"
  2236. static="false" final="false" visibility="public"
  2237. deprecated="not deprecated">
  2238. <constructor name="GetContainerStatusesResponse"
  2239. static="false" final="false" visibility="public"
  2240. deprecated="not deprecated">
  2241. </constructor>
  2242. <method name="getContainerStatuses" return="java.util.List"
  2243. abstract="true" native="false" synchronized="false"
  2244. static="false" final="false" visibility="public"
  2245. deprecated="not deprecated">
  2246. <doc>
  2247. <![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
  2248. @return <code>ContainerStatus</code>es of the requested containers.]]>
  2249. </doc>
  2250. </method>
  2251. <method name="getFailedRequests" return="java.util.Map"
  2252. abstract="true" native="false" synchronized="false"
  2253. static="false" final="false" visibility="public"
  2254. deprecated="not deprecated">
  2255. <doc>
  2256. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  2257. from per container for failed requests]]>
  2258. </doc>
  2259. </method>
  2260. <doc>
  2261. <![CDATA[The response sent by the <code>NodeManager</code> to the
  2262. <code>ApplicationMaster</code> when asked to obtain the
  2263. <code>ContainerStatus</code> of requested containers.
  2264. @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
  2265. </doc>
  2266. </class>
  2267. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
  2268. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  2269. <class name="GetDelegationTokenRequest" extends="java.lang.Object"
  2270. abstract="true"
  2271. static="false" final="false" visibility="public"
  2272. deprecated="not deprecated">
  2273. <constructor name="GetDelegationTokenRequest"
  2274. static="false" final="false" visibility="public"
  2275. deprecated="not deprecated">
  2276. </constructor>
  2277. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
  2278. abstract="false" native="false" synchronized="false"
  2279. static="true" final="false" visibility="public"
  2280. deprecated="not deprecated">
  2281. <param name="renewer" type="java.lang.String"/>
  2282. </method>
  2283. <method name="getRenewer" return="java.lang.String"
  2284. abstract="true" native="false" synchronized="false"
  2285. static="false" final="false" visibility="public"
  2286. deprecated="not deprecated">
  2287. </method>
  2288. <method name="setRenewer"
  2289. abstract="true" native="false" synchronized="false"
  2290. static="false" final="false" visibility="public"
  2291. deprecated="not deprecated">
  2292. <param name="renewer" type="java.lang.String"/>
  2293. </method>
  2294. <doc>
  2295. <![CDATA[The request issued by the client to get a delegation token from
  2296. the {@code ResourceManager}.
  2297. for more information.]]>
  2298. </doc>
  2299. </class>
  2300. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
  2301. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  2302. <class name="GetDelegationTokenResponse" extends="java.lang.Object"
  2303. abstract="true"
  2304. static="false" final="false" visibility="public"
  2305. deprecated="not deprecated">
  2306. <constructor name="GetDelegationTokenResponse"
  2307. static="false" final="false" visibility="public"
  2308. deprecated="not deprecated">
  2309. </constructor>
  2310. <method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
  2311. abstract="true" native="false" synchronized="false"
  2312. static="false" final="false" visibility="public"
  2313. deprecated="not deprecated">
  2314. <doc>
  2315. <![CDATA[The Delegation tokens have a identifier which maps to
  2316. {@link AbstractDelegationTokenIdentifier}.]]>
  2317. </doc>
  2318. </method>
  2319. <doc>
  2320. <![CDATA[Response to a {@link GetDelegationTokenRequest} request
  2321. from the client. The response contains the token that
  2322. can be used by the containers to talk to ClientRMService.]]>
  2323. </doc>
  2324. </class>
  2325. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
  2326. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest -->
  2327. <class name="GetLabelsToNodesRequest" extends="java.lang.Object"
  2328. abstract="true"
  2329. static="false" final="false" visibility="public"
  2330. deprecated="not deprecated">
  2331. <constructor name="GetLabelsToNodesRequest"
  2332. static="false" final="false" visibility="public"
  2333. deprecated="not deprecated">
  2334. </constructor>
  2335. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"
  2336. abstract="false" native="false" synchronized="false"
  2337. static="true" final="false" visibility="public"
  2338. deprecated="not deprecated">
  2339. </method>
  2340. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"
  2341. abstract="false" native="false" synchronized="false"
  2342. static="true" final="false" visibility="public"
  2343. deprecated="not deprecated">
  2344. <param name="nodeLabels" type="java.util.Set"/>
  2345. </method>
  2346. <method name="setNodeLabels"
  2347. abstract="true" native="false" synchronized="false"
  2348. static="false" final="false" visibility="public"
  2349. deprecated="not deprecated">
  2350. <param name="nodeLabels" type="java.util.Set"/>
  2351. </method>
  2352. <method name="getNodeLabels" return="java.util.Set"
  2353. abstract="true" native="false" synchronized="false"
  2354. static="false" final="false" visibility="public"
  2355. deprecated="not deprecated">
  2356. </method>
  2357. </class>
  2358. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest -->
  2359. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse -->
  2360. <class name="GetLabelsToNodesResponse" extends="java.lang.Object"
  2361. abstract="true"
  2362. static="false" final="false" visibility="public"
  2363. deprecated="not deprecated">
  2364. <constructor name="GetLabelsToNodesResponse"
  2365. static="false" final="false" visibility="public"
  2366. deprecated="not deprecated">
  2367. </constructor>
  2368. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse"
  2369. abstract="false" native="false" synchronized="false"
  2370. static="true" final="false" visibility="public"
  2371. deprecated="not deprecated">
  2372. <param name="map" type="java.util.Map"/>
  2373. </method>
  2374. <method name="setLabelsToNodes"
  2375. abstract="true" native="false" synchronized="false"
  2376. static="false" final="false" visibility="public"
  2377. deprecated="not deprecated">
  2378. <param name="map" type="java.util.Map"/>
  2379. </method>
  2380. <method name="getLabelsToNodes" return="java.util.Map"
  2381. abstract="true" native="false" synchronized="false"
  2382. static="false" final="false" visibility="public"
  2383. deprecated="not deprecated">
  2384. </method>
  2385. </class>
  2386. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse -->
  2387. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  2388. <class name="GetNewApplicationRequest" extends="java.lang.Object"
  2389. abstract="true"
  2390. static="false" final="false" visibility="public"
  2391. deprecated="not deprecated">
  2392. <constructor name="GetNewApplicationRequest"
  2393. static="false" final="false" visibility="public"
  2394. deprecated="not deprecated">
  2395. </constructor>
  2396. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
  2397. abstract="false" native="false" synchronized="false"
  2398. static="true" final="false" visibility="public"
  2399. deprecated="not deprecated">
  2400. </method>
  2401. <doc>
  2402. <![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
  2403. submitting an application.</p>
  2404. <p>Currently, this is empty.</p>
  2405. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  2406. </doc>
  2407. </class>
  2408. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
  2409. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  2410. <class name="GetNewApplicationResponse" extends="java.lang.Object"
  2411. abstract="true"
  2412. static="false" final="false" visibility="public"
  2413. deprecated="not deprecated">
  2414. <constructor name="GetNewApplicationResponse"
  2415. static="false" final="false" visibility="public"
  2416. deprecated="not deprecated">
  2417. </constructor>
  2418. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2419. abstract="true" native="false" synchronized="false"
  2420. static="false" final="false" visibility="public"
  2421. deprecated="not deprecated">
  2422. <doc>
  2423. <![CDATA[Get the <em>new</em> <code>ApplicationId</code> allocated by the
  2424. <code>ResourceManager</code>.
  2425. @return <em>new</em> <code>ApplicationId</code> allocated by the
  2426. <code>ResourceManager</code>]]>
  2427. </doc>
  2428. </method>
  2429. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  2430. abstract="true" native="false" synchronized="false"
  2431. static="false" final="false" visibility="public"
  2432. deprecated="not deprecated">
  2433. <doc>
  2434. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  2435. <code>ResourceManager</code> in the cluster.
  2436. @return maximum capability of allocated resources in the cluster]]>
  2437. </doc>
  2438. </method>
  2439. <doc>
  2440. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
  2441. a request to get a new {@link ApplicationId} for submitting applications.</p>
  2442. <p>Clients can submit an application with the returned
  2443. {@link ApplicationId}.</p>
  2444. @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
  2445. </doc>
  2446. </class>
  2447. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
  2448. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest -->
  2449. <class name="GetNodesToLabelsRequest" extends="java.lang.Object"
  2450. abstract="true"
  2451. static="false" final="false" visibility="public"
  2452. deprecated="not deprecated">
  2453. <constructor name="GetNodesToLabelsRequest"
  2454. static="false" final="false" visibility="public"
  2455. deprecated="not deprecated">
  2456. </constructor>
  2457. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"
  2458. abstract="false" native="false" synchronized="false"
  2459. static="true" final="false" visibility="public"
  2460. deprecated="not deprecated">
  2461. </method>
  2462. </class>
  2463. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest -->
  2464. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse -->
  2465. <class name="GetNodesToLabelsResponse" extends="java.lang.Object"
  2466. abstract="true"
  2467. static="false" final="false" visibility="public"
  2468. deprecated="not deprecated">
  2469. <constructor name="GetNodesToLabelsResponse"
  2470. static="false" final="false" visibility="public"
  2471. deprecated="not deprecated">
  2472. </constructor>
  2473. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
  2474. abstract="false" native="false" synchronized="false"
  2475. static="true" final="false" visibility="public"
  2476. deprecated="not deprecated">
  2477. <param name="map" type="java.util.Map"/>
  2478. </method>
  2479. <method name="setNodeToLabels"
  2480. abstract="true" native="false" synchronized="false"
  2481. static="false" final="false" visibility="public"
  2482. deprecated="not deprecated">
  2483. <param name="map" type="java.util.Map"/>
  2484. </method>
  2485. <method name="getNodeToLabels" return="java.util.Map"
  2486. abstract="true" native="false" synchronized="false"
  2487. static="false" final="false" visibility="public"
  2488. deprecated="not deprecated">
  2489. </method>
  2490. </class>
  2491. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse -->
  2492. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  2493. <class name="GetQueueInfoRequest" extends="java.lang.Object"
  2494. abstract="true"
  2495. static="false" final="false" visibility="public"
  2496. deprecated="not deprecated">
  2497. <constructor name="GetQueueInfoRequest"
  2498. static="false" final="false" visibility="public"
  2499. deprecated="not deprecated">
  2500. </constructor>
  2501. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"
  2502. abstract="false" native="false" synchronized="false"
  2503. static="true" final="false" visibility="public"
  2504. deprecated="not deprecated">
  2505. <param name="queueName" type="java.lang.String"/>
  2506. <param name="includeApplications" type="boolean"/>
  2507. <param name="includeChildQueues" type="boolean"/>
  2508. <param name="recursive" type="boolean"/>
  2509. </method>
  2510. <method name="getQueueName" return="java.lang.String"
  2511. abstract="true" native="false" synchronized="false"
  2512. static="false" final="false" visibility="public"
  2513. deprecated="not deprecated">
  2514. <doc>
  2515. <![CDATA[Get the <em>queue name</em> for which to get queue information.
  2516. @return <em>queue name</em> for which to get queue information]]>
  2517. </doc>
  2518. </method>
  2519. <method name="setQueueName"
  2520. abstract="true" native="false" synchronized="false"
  2521. static="false" final="false" visibility="public"
  2522. deprecated="not deprecated">
  2523. <param name="queueName" type="java.lang.String"/>
  2524. <doc>
  2525. <![CDATA[Set the <em>queue name</em> for which to get queue information
  2526. @param queueName <em>queue name</em> for which to get queue information]]>
  2527. </doc>
  2528. </method>
  2529. <method name="getIncludeApplications" return="boolean"
  2530. abstract="true" native="false" synchronized="false"
  2531. static="false" final="false" visibility="public"
  2532. deprecated="not deprecated">
  2533. <doc>
  2534. <![CDATA[Is information about <em>active applications</em> required?
  2535. @return <code>true</code> if applications' information is to be included,
  2536. else <code>false</code>]]>
  2537. </doc>
  2538. </method>
  2539. <method name="setIncludeApplications"
  2540. abstract="true" native="false" synchronized="false"
  2541. static="false" final="false" visibility="public"
  2542. deprecated="not deprecated">
  2543. <param name="includeApplications" type="boolean"/>
  2544. <doc>
  2545. <![CDATA[Should we get fetch information about <em>active applications</em>?
  2546. @param includeApplications fetch information about <em>active
  2547. applications</em>?]]>
  2548. </doc>
  2549. </method>
  2550. <method name="getIncludeChildQueues" return="boolean"
  2551. abstract="true" native="false" synchronized="false"
  2552. static="false" final="false" visibility="public"
  2553. deprecated="not deprecated">
  2554. <doc>
  2555. <![CDATA[Is information about <em>child queues</em> required?
  2556. @return <code>true</code> if information about child queues is required,
  2557. else <code>false</code>]]>
  2558. </doc>
  2559. </method>
  2560. <method name="setIncludeChildQueues"
  2561. abstract="true" native="false" synchronized="false"
  2562. static="false" final="false" visibility="public"
  2563. deprecated="not deprecated">
  2564. <param name="includeChildQueues" type="boolean"/>
  2565. <doc>
  2566. <![CDATA[Should we fetch information about <em>child queues</em>?
  2567. @param includeChildQueues fetch information about <em>child queues</em>?]]>
  2568. </doc>
  2569. </method>
  2570. <method name="getRecursive" return="boolean"
  2571. abstract="true" native="false" synchronized="false"
  2572. static="false" final="false" visibility="public"
  2573. deprecated="not deprecated">
  2574. <doc>
  2575. <![CDATA[Is information on the entire <em>child queue hierarchy</em> required?
  2576. @return <code>true</code> if information about entire hierarchy is
  2577. required, <code>false</code> otherwise]]>
  2578. </doc>
  2579. </method>
  2580. <method name="setRecursive"
  2581. abstract="true" native="false" synchronized="false"
  2582. static="false" final="false" visibility="public"
  2583. deprecated="not deprecated">
  2584. <param name="recursive" type="boolean"/>
  2585. <doc>
  2586. <![CDATA[Should we fetch information on the entire <em>child queue hierarchy</em>?
  2587. @param recursive fetch information on the entire <em>child queue
  2588. hierarchy</em>?]]>
  2589. </doc>
  2590. </method>
  2591. <doc>
  2592. <![CDATA[<p>The request sent by clients to get <em>queue information</em>
  2593. from the <code>ResourceManager</code>.</p>
  2594. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  2595. </doc>
  2596. </class>
  2597. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
  2598. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  2599. <class name="GetQueueInfoResponse" extends="java.lang.Object"
  2600. abstract="true"
  2601. static="false" final="false" visibility="public"
  2602. deprecated="not deprecated">
  2603. <constructor name="GetQueueInfoResponse"
  2604. static="false" final="false" visibility="public"
  2605. deprecated="not deprecated">
  2606. </constructor>
  2607. <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.records.QueueInfo"
  2608. abstract="true" native="false" synchronized="false"
  2609. static="false" final="false" visibility="public"
  2610. deprecated="not deprecated">
  2611. <doc>
  2612. <![CDATA[Get the <code>QueueInfo</code> for the specified queue.
  2613. @return <code>QueueInfo</code> for the specified queue]]>
  2614. </doc>
  2615. </method>
  2616. <doc>
  2617. <![CDATA[The response sent by the {@code ResourceManager} to a client
  2618. requesting information about queues in the system.
  2619. <p>
  2620. The response includes a {@link QueueInfo} which has details such as
  2621. queue name, used/total capacities, running applications, child queues etc.
  2622. @see QueueInfo
  2623. @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
  2624. </doc>
  2625. </class>
  2626. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
  2627. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  2628. <class name="GetQueueUserAclsInfoRequest" extends="java.lang.Object"
  2629. abstract="true"
  2630. static="false" final="false" visibility="public"
  2631. deprecated="not deprecated">
  2632. <constructor name="GetQueueUserAclsInfoRequest"
  2633. static="false" final="false" visibility="public"
  2634. deprecated="not deprecated">
  2635. </constructor>
  2636. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"
  2637. abstract="false" native="false" synchronized="false"
  2638. static="true" final="false" visibility="public"
  2639. deprecated="not deprecated">
  2640. </method>
  2641. <doc>
  2642. <![CDATA[<p>The request sent by clients to the <code>ResourceManager</code> to
  2643. get queue acls for the <em>current user</em>.</p>
  2644. <p>Currently, this is empty.</p>
  2645. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  2646. </doc>
  2647. </class>
  2648. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
  2649. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  2650. <class name="GetQueueUserAclsInfoResponse" extends="java.lang.Object"
  2651. abstract="true"
  2652. static="false" final="false" visibility="public"
  2653. deprecated="not deprecated">
  2654. <constructor name="GetQueueUserAclsInfoResponse"
  2655. static="false" final="false" visibility="public"
  2656. deprecated="not deprecated">
  2657. </constructor>
  2658. <method name="getUserAclsInfoList" return="java.util.List"
  2659. abstract="true" native="false" synchronized="false"
  2660. static="false" final="false" visibility="public"
  2661. deprecated="not deprecated">
  2662. <doc>
  2663. <![CDATA[Get the <code>QueueUserACLInfo</code> per queue for the user.
  2664. @return <code>QueueUserACLInfo</code> per queue for the user]]>
  2665. </doc>
  2666. </method>
  2667. <doc>
  2668. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to clients
  2669. seeking queue acls for the user.</p>
  2670. <p>The response contains a list of {@link QueueUserACLInfo} which
  2671. provides information about {@link QueueACL} per queue.</p>
  2672. @see QueueACL
  2673. @see QueueUserACLInfo
  2674. @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
  2675. </doc>
  2676. </class>
  2677. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
  2678. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  2679. <class name="KillApplicationRequest" extends="java.lang.Object"
  2680. abstract="true"
  2681. static="false" final="false" visibility="public"
  2682. deprecated="not deprecated">
  2683. <constructor name="KillApplicationRequest"
  2684. static="false" final="false" visibility="public"
  2685. deprecated="not deprecated">
  2686. </constructor>
  2687. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"
  2688. abstract="false" native="false" synchronized="false"
  2689. static="true" final="false" visibility="public"
  2690. deprecated="not deprecated">
  2691. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2692. </method>
  2693. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2694. abstract="true" native="false" synchronized="false"
  2695. static="false" final="false" visibility="public"
  2696. deprecated="not deprecated">
  2697. <doc>
  2698. <![CDATA[Get the <code>ApplicationId</code> of the application to be aborted.
  2699. @return <code>ApplicationId</code> of the application to be aborted]]>
  2700. </doc>
  2701. </method>
  2702. <method name="setApplicationId"
  2703. abstract="true" native="false" synchronized="false"
  2704. static="false" final="false" visibility="public"
  2705. deprecated="not deprecated">
  2706. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2707. </method>
  2708. <doc>
  2709. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  2710. to abort a submitted application.</p>
  2711. <p>The request includes the {@link ApplicationId} of the application to be
  2712. aborted.</p>
  2713. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  2714. </doc>
  2715. </class>
  2716. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
  2717. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  2718. <class name="KillApplicationResponse" extends="java.lang.Object"
  2719. abstract="true"
  2720. static="false" final="false" visibility="public"
  2721. deprecated="not deprecated">
  2722. <constructor name="KillApplicationResponse"
  2723. static="false" final="false" visibility="public"
  2724. deprecated="not deprecated">
  2725. </constructor>
  2726. <method name="getIsKillCompleted" return="boolean"
  2727. abstract="true" native="false" synchronized="false"
  2728. static="false" final="false" visibility="public"
  2729. deprecated="not deprecated">
  2730. <doc>
  2731. <![CDATA[Get the flag which indicates that the process of killing application is completed or not.]]>
  2732. </doc>
  2733. </method>
  2734. <doc>
  2735. <![CDATA[The response sent by the <code>ResourceManager</code> to the client aborting
  2736. a submitted application.
  2737. <p>
  2738. The response, includes:
  2739. <ul>
  2740. <li>
  2741. A flag which indicates that the process of killing the application is
  2742. completed or not.
  2743. </li>
  2744. </ul>
  2745. Note: user is recommended to wait until this flag becomes true, otherwise if
  2746. the <code>ResourceManager</code> crashes before the process of killing the
  2747. application is completed, the <code>ResourceManager</code> may retry this
  2748. application on recovery.
  2749. @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
  2750. </doc>
  2751. </class>
  2752. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
  2753. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  2754. <class name="MoveApplicationAcrossQueuesRequest" extends="java.lang.Object"
  2755. abstract="true"
  2756. static="false" final="false" visibility="public"
  2757. deprecated="not deprecated">
  2758. <constructor name="MoveApplicationAcrossQueuesRequest"
  2759. static="false" final="false" visibility="public"
  2760. deprecated="not deprecated">
  2761. </constructor>
  2762. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"
  2763. abstract="false" native="false" synchronized="false"
  2764. static="true" final="false" visibility="public"
  2765. deprecated="not deprecated">
  2766. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2767. <param name="queue" type="java.lang.String"/>
  2768. </method>
  2769. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2770. abstract="true" native="false" synchronized="false"
  2771. static="false" final="false" visibility="public"
  2772. deprecated="not deprecated">
  2773. <doc>
  2774. <![CDATA[Get the <code>ApplicationId</code> of the application to be moved.
  2775. @return <code>ApplicationId</code> of the application to be moved]]>
  2776. </doc>
  2777. </method>
  2778. <method name="setApplicationId"
  2779. abstract="true" native="false" synchronized="false"
  2780. static="false" final="false" visibility="public"
  2781. deprecated="not deprecated">
  2782. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2783. <doc>
  2784. <![CDATA[Set the <code>ApplicationId</code> of the application to be moved.
  2785. @param appId <code>ApplicationId</code> of the application to be moved]]>
  2786. </doc>
  2787. </method>
  2788. <method name="getTargetQueue" return="java.lang.String"
  2789. abstract="true" native="false" synchronized="false"
  2790. static="false" final="false" visibility="public"
  2791. deprecated="not deprecated">
  2792. <doc>
  2793. <![CDATA[Get the queue to place the application in.
  2794. @return the name of the queue to place the application in]]>
  2795. </doc>
  2796. </method>
  2797. <method name="setTargetQueue"
  2798. abstract="true" native="false" synchronized="false"
  2799. static="false" final="false" visibility="public"
  2800. deprecated="not deprecated">
  2801. <param name="queue" type="java.lang.String"/>
  2802. <doc>
  2803. <![CDATA[Get the queue to place the application in.
  2804. @param queue the name of the queue to place the application in]]>
  2805. </doc>
  2806. </method>
  2807. <doc>
  2808. <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
  2809. to move a submitted application to a different queue.</p>
  2810. <p>The request includes the {@link ApplicationId} of the application to be
  2811. moved and the queue to place it in.</p>
  2812. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  2813. </doc>
  2814. </class>
  2815. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
  2816. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  2817. <class name="MoveApplicationAcrossQueuesResponse" extends="java.lang.Object"
  2818. abstract="false"
  2819. static="false" final="false" visibility="public"
  2820. deprecated="not deprecated">
  2821. <constructor name="MoveApplicationAcrossQueuesResponse"
  2822. static="false" final="false" visibility="public"
  2823. deprecated="not deprecated">
  2824. </constructor>
  2825. <doc>
  2826. <![CDATA[<p>
  2827. The response sent by the <code>ResourceManager</code> to the client moving
  2828. a submitted application to a different queue.
  2829. </p>
  2830. <p>
  2831. A response without exception means that the move has completed successfully.
  2832. </p>
  2833. @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
  2834. </doc>
  2835. </class>
  2836. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
  2837. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  2838. <class name="RegisterApplicationMasterRequest" extends="java.lang.Object"
  2839. abstract="true"
  2840. static="false" final="false" visibility="public"
  2841. deprecated="not deprecated">
  2842. <constructor name="RegisterApplicationMasterRequest"
  2843. static="false" final="false" visibility="public"
  2844. deprecated="not deprecated">
  2845. </constructor>
  2846. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"
  2847. abstract="false" native="false" synchronized="false"
  2848. static="true" final="false" visibility="public"
  2849. deprecated="not deprecated">
  2850. <param name="host" type="java.lang.String"/>
  2851. <param name="port" type="int"/>
  2852. <param name="trackingUrl" type="java.lang.String"/>
  2853. <doc>
  2854. <![CDATA[Create a new instance of <code>RegisterApplicationMasterRequest</code>.
  2855. If <em>port, trackingUrl</em> is not used, use the following default value:
  2856. <ul>
  2857. <li>port: -1</li>
  2858. <li>trackingUrl: null</li>
  2859. </ul>
  2860. The port is allowed to be any integer larger than or equal to -1.
  2861. @return the new instance of <code>RegisterApplicationMasterRequest</code>]]>
  2862. </doc>
  2863. </method>
  2864. <method name="getHost" return="java.lang.String"
  2865. abstract="true" native="false" synchronized="false"
  2866. static="false" final="false" visibility="public"
  2867. deprecated="not deprecated">
  2868. <doc>
  2869. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code> is
  2870. running.
  2871. @return <em>host</em> on which the <code>ApplicationMaster</code> is running]]>
  2872. </doc>
  2873. </method>
  2874. <method name="setHost"
  2875. abstract="true" native="false" synchronized="false"
  2876. static="false" final="false" visibility="public"
  2877. deprecated="not deprecated">
  2878. <param name="host" type="java.lang.String"/>
  2879. <doc>
  2880. <![CDATA[Set the <em>host</em> on which the <code>ApplicationMaster</code> is
  2881. running.
  2882. @param host <em>host</em> on which the <code>ApplicationMaster</code>
  2883. is running]]>
  2884. </doc>
  2885. </method>
  2886. <method name="getRpcPort" return="int"
  2887. abstract="true" native="false" synchronized="false"
  2888. static="false" final="false" visibility="public"
  2889. deprecated="not deprecated">
  2890. <doc>
  2891. <![CDATA[Get the <em>RPC port</em> on which the {@code ApplicationMaster} is
  2892. responding.
  2893. @return the <em>RPC port</em> on which the {@code ApplicationMaster}
  2894. is responding]]>
  2895. </doc>
  2896. </method>
  2897. <method name="setRpcPort"
  2898. abstract="true" native="false" synchronized="false"
  2899. static="false" final="false" visibility="public"
  2900. deprecated="not deprecated">
  2901. <param name="port" type="int"/>
  2902. <doc>
  2903. <![CDATA[Set the <em>RPC port</em> on which the {@code ApplicationMaster} is
  2904. responding.
  2905. @param port <em>RPC port</em> on which the {@code ApplicationMaster}
  2906. is responding]]>
  2907. </doc>
  2908. </method>
  2909. <method name="getTrackingUrl" return="java.lang.String"
  2910. abstract="true" native="false" synchronized="false"
  2911. static="false" final="false" visibility="public"
  2912. deprecated="not deprecated">
  2913. <doc>
  2914. <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
  2915. This url if contains scheme then that will be used by resource manager
  2916. web application proxy otherwise it will default to http.
  2917. @return <em>tracking URL</em> for the <code>ApplicationMaster</code>]]>
  2918. </doc>
  2919. </method>
  2920. <method name="setTrackingUrl"
  2921. abstract="true" native="false" synchronized="false"
  2922. static="false" final="false" visibility="public"
  2923. deprecated="not deprecated">
  2924. <param name="trackingUrl" type="java.lang.String"/>
  2925. <doc>
  2926. <![CDATA[Set the <em>tracking URL</em>for the <code>ApplicationMaster</code> while
  2927. it is running. This is the web-URL to which ResourceManager or
  2928. web-application proxy will redirect client/users while the application and
  2929. the <code>ApplicationMaster</code> are still running.
  2930. <p>
  2931. If the passed url has a scheme then that will be used by the
  2932. ResourceManager and web-application proxy, otherwise the scheme will
  2933. default to http.
  2934. </p>
  2935. <p>
  2936. Empty, null, "N/A" strings are all valid besides a real URL. In case an url
  2937. isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
  2938. <p>
  2939. @param trackingUrl
  2940. <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
  2941. </doc>
  2942. </method>
  2943. <doc>
  2944. <![CDATA[The request sent by the {@code ApplicationMaster} to {@code ResourceManager}
  2945. on registration.
  2946. <p>
  2947. The registration includes details such as:
  2948. <ul>
  2949. <li>Hostname on which the AM is running.</li>
  2950. <li>RPC Port</li>
  2951. <li>Tracking URL</li>
  2952. </ul>
  2953. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  2954. </doc>
  2955. </class>
  2956. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
  2957. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  2958. <class name="RegisterApplicationMasterResponse" extends="java.lang.Object"
  2959. abstract="true"
  2960. static="false" final="false" visibility="public"
  2961. deprecated="not deprecated">
  2962. <constructor name="RegisterApplicationMasterResponse"
  2963. static="false" final="false" visibility="public"
  2964. deprecated="not deprecated">
  2965. </constructor>
  2966. <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  2967. abstract="true" native="false" synchronized="false"
  2968. static="false" final="false" visibility="public"
  2969. deprecated="not deprecated">
  2970. <doc>
  2971. <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
  2972. <code>ResourceManager</code> in the cluster.
  2973. @return maximum capability of allocated resources in the cluster]]>
  2974. </doc>
  2975. </method>
  2976. <method name="getApplicationACLs" return="java.util.Map"
  2977. abstract="true" native="false" synchronized="false"
  2978. static="false" final="false" visibility="public"
  2979. deprecated="not deprecated">
  2980. <doc>
  2981. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  2982. @return all the <code>ApplicationACL</code>s]]>
  2983. </doc>
  2984. </method>
  2985. <method name="getClientToAMTokenMasterKey" return="java.nio.ByteBuffer"
  2986. abstract="true" native="false" synchronized="false"
  2987. static="false" final="false" visibility="public"
  2988. deprecated="not deprecated">
  2989. <doc>
  2990. <![CDATA[<p>Get ClientToAMToken master key.</p>
  2991. <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code>
  2992. by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse}
  2993. , used to verify corresponding ClientToAMToken.</p>]]>
  2994. </doc>
  2995. </method>
  2996. <method name="setClientToAMTokenMasterKey"
  2997. abstract="true" native="false" synchronized="false"
  2998. static="false" final="false" visibility="public"
  2999. deprecated="not deprecated">
  3000. <param name="key" type="java.nio.ByteBuffer"/>
  3001. <doc>
  3002. <![CDATA[Set ClientToAMToken master key.]]>
  3003. </doc>
  3004. </method>
  3005. <method name="getQueue" return="java.lang.String"
  3006. abstract="true" native="false" synchronized="false"
  3007. static="false" final="false" visibility="public"
  3008. deprecated="not deprecated">
  3009. <doc>
  3010. <![CDATA[<p>Get the queue that the application was placed in.<p>]]>
  3011. </doc>
  3012. </method>
  3013. <method name="setQueue"
  3014. abstract="true" native="false" synchronized="false"
  3015. static="false" final="false" visibility="public"
  3016. deprecated="not deprecated">
  3017. <param name="queue" type="java.lang.String"/>
  3018. <doc>
  3019. <![CDATA[<p>Set the queue that the application was placed in.<p>]]>
  3020. </doc>
  3021. </method>
  3022. <method name="getContainersFromPreviousAttempts" return="java.util.List"
  3023. abstract="true" native="false" synchronized="false"
  3024. static="false" final="false" visibility="public"
  3025. deprecated="not deprecated">
  3026. <doc>
  3027. <![CDATA[<p>
  3028. Get the list of running containers as viewed by
  3029. <code>ResourceManager</code> from previous application attempts.
  3030. </p>
  3031. @return the list of running containers as viewed by
  3032. <code>ResourceManager</code> from previous application attempts
  3033. @see RegisterApplicationMasterResponse#getNMTokensFromPreviousAttempts()]]>
  3034. </doc>
  3035. </method>
  3036. <method name="getNMTokensFromPreviousAttempts" return="java.util.List"
  3037. abstract="true" native="false" synchronized="false"
  3038. static="false" final="false" visibility="public"
  3039. deprecated="not deprecated">
  3040. <doc>
  3041. <![CDATA[Get the list of NMTokens for communicating with the NMs where the
  3042. containers of previous application attempts are running.
  3043. @return the list of NMTokens for communicating with the NMs where the
  3044. containers of previous application attempts are running.
  3045. @see RegisterApplicationMasterResponse#getContainersFromPreviousAttempts()]]>
  3046. </doc>
  3047. </method>
  3048. <method name="getSchedulerResourceTypes" return="java.util.EnumSet"
  3049. abstract="true" native="false" synchronized="false"
  3050. static="false" final="false" visibility="public"
  3051. deprecated="not deprecated">
  3052. <doc>
  3053. <![CDATA[Get a set of the resource types considered by the scheduler.
  3054. @return a Map of RM settings]]>
  3055. </doc>
  3056. </method>
  3057. <doc>
  3058. <![CDATA[The response sent by the {@code ResourceManager} to a new
  3059. {@code ApplicationMaster} on registration.
  3060. <p>
  3061. The response contains critical details such as:
  3062. <ul>
  3063. <li>Maximum capability for allocated resources in the cluster.</li>
  3064. <li>{@code ApplicationACL}s for the application.</li>
  3065. <li>ClientToAMToken master key.</li>
  3066. </ul>
  3067. @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
  3068. </doc>
  3069. </class>
  3070. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
  3071. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  3072. <class name="ReleaseSharedCacheResourceRequest" extends="java.lang.Object"
  3073. abstract="true"
  3074. static="false" final="false" visibility="public"
  3075. deprecated="not deprecated">
  3076. <constructor name="ReleaseSharedCacheResourceRequest"
  3077. static="false" final="false" visibility="public"
  3078. deprecated="not deprecated">
  3079. </constructor>
  3080. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3081. abstract="true" native="false" synchronized="false"
  3082. static="false" final="false" visibility="public"
  3083. deprecated="not deprecated">
  3084. <doc>
  3085. <![CDATA[Get the <code>ApplicationId</code> of the resource to be released.
  3086. @return <code>ApplicationId</code>]]>
  3087. </doc>
  3088. </method>
  3089. <method name="setAppId"
  3090. abstract="true" native="false" synchronized="false"
  3091. static="false" final="false" visibility="public"
  3092. deprecated="not deprecated">
  3093. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3094. <doc>
  3095. <![CDATA[Set the <code>ApplicationId</code> of the resource to be released.
  3096. @param id <code>ApplicationId</code>]]>
  3097. </doc>
  3098. </method>
  3099. <method name="getResourceKey" return="java.lang.String"
  3100. abstract="true" native="false" synchronized="false"
  3101. static="false" final="false" visibility="public"
  3102. deprecated="not deprecated">
  3103. <doc>
  3104. <![CDATA[Get the <code>key</code> of the resource to be released.
  3105. @return <code>key</code>]]>
  3106. </doc>
  3107. </method>
  3108. <method name="setResourceKey"
  3109. abstract="true" native="false" synchronized="false"
  3110. static="false" final="false" visibility="public"
  3111. deprecated="not deprecated">
  3112. <param name="key" type="java.lang.String"/>
  3113. <doc>
  3114. <![CDATA[Set the <code>key</code> of the resource to be released.
  3115. @param key unique identifier for the resource]]>
  3116. </doc>
  3117. </method>
  3118. <doc>
  3119. <![CDATA[<p>The request from clients to release a resource in the shared cache.</p>]]>
  3120. </doc>
  3121. </class>
  3122. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
  3123. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  3124. <class name="ReleaseSharedCacheResourceResponse" extends="java.lang.Object"
  3125. abstract="true"
  3126. static="false" final="false" visibility="public"
  3127. deprecated="not deprecated">
  3128. <constructor name="ReleaseSharedCacheResourceResponse"
  3129. static="false" final="false" visibility="public"
  3130. deprecated="not deprecated">
  3131. </constructor>
  3132. <doc>
  3133. <![CDATA[<p>
  3134. The response to clients from the <code>SharedCacheManager</code> when
  3135. releasing a resource in the shared cache.
  3136. </p>
  3137. <p>
  3138. Currently, this is empty.
  3139. </p>]]>
  3140. </doc>
  3141. </class>
  3142. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
  3143. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  3144. <class name="ReservationDeleteRequest" extends="java.lang.Object"
  3145. abstract="true"
  3146. static="false" final="false" visibility="public"
  3147. deprecated="not deprecated">
  3148. <constructor name="ReservationDeleteRequest"
  3149. static="false" final="false" visibility="public"
  3150. deprecated="not deprecated">
  3151. </constructor>
  3152. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"
  3153. abstract="false" native="false" synchronized="false"
  3154. static="true" final="false" visibility="public"
  3155. deprecated="not deprecated">
  3156. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3157. </method>
  3158. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3159. abstract="true" native="false" synchronized="false"
  3160. static="false" final="false" visibility="public"
  3161. deprecated="not deprecated">
  3162. <doc>
  3163. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3164. allocation in the scheduler (between start and end time of this
  3165. reservation)
  3166. @return the {@link ReservationId} representing the unique id of the
  3167. corresponding reserved resource allocation in the scheduler]]>
  3168. </doc>
  3169. </method>
  3170. <method name="setReservationId"
  3171. abstract="true" native="false" synchronized="false"
  3172. static="false" final="false" visibility="public"
  3173. deprecated="not deprecated">
  3174. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3175. <doc>
  3176. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  3177. allocation in the scheduler (between start and end time of this
  3178. reservation)
  3179. @param reservationId the {@link ReservationId} representing the the unique
  3180. id of the corresponding reserved resource allocation in the
  3181. scheduler]]>
  3182. </doc>
  3183. </method>
  3184. <doc>
  3185. <![CDATA[{@link ReservationDeleteRequest} captures the set of requirements the user
  3186. has to delete an existing reservation.
  3187. @see ReservationDefinition]]>
  3188. </doc>
  3189. </class>
  3190. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
  3191. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  3192. <class name="ReservationDeleteResponse" extends="java.lang.Object"
  3193. abstract="true"
  3194. static="false" final="false" visibility="public"
  3195. deprecated="not deprecated">
  3196. <constructor name="ReservationDeleteResponse"
  3197. static="false" final="false" visibility="public"
  3198. deprecated="not deprecated">
  3199. </constructor>
  3200. <doc>
  3201. <![CDATA[{@link ReservationDeleteResponse} contains the answer of the admission
  3202. control system in the {@code ResourceManager} to a reservation delete
  3203. operation. Currently response is empty if the operation was successful, if
  3204. not an exception reporting reason for a failure.
  3205. @see ReservationDefinition]]>
  3206. </doc>
  3207. </class>
  3208. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
  3209. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  3210. <class name="ReservationSubmissionRequest" extends="java.lang.Object"
  3211. abstract="true"
  3212. static="false" final="false" visibility="public"
  3213. deprecated="not deprecated">
  3214. <constructor name="ReservationSubmissionRequest"
  3215. static="false" final="false" visibility="public"
  3216. deprecated="not deprecated">
  3217. </constructor>
  3218. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"
  3219. abstract="false" native="false" synchronized="false"
  3220. static="true" final="false" visibility="public"
  3221. deprecated="not deprecated">
  3222. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3223. <param name="queueName" type="java.lang.String"/>
  3224. </method>
  3225. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  3226. abstract="true" native="false" synchronized="false"
  3227. static="false" final="false" visibility="public"
  3228. deprecated="not deprecated">
  3229. <doc>
  3230. <![CDATA[Get the {@link ReservationDefinition} representing the user constraints for
  3231. this reservation
  3232. @return the reservation definition representing user constraints]]>
  3233. </doc>
  3234. </method>
  3235. <method name="setReservationDefinition"
  3236. abstract="true" native="false" synchronized="false"
  3237. static="false" final="false" visibility="public"
  3238. deprecated="not deprecated">
  3239. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3240. <doc>
  3241. <![CDATA[Set the {@link ReservationDefinition} representing the user constraints for
  3242. this reservation
  3243. @param reservationDefinition the reservation request representing the
  3244. reservation]]>
  3245. </doc>
  3246. </method>
  3247. <method name="getQueue" return="java.lang.String"
  3248. abstract="true" native="false" synchronized="false"
  3249. static="false" final="false" visibility="public"
  3250. deprecated="not deprecated">
  3251. <doc>
  3252. <![CDATA[Get the name of the {@code Plan} that corresponds to the name of the
  3253. {@link QueueInfo} in the scheduler to which the reservation will be
  3254. submitted to.
  3255. @return the name of the {@code Plan} that corresponds to the name of the
  3256. {@link QueueInfo} in the scheduler to which the reservation will be
  3257. submitted to]]>
  3258. </doc>
  3259. </method>
  3260. <method name="setQueue"
  3261. abstract="true" native="false" synchronized="false"
  3262. static="false" final="false" visibility="public"
  3263. deprecated="not deprecated">
  3264. <param name="queueName" type="java.lang.String"/>
  3265. <doc>
  3266. <![CDATA[Set the name of the {@code Plan} that corresponds to the name of the
  3267. {@link QueueInfo} in the scheduler to which the reservation will be
  3268. submitted to
  3269. @param queueName the name of the parent {@code Plan} that corresponds to
  3270. the name of the {@link QueueInfo} in the scheduler to which the
  3271. reservation will be submitted to]]>
  3272. </doc>
  3273. </method>
  3274. <doc>
  3275. <![CDATA[{@link ReservationSubmissionRequest} captures the set of requirements the
  3276. user has to create a reservation.
  3277. @see ReservationDefinition]]>
  3278. </doc>
  3279. </class>
  3280. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
  3281. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  3282. <class name="ReservationSubmissionResponse" extends="java.lang.Object"
  3283. abstract="true"
  3284. static="false" final="false" visibility="public"
  3285. deprecated="not deprecated">
  3286. <constructor name="ReservationSubmissionResponse"
  3287. static="false" final="false" visibility="public"
  3288. deprecated="not deprecated">
  3289. </constructor>
  3290. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3291. abstract="true" native="false" synchronized="false"
  3292. static="false" final="false" visibility="public"
  3293. deprecated="not deprecated">
  3294. <doc>
  3295. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3296. allocation in the scheduler (between start and end time of this
  3297. reservation)
  3298. @return the {@link ReservationId} representing the unique id of the
  3299. corresponding reserved resource allocation in the scheduler]]>
  3300. </doc>
  3301. </method>
  3302. <doc>
  3303. <![CDATA[{@link ReservationSubmissionResponse} contains the answer of the admission
  3304. control system in the {@code ResourceManager} to a reservation create
  3305. operation. Response contains a {@link ReservationId} if the operation was
  3306. successful, if not an exception reporting reason for a failure.
  3307. @see ReservationDefinition]]>
  3308. </doc>
  3309. </class>
  3310. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
  3311. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  3312. <class name="ReservationUpdateRequest" extends="java.lang.Object"
  3313. abstract="true"
  3314. static="false" final="false" visibility="public"
  3315. deprecated="not deprecated">
  3316. <constructor name="ReservationUpdateRequest"
  3317. static="false" final="false" visibility="public"
  3318. deprecated="not deprecated">
  3319. </constructor>
  3320. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"
  3321. abstract="false" native="false" synchronized="false"
  3322. static="true" final="false" visibility="public"
  3323. deprecated="not deprecated">
  3324. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3325. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3326. </method>
  3327. <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  3328. abstract="true" native="false" synchronized="false"
  3329. static="false" final="false" visibility="public"
  3330. deprecated="not deprecated">
  3331. <doc>
  3332. <![CDATA[Get the {@link ReservationDefinition} representing the updated user
  3333. constraints for this reservation
  3334. @return the reservation definition representing user constraints]]>
  3335. </doc>
  3336. </method>
  3337. <method name="setReservationDefinition"
  3338. abstract="true" native="false" synchronized="false"
  3339. static="false" final="false" visibility="public"
  3340. deprecated="not deprecated">
  3341. <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
  3342. <doc>
  3343. <![CDATA[Set the {@link ReservationDefinition} representing the updated user
  3344. constraints for this reservation
  3345. @param reservationDefinition the reservation request representing the
  3346. reservation]]>
  3347. </doc>
  3348. </method>
  3349. <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  3350. abstract="true" native="false" synchronized="false"
  3351. static="false" final="false" visibility="public"
  3352. deprecated="not deprecated">
  3353. <doc>
  3354. <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
  3355. allocation in the scheduler (between start and end time of this
  3356. reservation)
  3357. @return the {@link ReservationId} representing the unique id of the
  3358. corresponding reserved resource allocation in the scheduler]]>
  3359. </doc>
  3360. </method>
  3361. <method name="setReservationId"
  3362. abstract="true" native="false" synchronized="false"
  3363. static="false" final="false" visibility="public"
  3364. deprecated="not deprecated">
  3365. <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  3366. <doc>
  3367. <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
  3368. allocation in the scheduler (between start and end time of this
  3369. reservation)
  3370. @param reservationId the {@link ReservationId} representing the the unique
  3371. id of the corresponding reserved resource allocation in the
  3372. scheduler]]>
  3373. </doc>
  3374. </method>
  3375. <doc>
  3376. <![CDATA[{@link ReservationUpdateRequest} captures the set of requirements the user
  3377. has to update an existing reservation.
  3378. @see ReservationDefinition]]>
  3379. </doc>
  3380. </class>
  3381. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
  3382. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  3383. <class name="ReservationUpdateResponse" extends="java.lang.Object"
  3384. abstract="true"
  3385. static="false" final="false" visibility="public"
  3386. deprecated="not deprecated">
  3387. <constructor name="ReservationUpdateResponse"
  3388. static="false" final="false" visibility="public"
  3389. deprecated="not deprecated">
  3390. </constructor>
  3391. <doc>
  3392. <![CDATA[{@link ReservationUpdateResponse} contains the answer of the admission
  3393. control system in the {@code ResourceManager} to a reservation update
  3394. operation. Currently response is empty if the operation was successful, if
  3395. not an exception reporting reason for a failure.
  3396. @see ReservationDefinition]]>
  3397. </doc>
  3398. </class>
  3399. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
  3400. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  3401. <class name="StartContainerRequest" extends="java.lang.Object"
  3402. abstract="true"
  3403. static="false" final="false" visibility="public"
  3404. deprecated="not deprecated">
  3405. <constructor name="StartContainerRequest"
  3406. static="false" final="false" visibility="public"
  3407. deprecated="not deprecated">
  3408. </constructor>
  3409. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest"
  3410. abstract="false" native="false" synchronized="false"
  3411. static="true" final="false" visibility="public"
  3412. deprecated="not deprecated">
  3413. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  3414. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  3415. </method>
  3416. <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  3417. abstract="true" native="false" synchronized="false"
  3418. static="false" final="false" visibility="public"
  3419. deprecated="not deprecated">
  3420. <doc>
  3421. <![CDATA[Get the <code>ContainerLaunchContext</code> for the container to be started
  3422. by the <code>NodeManager</code>.
  3423. @return <code>ContainerLaunchContext</code> for the container to be started
  3424. by the <code>NodeManager</code>]]>
  3425. </doc>
  3426. </method>
  3427. <method name="setContainerLaunchContext"
  3428. abstract="true" native="false" synchronized="false"
  3429. static="false" final="false" visibility="public"
  3430. deprecated="not deprecated">
  3431. <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  3432. <doc>
  3433. <![CDATA[Set the <code>ContainerLaunchContext</code> for the container to be started
  3434. by the <code>NodeManager</code>
  3435. @param context <code>ContainerLaunchContext</code> for the container to be
  3436. started by the <code>NodeManager</code>]]>
  3437. </doc>
  3438. </method>
  3439. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  3440. abstract="true" native="false" synchronized="false"
  3441. static="false" final="false" visibility="public"
  3442. deprecated="not deprecated">
  3443. <doc>
  3444. <![CDATA[Get the container token to be used for authorization during starting
  3445. container.
  3446. <p>
  3447. Note: {@link NMToken} will be used for authenticating communication with
  3448. {@code NodeManager}.
  3449. @return the container token to be used for authorization during starting
  3450. container.
  3451. @see NMToken
  3452. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3453. </doc>
  3454. </method>
  3455. <method name="setContainerToken"
  3456. abstract="true" native="false" synchronized="false"
  3457. static="false" final="false" visibility="public"
  3458. deprecated="not deprecated">
  3459. <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
  3460. </method>
  3461. <doc>
  3462. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  3463. <code>NodeManager</code> to <em>start</em> a container.</p>
  3464. <p>The <code>ApplicationMaster</code> has to provide details such as
  3465. allocated resource capability, security tokens (if enabled), command
  3466. to be executed to start the container, environment for the process,
  3467. necessary binaries/jar/shared-objects etc. via the
  3468. {@link ContainerLaunchContext}.</p>
  3469. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3470. </doc>
  3471. </class>
  3472. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
  3473. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  3474. <class name="StartContainersRequest" extends="java.lang.Object"
  3475. abstract="true"
  3476. static="false" final="false" visibility="public"
  3477. deprecated="not deprecated">
  3478. <constructor name="StartContainersRequest"
  3479. static="false" final="false" visibility="public"
  3480. deprecated="not deprecated">
  3481. </constructor>
  3482. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"
  3483. abstract="false" native="false" synchronized="false"
  3484. static="true" final="false" visibility="public"
  3485. deprecated="not deprecated">
  3486. <param name="requests" type="java.util.List"/>
  3487. </method>
  3488. <method name="getStartContainerRequests" return="java.util.List"
  3489. abstract="true" native="false" synchronized="false"
  3490. static="false" final="false" visibility="public"
  3491. deprecated="not deprecated">
  3492. <doc>
  3493. <![CDATA[Get a list of {@link StartContainerRequest} to start containers.
  3494. @return a list of {@link StartContainerRequest} to start containers.]]>
  3495. </doc>
  3496. </method>
  3497. <method name="setStartContainerRequests"
  3498. abstract="true" native="false" synchronized="false"
  3499. static="false" final="false" visibility="public"
  3500. deprecated="not deprecated">
  3501. <param name="request" type="java.util.List"/>
  3502. <doc>
  3503. <![CDATA[Set a list of {@link StartContainerRequest} to start containers.
  3504. @param request a list of {@link StartContainerRequest} to start containers]]>
  3505. </doc>
  3506. </method>
  3507. <doc>
  3508. <![CDATA[<p>
  3509. The request which contains a list of {@link StartContainerRequest} sent by
  3510. the <code>ApplicationMaster</code> to the <code>NodeManager</code> to
  3511. <em>start</em> containers.
  3512. </p>
  3513. <p>
  3514. In each {@link StartContainerRequest}, the <code>ApplicationMaster</code> has
  3515. to provide details such as allocated resource capability, security tokens (if
  3516. enabled), command to be executed to start the container, environment for the
  3517. process, necessary binaries/jar/shared-objects etc. via the
  3518. {@link ContainerLaunchContext}.
  3519. </p>
  3520. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3521. </doc>
  3522. </class>
  3523. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
  3524. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  3525. <class name="StartContainersResponse" extends="java.lang.Object"
  3526. abstract="true"
  3527. static="false" final="false" visibility="public"
  3528. deprecated="not deprecated">
  3529. <constructor name="StartContainersResponse"
  3530. static="false" final="false" visibility="public"
  3531. deprecated="not deprecated">
  3532. </constructor>
  3533. <method name="getSuccessfullyStartedContainers" return="java.util.List"
  3534. abstract="true" native="false" synchronized="false"
  3535. static="false" final="false" visibility="public"
  3536. deprecated="not deprecated">
  3537. <doc>
  3538. <![CDATA[Get the list of <code>ContainerId</code> s of the containers that are
  3539. started successfully.
  3540. @return the list of <code>ContainerId</code> s of the containers that are
  3541. started successfully.
  3542. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3543. </doc>
  3544. </method>
  3545. <method name="getFailedRequests" return="java.util.Map"
  3546. abstract="true" native="false" synchronized="false"
  3547. static="false" final="false" visibility="public"
  3548. deprecated="not deprecated">
  3549. <doc>
  3550. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  3551. from per container for failed requests]]>
  3552. </doc>
  3553. </method>
  3554. <method name="getAllServicesMetaData" return="java.util.Map"
  3555. abstract="true" native="false" synchronized="false"
  3556. static="false" final="false" visibility="public"
  3557. deprecated="not deprecated">
  3558. <doc>
  3559. <![CDATA[<p>
  3560. Get the meta-data from all auxiliary services running on the
  3561. <code>NodeManager</code>.
  3562. </p>
  3563. <p>
  3564. The meta-data is returned as a Map between the auxiliary service names and
  3565. their corresponding per service meta-data as an opaque blob
  3566. <code>ByteBuffer</code>
  3567. </p>
  3568. <p>
  3569. To be able to interpret the per-service meta-data, you should consult the
  3570. documentation for the Auxiliary-service configured on the NodeManager
  3571. </p>
  3572. @return a Map between the names of auxiliary services and their
  3573. corresponding meta-data]]>
  3574. </doc>
  3575. </method>
  3576. <doc>
  3577. <![CDATA[<p>
  3578. The response sent by the <code>NodeManager</code> to the
  3579. <code>ApplicationMaster</code> when asked to <em>start</em> an allocated
  3580. container.
  3581. </p>
  3582. @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
  3583. </doc>
  3584. </class>
  3585. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
  3586. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  3587. <class name="StopContainersRequest" extends="java.lang.Object"
  3588. abstract="true"
  3589. static="false" final="false" visibility="public"
  3590. deprecated="not deprecated">
  3591. <constructor name="StopContainersRequest"
  3592. static="false" final="false" visibility="public"
  3593. deprecated="not deprecated">
  3594. </constructor>
  3595. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"
  3596. abstract="false" native="false" synchronized="false"
  3597. static="true" final="false" visibility="public"
  3598. deprecated="not deprecated">
  3599. <param name="containerIds" type="java.util.List"/>
  3600. </method>
  3601. <method name="getContainerIds" return="java.util.List"
  3602. abstract="true" native="false" synchronized="false"
  3603. static="false" final="false" visibility="public"
  3604. deprecated="not deprecated">
  3605. <doc>
  3606. <![CDATA[Get the <code>ContainerId</code>s of the containers to be stopped.
  3607. @return <code>ContainerId</code>s of containers to be stopped]]>
  3608. </doc>
  3609. </method>
  3610. <method name="setContainerIds"
  3611. abstract="true" native="false" synchronized="false"
  3612. static="false" final="false" visibility="public"
  3613. deprecated="not deprecated">
  3614. <param name="containerIds" type="java.util.List"/>
  3615. <doc>
  3616. <![CDATA[Set the <code>ContainerId</code>s of the containers to be stopped.
  3617. @param containerIds <code>ContainerId</code>s of the containers to be stopped]]>
  3618. </doc>
  3619. </method>
  3620. <doc>
  3621. <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
  3622. <code>NodeManager</code> to <em>stop</em> containers.</p>
  3623. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  3624. </doc>
  3625. </class>
  3626. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
  3627. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  3628. <class name="StopContainersResponse" extends="java.lang.Object"
  3629. abstract="true"
  3630. static="false" final="false" visibility="public"
  3631. deprecated="not deprecated">
  3632. <constructor name="StopContainersResponse"
  3633. static="false" final="false" visibility="public"
  3634. deprecated="not deprecated">
  3635. </constructor>
  3636. <method name="getSuccessfullyStoppedContainers" return="java.util.List"
  3637. abstract="true" native="false" synchronized="false"
  3638. static="false" final="false" visibility="public"
  3639. deprecated="not deprecated">
  3640. <doc>
  3641. <![CDATA[Get the list of containerIds of successfully stopped containers.
  3642. @return the list of containerIds of successfully stopped containers.]]>
  3643. </doc>
  3644. </method>
  3645. <method name="getFailedRequests" return="java.util.Map"
  3646. abstract="true" native="false" synchronized="false"
  3647. static="false" final="false" visibility="public"
  3648. deprecated="not deprecated">
  3649. <doc>
  3650. <![CDATA[Get the containerId-to-exception map in which the exception indicates error
  3651. from per container for failed requests]]>
  3652. </doc>
  3653. </method>
  3654. <doc>
  3655. <![CDATA[<p>
  3656. The response sent by the <code>NodeManager</code> to the
  3657. <code>ApplicationMaster</code> when asked to <em>stop</em> allocated
  3658. containers.
  3659. </p>
  3660. @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
  3661. </doc>
  3662. </class>
  3663. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
  3664. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  3665. <class name="SubmitApplicationRequest" extends="java.lang.Object"
  3666. abstract="true"
  3667. static="false" final="false" visibility="public"
  3668. deprecated="not deprecated">
  3669. <constructor name="SubmitApplicationRequest"
  3670. static="false" final="false" visibility="public"
  3671. deprecated="not deprecated">
  3672. </constructor>
  3673. <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"
  3674. abstract="false" native="false" synchronized="false"
  3675. static="true" final="false" visibility="public"
  3676. deprecated="not deprecated">
  3677. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  3678. </method>
  3679. <method name="getApplicationSubmissionContext" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  3680. abstract="true" native="false" synchronized="false"
  3681. static="false" final="false" visibility="public"
  3682. deprecated="not deprecated">
  3683. <doc>
  3684. <![CDATA[Get the <code>ApplicationSubmissionContext</code> for the application.
  3685. @return <code>ApplicationSubmissionContext</code> for the application]]>
  3686. </doc>
  3687. </method>
  3688. <method name="setApplicationSubmissionContext"
  3689. abstract="true" native="false" synchronized="false"
  3690. static="false" final="false" visibility="public"
  3691. deprecated="not deprecated">
  3692. <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
  3693. <doc>
  3694. <![CDATA[Set the <code>ApplicationSubmissionContext</code> for the application.
  3695. @param context <code>ApplicationSubmissionContext</code> for the
  3696. application]]>
  3697. </doc>
  3698. </method>
  3699. <doc>
  3700. <![CDATA[<p>The request sent by a client to <em>submit an application</em> to the
  3701. <code>ResourceManager</code>.</p>
  3702. <p>The request, via {@link ApplicationSubmissionContext}, contains
  3703. details such as queue, {@link Resource} required to run the
  3704. <code>ApplicationMaster</code>, the equivalent of
  3705. {@link ContainerLaunchContext} for launching the
  3706. <code>ApplicationMaster</code> etc.
  3707. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  3708. </doc>
  3709. </class>
  3710. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
  3711. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  3712. <class name="SubmitApplicationResponse" extends="java.lang.Object"
  3713. abstract="true"
  3714. static="false" final="false" visibility="public"
  3715. deprecated="not deprecated">
  3716. <constructor name="SubmitApplicationResponse"
  3717. static="false" final="false" visibility="public"
  3718. deprecated="not deprecated">
  3719. </constructor>
  3720. <doc>
  3721. <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
  3722. application submission.</p>
  3723. <p>Currently, this is empty.</p>
  3724. @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
  3725. </doc>
  3726. </class>
  3727. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
  3728. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  3729. <class name="UseSharedCacheResourceRequest" extends="java.lang.Object"
  3730. abstract="true"
  3731. static="false" final="false" visibility="public"
  3732. deprecated="not deprecated">
  3733. <constructor name="UseSharedCacheResourceRequest"
  3734. static="false" final="false" visibility="public"
  3735. deprecated="not deprecated">
  3736. </constructor>
  3737. <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3738. abstract="true" native="false" synchronized="false"
  3739. static="false" final="false" visibility="public"
  3740. deprecated="not deprecated">
  3741. <doc>
  3742. <![CDATA[Get the <code>ApplicationId</code> of the resource to be used.
  3743. @return <code>ApplicationId</code>]]>
  3744. </doc>
  3745. </method>
  3746. <method name="setAppId"
  3747. abstract="true" native="false" synchronized="false"
  3748. static="false" final="false" visibility="public"
  3749. deprecated="not deprecated">
  3750. <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3751. <doc>
  3752. <![CDATA[Set the <code>ApplicationId</code> of the resource to be used.
  3753. @param id <code>ApplicationId</code>]]>
  3754. </doc>
  3755. </method>
  3756. <method name="getResourceKey" return="java.lang.String"
  3757. abstract="true" native="false" synchronized="false"
  3758. static="false" final="false" visibility="public"
  3759. deprecated="not deprecated">
  3760. <doc>
  3761. <![CDATA[Get the <code>key</code> of the resource to be used.
  3762. @return <code>key</code>]]>
  3763. </doc>
  3764. </method>
  3765. <method name="setResourceKey"
  3766. abstract="true" native="false" synchronized="false"
  3767. static="false" final="false" visibility="public"
  3768. deprecated="not deprecated">
  3769. <param name="key" type="java.lang.String"/>
  3770. <doc>
  3771. <![CDATA[Set the <code>key</code> of the resource to be used.
  3772. @param key unique identifier for the resource]]>
  3773. </doc>
  3774. </method>
  3775. <doc>
  3776. <![CDATA[<p>
  3777. The request from clients to the <code>SharedCacheManager</code> that claims a
  3778. resource in the shared cache.
  3779. </p>]]>
  3780. </doc>
  3781. </class>
  3782. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
  3783. <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  3784. <class name="UseSharedCacheResourceResponse" extends="java.lang.Object"
  3785. abstract="true"
  3786. static="false" final="false" visibility="public"
  3787. deprecated="not deprecated">
  3788. <constructor name="UseSharedCacheResourceResponse"
  3789. static="false" final="false" visibility="public"
  3790. deprecated="not deprecated">
  3791. </constructor>
  3792. <method name="getPath" return="java.lang.String"
  3793. abstract="true" native="false" synchronized="false"
  3794. static="false" final="false" visibility="public"
  3795. deprecated="not deprecated">
  3796. <doc>
  3797. <![CDATA[Get the <code>Path</code> corresponding to the requested resource in the
  3798. shared cache.
  3799. @return String A <code>Path</code> if the resource exists in the shared
  3800. cache, <code>null</code> otherwise]]>
  3801. </doc>
  3802. </method>
  3803. <method name="setPath"
  3804. abstract="true" native="false" synchronized="false"
  3805. static="false" final="false" visibility="public"
  3806. deprecated="not deprecated">
  3807. <param name="p" type="java.lang.String"/>
  3808. <doc>
  3809. <![CDATA[Set the <code>Path</code> corresponding to a resource in the shared cache.
  3810. @param p A <code>Path</code> corresponding to a resource in the shared
  3811. cache]]>
  3812. </doc>
  3813. </method>
  3814. <doc>
  3815. <![CDATA[<p>
  3816. The response from the SharedCacheManager to the client that indicates whether
  3817. a requested resource exists in the cache.
  3818. </p>]]>
  3819. </doc>
  3820. </class>
  3821. <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
  3822. </package>
  3823. <package name="org.apache.hadoop.yarn.api.records">
  3824. <!-- start class org.apache.hadoop.yarn.api.records.AMCommand -->
  3825. <class name="AMCommand" extends="java.lang.Enum"
  3826. abstract="false"
  3827. static="false" final="true" visibility="public"
  3828. deprecated="not deprecated">
  3829. <method name="values" return="org.apache.hadoop.yarn.api.records.AMCommand[]"
  3830. abstract="false" native="false" synchronized="false"
  3831. static="true" final="false" visibility="public"
  3832. deprecated="not deprecated">
  3833. </method>
  3834. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.AMCommand"
  3835. abstract="false" native="false" synchronized="false"
  3836. static="true" final="false" visibility="public"
  3837. deprecated="not deprecated">
  3838. <param name="name" type="java.lang.String"/>
  3839. </method>
  3840. <doc>
  3841. <![CDATA[Command sent by the Resource Manager to the Application Master in the
  3842. AllocateResponse
  3843. @see AllocateResponse]]>
  3844. </doc>
  3845. </class>
  3846. <!-- end class org.apache.hadoop.yarn.api.records.AMCommand -->
  3847. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  3848. <class name="ApplicationAccessType" extends="java.lang.Enum"
  3849. abstract="false"
  3850. static="false" final="true" visibility="public"
  3851. deprecated="not deprecated">
  3852. <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType[]"
  3853. abstract="false" native="false" synchronized="false"
  3854. static="true" final="false" visibility="public"
  3855. deprecated="not deprecated">
  3856. </method>
  3857. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType"
  3858. abstract="false" native="false" synchronized="false"
  3859. static="true" final="false" visibility="public"
  3860. deprecated="not deprecated">
  3861. <param name="name" type="java.lang.String"/>
  3862. </method>
  3863. <doc>
  3864. <![CDATA[Application access types.]]>
  3865. </doc>
  3866. </class>
  3867. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
  3868. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  3869. <class name="ApplicationAttemptId" extends="java.lang.Object"
  3870. abstract="true"
  3871. static="false" final="false" visibility="public"
  3872. deprecated="not deprecated">
  3873. <implements name="java.lang.Comparable"/>
  3874. <constructor name="ApplicationAttemptId"
  3875. static="false" final="false" visibility="public"
  3876. deprecated="not deprecated">
  3877. </constructor>
  3878. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3879. abstract="true" native="false" synchronized="false"
  3880. static="false" final="false" visibility="public"
  3881. deprecated="not deprecated">
  3882. <doc>
  3883. <![CDATA[Get the <code>ApplicationId</code> of the <code>ApplicationAttempId</code>.
  3884. @return <code>ApplicationId</code> of the <code>ApplicationAttempId</code>]]>
  3885. </doc>
  3886. </method>
  3887. <method name="getAttemptId" return="int"
  3888. abstract="true" native="false" synchronized="false"
  3889. static="false" final="false" visibility="public"
  3890. deprecated="not deprecated">
  3891. <doc>
  3892. <![CDATA[Get the <code>attempt id</code> of the <code>Application</code>.
  3893. @return <code>attempt id</code> of the <code>Application</code>]]>
  3894. </doc>
  3895. </method>
  3896. <method name="hashCode" return="int"
  3897. abstract="false" native="false" synchronized="false"
  3898. static="false" final="false" visibility="public"
  3899. deprecated="not deprecated">
  3900. </method>
  3901. <method name="equals" return="boolean"
  3902. abstract="false" native="false" synchronized="false"
  3903. static="false" final="false" visibility="public"
  3904. deprecated="not deprecated">
  3905. <param name="obj" type="java.lang.Object"/>
  3906. </method>
  3907. <method name="compareTo" return="int"
  3908. abstract="false" native="false" synchronized="false"
  3909. static="false" final="false" visibility="public"
  3910. deprecated="not deprecated">
  3911. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  3912. </method>
  3913. <method name="toString" return="java.lang.String"
  3914. abstract="false" native="false" synchronized="false"
  3915. static="false" final="false" visibility="public"
  3916. deprecated="not deprecated">
  3917. </method>
  3918. <method name="build"
  3919. abstract="true" native="false" synchronized="false"
  3920. static="false" final="false" visibility="protected"
  3921. deprecated="not deprecated">
  3922. </method>
  3923. <field name="appAttemptIdStrPrefix" type="java.lang.String"
  3924. transient="false" volatile="false"
  3925. static="true" final="true" visibility="public"
  3926. deprecated="not deprecated">
  3927. </field>
  3928. <doc>
  3929. <![CDATA[<p><code>ApplicationAttemptId</code> denotes the particular <em>attempt</em>
  3930. of an <code>ApplicationMaster</code> for a given {@link ApplicationId}.</p>
  3931. <p>Multiple attempts might be needed to run an application to completion due
  3932. to temporal failures of the <code>ApplicationMaster</code> such as hardware
  3933. failures, connectivity issues etc. on the node on which it was scheduled.</p>]]>
  3934. </doc>
  3935. </class>
  3936. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
  3937. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  3938. <class name="ApplicationAttemptReport" extends="java.lang.Object"
  3939. abstract="true"
  3940. static="false" final="false" visibility="public"
  3941. deprecated="not deprecated">
  3942. <constructor name="ApplicationAttemptReport"
  3943. static="false" final="false" visibility="public"
  3944. deprecated="not deprecated">
  3945. </constructor>
  3946. <method name="getYarnApplicationAttemptState" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  3947. abstract="true" native="false" synchronized="false"
  3948. static="false" final="false" visibility="public"
  3949. deprecated="not deprecated">
  3950. <doc>
  3951. <![CDATA[Get the <em>YarnApplicationAttemptState</em> of the application attempt.
  3952. @return <em>YarnApplicationAttemptState</em> of the application attempt]]>
  3953. </doc>
  3954. </method>
  3955. <method name="getRpcPort" return="int"
  3956. abstract="true" native="false" synchronized="false"
  3957. static="false" final="false" visibility="public"
  3958. deprecated="not deprecated">
  3959. <doc>
  3960. <![CDATA[Get the <em>RPC port</em> of this attempt <code>ApplicationMaster</code>.
  3961. @return <em>RPC port</em> of this attempt <code>ApplicationMaster</code>]]>
  3962. </doc>
  3963. </method>
  3964. <method name="getHost" return="java.lang.String"
  3965. abstract="true" native="false" synchronized="false"
  3966. static="false" final="false" visibility="public"
  3967. deprecated="not deprecated">
  3968. <doc>
  3969. <![CDATA[Get the <em>host</em> on which this attempt of
  3970. <code>ApplicationMaster</code> is running.
  3971. @return <em>host</em> on which this attempt of
  3972. <code>ApplicationMaster</code> is running]]>
  3973. </doc>
  3974. </method>
  3975. <method name="getDiagnostics" return="java.lang.String"
  3976. abstract="true" native="false" synchronized="false"
  3977. static="false" final="false" visibility="public"
  3978. deprecated="not deprecated">
  3979. <doc>
  3980. <![CDATA[Get the <em>diagnositic information</em> of the application attempt in case
  3981. of errors.
  3982. @return <em>diagnositic information</em> of the application attempt in case
  3983. of errors]]>
  3984. </doc>
  3985. </method>
  3986. <method name="getTrackingUrl" return="java.lang.String"
  3987. abstract="true" native="false" synchronized="false"
  3988. static="false" final="false" visibility="public"
  3989. deprecated="not deprecated">
  3990. <doc>
  3991. <![CDATA[Get the <em>tracking url</em> for the application attempt.
  3992. @return <em>tracking url</em> for the application attempt]]>
  3993. </doc>
  3994. </method>
  3995. <method name="getOriginalTrackingUrl" return="java.lang.String"
  3996. abstract="true" native="false" synchronized="false"
  3997. static="false" final="false" visibility="public"
  3998. deprecated="not deprecated">
  3999. <doc>
  4000. <![CDATA[Get the <em>original tracking url</em> for the application attempt.
  4001. @return <em>original tracking url</em> for the application attempt]]>
  4002. </doc>
  4003. </method>
  4004. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  4005. abstract="true" native="false" synchronized="false"
  4006. static="false" final="false" visibility="public"
  4007. deprecated="not deprecated">
  4008. <doc>
  4009. <![CDATA[Get the <code>ApplicationAttemptId</code> of this attempt of the
  4010. application
  4011. @return <code>ApplicationAttemptId</code> of the attempt]]>
  4012. </doc>
  4013. </method>
  4014. <method name="getAMContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4015. abstract="true" native="false" synchronized="false"
  4016. static="false" final="false" visibility="public"
  4017. deprecated="not deprecated">
  4018. <doc>
  4019. <![CDATA[Get the <code>ContainerId</code> of AMContainer for this attempt
  4020. @return <code>ContainerId</code> of the attempt]]>
  4021. </doc>
  4022. </method>
  4023. <doc>
  4024. <![CDATA[{@code ApplicationAttemptReport} is a report of an application attempt.
  4025. <p>
  4026. It includes details such as:
  4027. <ul>
  4028. <li>{@link ApplicationAttemptId} of the application.</li>
  4029. <li>Host on which the <code>ApplicationMaster</code> of this attempt is
  4030. running.</li>
  4031. <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li>
  4032. <li>Tracking URL.</li>
  4033. <li>Diagnostic information in case of errors.</li>
  4034. <li>{@link YarnApplicationAttemptState} of the application attempt.</li>
  4035. <li>{@link ContainerId} of the master Container.</li>
  4036. </ul>]]>
  4037. </doc>
  4038. </class>
  4039. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
  4040. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationId -->
  4041. <class name="ApplicationId" extends="java.lang.Object"
  4042. abstract="true"
  4043. static="false" final="false" visibility="public"
  4044. deprecated="not deprecated">
  4045. <implements name="java.lang.Comparable"/>
  4046. <constructor name="ApplicationId"
  4047. static="false" final="false" visibility="public"
  4048. deprecated="not deprecated">
  4049. </constructor>
  4050. <method name="getId" return="int"
  4051. abstract="true" native="false" synchronized="false"
  4052. static="false" final="false" visibility="public"
  4053. deprecated="not deprecated">
  4054. <doc>
  4055. <![CDATA[Get the short integer identifier of the <code>ApplicationId</code>
  4056. which is unique for all applications started by a particular instance
  4057. of the <code>ResourceManager</code>.
  4058. @return short integer identifier of the <code>ApplicationId</code>]]>
  4059. </doc>
  4060. </method>
  4061. <method name="getClusterTimestamp" return="long"
  4062. abstract="true" native="false" synchronized="false"
  4063. static="false" final="false" visibility="public"
  4064. deprecated="not deprecated">
  4065. <doc>
  4066. <![CDATA[Get the <em>start time</em> of the <code>ResourceManager</code> which is
  4067. used to generate globally unique <code>ApplicationId</code>.
  4068. @return <em>start time</em> of the <code>ResourceManager</code>]]>
  4069. </doc>
  4070. </method>
  4071. <method name="build"
  4072. abstract="true" native="false" synchronized="false"
  4073. static="false" final="false" visibility="protected"
  4074. deprecated="not deprecated">
  4075. </method>
  4076. <method name="compareTo" return="int"
  4077. abstract="false" native="false" synchronized="false"
  4078. static="false" final="false" visibility="public"
  4079. deprecated="not deprecated">
  4080. <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4081. </method>
  4082. <method name="toString" return="java.lang.String"
  4083. abstract="false" native="false" synchronized="false"
  4084. static="false" final="false" visibility="public"
  4085. deprecated="not deprecated">
  4086. </method>
  4087. <method name="hashCode" return="int"
  4088. abstract="false" native="false" synchronized="false"
  4089. static="false" final="false" visibility="public"
  4090. deprecated="not deprecated">
  4091. </method>
  4092. <method name="equals" return="boolean"
  4093. abstract="false" native="false" synchronized="false"
  4094. static="false" final="false" visibility="public"
  4095. deprecated="not deprecated">
  4096. <param name="obj" type="java.lang.Object"/>
  4097. </method>
  4098. <field name="appIdStrPrefix" type="java.lang.String"
  4099. transient="false" volatile="false"
  4100. static="true" final="true" visibility="public"
  4101. deprecated="not deprecated">
  4102. </field>
  4103. <doc>
  4104. <![CDATA[<p><code>ApplicationId</code> represents the <em>globally unique</em>
  4105. identifier for an application.</p>
  4106. <p>The globally unique nature of the identifier is achieved by using the
  4107. <em>cluster timestamp</em> i.e. start-time of the
  4108. <code>ResourceManager</code> along with a monotonically increasing counter
  4109. for the application.</p>]]>
  4110. </doc>
  4111. </class>
  4112. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationId -->
  4113. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  4114. <class name="ApplicationReport" extends="java.lang.Object"
  4115. abstract="true"
  4116. static="false" final="false" visibility="public"
  4117. deprecated="not deprecated">
  4118. <constructor name="ApplicationReport"
  4119. static="false" final="false" visibility="public"
  4120. deprecated="not deprecated">
  4121. </constructor>
  4122. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4123. abstract="true" native="false" synchronized="false"
  4124. static="false" final="false" visibility="public"
  4125. deprecated="not deprecated">
  4126. <doc>
  4127. <![CDATA[Get the <code>ApplicationId</code> of the application.
  4128. @return <code>ApplicationId</code> of the application]]>
  4129. </doc>
  4130. </method>
  4131. <method name="getCurrentApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  4132. abstract="true" native="false" synchronized="false"
  4133. static="false" final="false" visibility="public"
  4134. deprecated="not deprecated">
  4135. <doc>
  4136. <![CDATA[Get the <code>ApplicationAttemptId</code> of the current
  4137. attempt of the application
  4138. @return <code>ApplicationAttemptId</code> of the attempt]]>
  4139. </doc>
  4140. </method>
  4141. <method name="getUser" return="java.lang.String"
  4142. abstract="true" native="false" synchronized="false"
  4143. static="false" final="false" visibility="public"
  4144. deprecated="not deprecated">
  4145. <doc>
  4146. <![CDATA[Get the <em>user</em> who submitted the application.
  4147. @return <em>user</em> who submitted the application]]>
  4148. </doc>
  4149. </method>
  4150. <method name="getQueue" return="java.lang.String"
  4151. abstract="true" native="false" synchronized="false"
  4152. static="false" final="false" visibility="public"
  4153. deprecated="not deprecated">
  4154. <doc>
  4155. <![CDATA[Get the <em>queue</em> to which the application was submitted.
  4156. @return <em>queue</em> to which the application was submitted]]>
  4157. </doc>
  4158. </method>
  4159. <method name="getName" return="java.lang.String"
  4160. abstract="true" native="false" synchronized="false"
  4161. static="false" final="false" visibility="public"
  4162. deprecated="not deprecated">
  4163. <doc>
  4164. <![CDATA[Get the user-defined <em>name</em> of the application.
  4165. @return <em>name</em> of the application]]>
  4166. </doc>
  4167. </method>
  4168. <method name="getHost" return="java.lang.String"
  4169. abstract="true" native="false" synchronized="false"
  4170. static="false" final="false" visibility="public"
  4171. deprecated="not deprecated">
  4172. <doc>
  4173. <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code>
  4174. is running.
  4175. @return <em>host</em> on which the <code>ApplicationMaster</code>
  4176. is running]]>
  4177. </doc>
  4178. </method>
  4179. <method name="getRpcPort" return="int"
  4180. abstract="true" native="false" synchronized="false"
  4181. static="false" final="false" visibility="public"
  4182. deprecated="not deprecated">
  4183. <doc>
  4184. <![CDATA[Get the <em>RPC port</em> of the <code>ApplicationMaster</code>.
  4185. @return <em>RPC port</em> of the <code>ApplicationMaster</code>]]>
  4186. </doc>
  4187. </method>
  4188. <method name="getClientToAMToken" return="org.apache.hadoop.yarn.api.records.Token"
  4189. abstract="true" native="false" synchronized="false"
  4190. static="false" final="false" visibility="public"
  4191. deprecated="not deprecated">
  4192. <doc>
  4193. <![CDATA[Get the <em>client token</em> for communicating with the
  4194. <code>ApplicationMaster</code>.
  4195. <p>
  4196. <em>ClientToAMToken</em> is the security token used by the AMs to verify
  4197. authenticity of any <code>client</code>.
  4198. </p>
  4199. <p>
  4200. The <code>ResourceManager</code>, provides a secure token (via
  4201. {@link ApplicationReport#getClientToAMToken()}) which is verified by the
  4202. ApplicationMaster when the client directly talks to an AM.
  4203. </p>
  4204. @return <em>client token</em> for communicating with the
  4205. <code>ApplicationMaster</code>]]>
  4206. </doc>
  4207. </method>
  4208. <method name="getYarnApplicationState" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  4209. abstract="true" native="false" synchronized="false"
  4210. static="false" final="false" visibility="public"
  4211. deprecated="not deprecated">
  4212. <doc>
  4213. <![CDATA[Get the <code>YarnApplicationState</code> of the application.
  4214. @return <code>YarnApplicationState</code> of the application]]>
  4215. </doc>
  4216. </method>
  4217. <method name="getDiagnostics" return="java.lang.String"
  4218. abstract="true" native="false" synchronized="false"
  4219. static="false" final="false" visibility="public"
  4220. deprecated="not deprecated">
  4221. <doc>
  4222. <![CDATA[Get the <em>diagnositic information</em> of the application in case of
  4223. errors.
  4224. @return <em>diagnositic information</em> of the application in case
  4225. of errors]]>
  4226. </doc>
  4227. </method>
  4228. <method name="getTrackingUrl" return="java.lang.String"
  4229. abstract="true" native="false" synchronized="false"
  4230. static="false" final="false" visibility="public"
  4231. deprecated="not deprecated">
  4232. <doc>
  4233. <![CDATA[Get the <em>tracking url</em> for the application.
  4234. @return <em>tracking url</em> for the application]]>
  4235. </doc>
  4236. </method>
  4237. <method name="getStartTime" return="long"
  4238. abstract="true" native="false" synchronized="false"
  4239. static="false" final="false" visibility="public"
  4240. deprecated="not deprecated">
  4241. <doc>
  4242. <![CDATA[Get the <em>start time</em> of the application.
  4243. @return <em>start time</em> of the application]]>
  4244. </doc>
  4245. </method>
  4246. <method name="getFinishTime" return="long"
  4247. abstract="true" native="false" synchronized="false"
  4248. static="false" final="false" visibility="public"
  4249. deprecated="not deprecated">
  4250. <doc>
  4251. <![CDATA[Get the <em>finish time</em> of the application.
  4252. @return <em>finish time</em> of the application]]>
  4253. </doc>
  4254. </method>
  4255. <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  4256. abstract="true" native="false" synchronized="false"
  4257. static="false" final="false" visibility="public"
  4258. deprecated="not deprecated">
  4259. <doc>
  4260. <![CDATA[Get the <em>final finish status</em> of the application.
  4261. @return <em>final finish status</em> of the application]]>
  4262. </doc>
  4263. </method>
  4264. <method name="getApplicationResourceUsageReport" return="org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport"
  4265. abstract="true" native="false" synchronized="false"
  4266. static="false" final="false" visibility="public"
  4267. deprecated="not deprecated">
  4268. <doc>
  4269. <![CDATA[Retrieve the structure containing the job resources for this application
  4270. @return the job resources structure for this application]]>
  4271. </doc>
  4272. </method>
  4273. <method name="getProgress" return="float"
  4274. abstract="true" native="false" synchronized="false"
  4275. static="false" final="false" visibility="public"
  4276. deprecated="not deprecated">
  4277. <doc>
  4278. <![CDATA[Get the application's progress ( range 0.0 to 1.0 )
  4279. @return application's progress]]>
  4280. </doc>
  4281. </method>
  4282. <method name="getApplicationType" return="java.lang.String"
  4283. abstract="true" native="false" synchronized="false"
  4284. static="false" final="false" visibility="public"
  4285. deprecated="not deprecated">
  4286. <doc>
  4287. <![CDATA[Get the application's Type
  4288. @return application's Type]]>
  4289. </doc>
  4290. </method>
  4291. <method name="getApplicationTags" return="java.util.Set"
  4292. abstract="true" native="false" synchronized="false"
  4293. static="false" final="false" visibility="public"
  4294. deprecated="not deprecated">
  4295. <doc>
  4296. <![CDATA[Get all tags corresponding to the application
  4297. @return Application's tags]]>
  4298. </doc>
  4299. </method>
  4300. <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
  4301. abstract="true" native="false" synchronized="false"
  4302. static="false" final="false" visibility="public"
  4303. deprecated="not deprecated">
  4304. <doc>
  4305. <![CDATA[Get the AMRM token of the application.
  4306. <p>
  4307. The AMRM token is required for AM to RM scheduling operations. For
  4308. managed Application Masters Yarn takes care of injecting it. For unmanaged
  4309. Applications Masters, the token must be obtained via this method and set
  4310. in the {@link org.apache.hadoop.security.UserGroupInformation} of the
  4311. current user.
  4312. <p>
  4313. The AMRM token will be returned only if all the following conditions are
  4314. met:
  4315. <ul>
  4316. <li>the requester is the owner of the ApplicationMaster</li>
  4317. <li>the application master is an unmanaged ApplicationMaster</li>
  4318. <li>the application master is in ACCEPTED state</li>
  4319. </ul>
  4320. Else this method returns NULL.
  4321. @return the AM to RM token if available.]]>
  4322. </doc>
  4323. </method>
  4324. <doc>
  4325. <![CDATA[{@code ApplicationReport} is a report of an application.
  4326. <p>
  4327. It includes details such as:
  4328. <ul>
  4329. <li>{@link ApplicationId} of the application.</li>
  4330. <li>Applications user.</li>
  4331. <li>Application queue.</li>
  4332. <li>Application name.</li>
  4333. <li>Host on which the <code>ApplicationMaster</code> is running.</li>
  4334. <li>RPC port of the <code>ApplicationMaster</code>.</li>
  4335. <li>Tracking URL.</li>
  4336. <li>{@link YarnApplicationState} of the application.</li>
  4337. <li>Diagnostic information in case of errors.</li>
  4338. <li>Start time of the application.</li>
  4339. <li>Client {@link Token} of the application (if security is enabled).</li>
  4340. </ul>
  4341. @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)]]>
  4342. </doc>
  4343. </class>
  4344. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationReport -->
  4345. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  4346. <class name="ApplicationResourceUsageReport" extends="java.lang.Object"
  4347. abstract="true"
  4348. static="false" final="false" visibility="public"
  4349. deprecated="not deprecated">
  4350. <constructor name="ApplicationResourceUsageReport"
  4351. static="false" final="false" visibility="public"
  4352. deprecated="not deprecated">
  4353. </constructor>
  4354. <method name="getNumUsedContainers" return="int"
  4355. abstract="true" native="false" synchronized="false"
  4356. static="false" final="false" visibility="public"
  4357. deprecated="not deprecated">
  4358. <doc>
  4359. <![CDATA[Get the number of used containers. -1 for invalid/inaccessible reports.
  4360. @return the number of used containers]]>
  4361. </doc>
  4362. </method>
  4363. <method name="getUsedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  4364. abstract="true" native="false" synchronized="false"
  4365. static="false" final="false" visibility="public"
  4366. deprecated="not deprecated">
  4367. <doc>
  4368. <![CDATA[Get the used <code>Resource</code>. -1 for invalid/inaccessible reports.
  4369. @return the used <code>Resource</code>]]>
  4370. </doc>
  4371. </method>
  4372. <method name="getReservedResources" return="org.apache.hadoop.yarn.api.records.Resource"
  4373. abstract="true" native="false" synchronized="false"
  4374. static="false" final="false" visibility="public"
  4375. deprecated="not deprecated">
  4376. <doc>
  4377. <![CDATA[Get the reserved <code>Resource</code>. -1 for invalid/inaccessible reports.
  4378. @return the reserved <code>Resource</code>]]>
  4379. </doc>
  4380. </method>
  4381. <method name="getNeededResources" return="org.apache.hadoop.yarn.api.records.Resource"
  4382. abstract="true" native="false" synchronized="false"
  4383. static="false" final="false" visibility="public"
  4384. deprecated="not deprecated">
  4385. <doc>
  4386. <![CDATA[Get the needed <code>Resource</code>. -1 for invalid/inaccessible reports.
  4387. @return the needed <code>Resource</code>]]>
  4388. </doc>
  4389. </method>
  4390. <method name="getMemorySeconds" return="long"
  4391. abstract="true" native="false" synchronized="false"
  4392. static="false" final="false" visibility="public"
  4393. deprecated="not deprecated">
  4394. <doc>
  4395. <![CDATA[Get the aggregated amount of memory (in megabytes) the application has
  4396. allocated times the number of seconds the application has been running.
  4397. @return the aggregated amount of memory seconds]]>
  4398. </doc>
  4399. </method>
  4400. <method name="getVcoreSeconds" return="long"
  4401. abstract="true" native="false" synchronized="false"
  4402. static="false" final="false" visibility="public"
  4403. deprecated="not deprecated">
  4404. <doc>
  4405. <![CDATA[Get the aggregated number of vcores that the application has allocated
  4406. times the number of seconds the application has been running.
  4407. @return the aggregated number of vcore seconds]]>
  4408. </doc>
  4409. </method>
  4410. <doc>
  4411. <![CDATA[Contains various scheduling metrics to be reported by UI and CLI.]]>
  4412. </doc>
  4413. </class>
  4414. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
  4415. <!-- start class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  4416. <class name="ApplicationSubmissionContext" extends="java.lang.Object"
  4417. abstract="true"
  4418. static="false" final="false" visibility="public"
  4419. deprecated="not deprecated">
  4420. <constructor name="ApplicationSubmissionContext"
  4421. static="false" final="false" visibility="public"
  4422. deprecated="not deprecated">
  4423. </constructor>
  4424. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4425. abstract="false" native="false" synchronized="false"
  4426. static="true" final="false" visibility="public"
  4427. deprecated="not deprecated">
  4428. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4429. <param name="applicationName" type="java.lang.String"/>
  4430. <param name="queue" type="java.lang.String"/>
  4431. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4432. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4433. <param name="isUnmanagedAM" type="boolean"/>
  4434. <param name="cancelTokensWhenComplete" type="boolean"/>
  4435. <param name="maxAppAttempts" type="int"/>
  4436. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4437. <param name="applicationType" type="java.lang.String"/>
  4438. <param name="keepContainers" type="boolean"/>
  4439. <param name="appLabelExpression" type="java.lang.String"/>
  4440. <param name="amContainerLabelExpression" type="java.lang.String"/>
  4441. </method>
  4442. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4443. abstract="false" native="false" synchronized="false"
  4444. static="true" final="false" visibility="public"
  4445. deprecated="not deprecated">
  4446. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4447. <param name="applicationName" type="java.lang.String"/>
  4448. <param name="queue" type="java.lang.String"/>
  4449. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4450. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4451. <param name="isUnmanagedAM" type="boolean"/>
  4452. <param name="cancelTokensWhenComplete" type="boolean"/>
  4453. <param name="maxAppAttempts" type="int"/>
  4454. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4455. <param name="applicationType" type="java.lang.String"/>
  4456. <param name="keepContainers" type="boolean"/>
  4457. </method>
  4458. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4459. abstract="false" native="false" synchronized="false"
  4460. static="true" final="false" visibility="public"
  4461. deprecated="not deprecated">
  4462. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4463. <param name="applicationName" type="java.lang.String"/>
  4464. <param name="queue" type="java.lang.String"/>
  4465. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4466. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4467. <param name="isUnmanagedAM" type="boolean"/>
  4468. <param name="cancelTokensWhenComplete" type="boolean"/>
  4469. <param name="maxAppAttempts" type="int"/>
  4470. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4471. <param name="applicationType" type="java.lang.String"/>
  4472. </method>
  4473. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4474. abstract="false" native="false" synchronized="false"
  4475. static="true" final="false" visibility="public"
  4476. deprecated="not deprecated">
  4477. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4478. <param name="applicationName" type="java.lang.String"/>
  4479. <param name="queue" type="java.lang.String"/>
  4480. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4481. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4482. <param name="isUnmanagedAM" type="boolean"/>
  4483. <param name="cancelTokensWhenComplete" type="boolean"/>
  4484. <param name="maxAppAttempts" type="int"/>
  4485. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4486. </method>
  4487. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4488. abstract="false" native="false" synchronized="false"
  4489. static="true" final="false" visibility="public"
  4490. deprecated="not deprecated">
  4491. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4492. <param name="applicationName" type="java.lang.String"/>
  4493. <param name="queue" type="java.lang.String"/>
  4494. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4495. <param name="isUnmanagedAM" type="boolean"/>
  4496. <param name="cancelTokensWhenComplete" type="boolean"/>
  4497. <param name="maxAppAttempts" type="int"/>
  4498. <param name="applicationType" type="java.lang.String"/>
  4499. <param name="keepContainers" type="boolean"/>
  4500. <param name="appLabelExpression" type="java.lang.String"/>
  4501. <param name="resourceRequest" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  4502. </method>
  4503. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4504. abstract="false" native="false" synchronized="false"
  4505. static="true" final="false" visibility="public"
  4506. deprecated="not deprecated">
  4507. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4508. <param name="applicationName" type="java.lang.String"/>
  4509. <param name="queue" type="java.lang.String"/>
  4510. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4511. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4512. <param name="isUnmanagedAM" type="boolean"/>
  4513. <param name="cancelTokensWhenComplete" type="boolean"/>
  4514. <param name="maxAppAttempts" type="int"/>
  4515. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4516. <param name="applicationType" type="java.lang.String"/>
  4517. <param name="keepContainers" type="boolean"/>
  4518. <param name="attemptFailuresValidityInterval" type="long"/>
  4519. </method>
  4520. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
  4521. abstract="false" native="false" synchronized="false"
  4522. static="true" final="false" visibility="public"
  4523. deprecated="not deprecated">
  4524. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4525. <param name="applicationName" type="java.lang.String"/>
  4526. <param name="queue" type="java.lang.String"/>
  4527. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  4528. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4529. <param name="isUnmanagedAM" type="boolean"/>
  4530. <param name="cancelTokensWhenComplete" type="boolean"/>
  4531. <param name="maxAppAttempts" type="int"/>
  4532. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4533. <param name="applicationType" type="java.lang.String"/>
  4534. <param name="keepContainers" type="boolean"/>
  4535. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  4536. </method>
  4537. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  4538. abstract="true" native="false" synchronized="false"
  4539. static="false" final="false" visibility="public"
  4540. deprecated="not deprecated">
  4541. <doc>
  4542. <![CDATA[Get the <code>ApplicationId</code> of the submitted application.
  4543. @return <code>ApplicationId</code> of the submitted application]]>
  4544. </doc>
  4545. </method>
  4546. <method name="setApplicationId"
  4547. abstract="true" native="false" synchronized="false"
  4548. static="false" final="false" visibility="public"
  4549. deprecated="not deprecated">
  4550. <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  4551. <doc>
  4552. <![CDATA[Set the <code>ApplicationId</code> of the submitted application.
  4553. @param applicationId <code>ApplicationId</code> of the submitted
  4554. application]]>
  4555. </doc>
  4556. </method>
  4557. <method name="getApplicationName" return="java.lang.String"
  4558. abstract="true" native="false" synchronized="false"
  4559. static="false" final="false" visibility="public"
  4560. deprecated="not deprecated">
  4561. <doc>
  4562. <![CDATA[Get the application <em>name</em>.
  4563. @return application name]]>
  4564. </doc>
  4565. </method>
  4566. <method name="setApplicationName"
  4567. abstract="true" native="false" synchronized="false"
  4568. static="false" final="false" visibility="public"
  4569. deprecated="not deprecated">
  4570. <param name="applicationName" type="java.lang.String"/>
  4571. <doc>
  4572. <![CDATA[Set the application <em>name</em>.
  4573. @param applicationName application name]]>
  4574. </doc>
  4575. </method>
  4576. <method name="getQueue" return="java.lang.String"
  4577. abstract="true" native="false" synchronized="false"
  4578. static="false" final="false" visibility="public"
  4579. deprecated="not deprecated">
  4580. <doc>
  4581. <![CDATA[Get the <em>queue</em> to which the application is being submitted.
  4582. @return <em>queue</em> to which the application is being submitted]]>
  4583. </doc>
  4584. </method>
  4585. <method name="setQueue"
  4586. abstract="true" native="false" synchronized="false"
  4587. static="false" final="false" visibility="public"
  4588. deprecated="not deprecated">
  4589. <param name="queue" type="java.lang.String"/>
  4590. <doc>
  4591. <![CDATA[Set the <em>queue</em> to which the application is being submitted
  4592. @param queue <em>queue</em> to which the application is being submitted]]>
  4593. </doc>
  4594. </method>
  4595. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  4596. abstract="true" native="false" synchronized="false"
  4597. static="false" final="false" visibility="public"
  4598. deprecated="not deprecated">
  4599. <doc>
  4600. <![CDATA[Get the <code>Priority</code> of the application.
  4601. @return <code>Priority</code> of the application]]>
  4602. </doc>
  4603. </method>
  4604. <method name="getAMContainerSpec" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  4605. abstract="true" native="false" synchronized="false"
  4606. static="false" final="false" visibility="public"
  4607. deprecated="not deprecated">
  4608. <doc>
  4609. <![CDATA[Get the <code>ContainerLaunchContext</code> to describe the
  4610. <code>Container</code> with which the <code>ApplicationMaster</code> is
  4611. launched.
  4612. @return <code>ContainerLaunchContext</code> for the
  4613. <code>ApplicationMaster</code> container]]>
  4614. </doc>
  4615. </method>
  4616. <method name="setAMContainerSpec"
  4617. abstract="true" native="false" synchronized="false"
  4618. static="false" final="false" visibility="public"
  4619. deprecated="not deprecated">
  4620. <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
  4621. <doc>
  4622. <![CDATA[Set the <code>ContainerLaunchContext</code> to describe the
  4623. <code>Container</code> with which the <code>ApplicationMaster</code> is
  4624. launched.
  4625. @param amContainer <code>ContainerLaunchContext</code> for the
  4626. <code>ApplicationMaster</code> container]]>
  4627. </doc>
  4628. </method>
  4629. <method name="getUnmanagedAM" return="boolean"
  4630. abstract="true" native="false" synchronized="false"
  4631. static="false" final="false" visibility="public"
  4632. deprecated="not deprecated">
  4633. <doc>
  4634. <![CDATA[Get if the RM should manage the execution of the AM.
  4635. If true, then the RM
  4636. will not allocate a container for the AM and start it. It will expect the
  4637. AM to be launched and connect to the RM within the AM liveliness period and
  4638. fail the app otherwise. The client should launch the AM only after the RM
  4639. has ACCEPTED the application and changed the <code>YarnApplicationState</code>.
  4640. Such apps will not be retried by the RM on app attempt failure.
  4641. The default value is false.
  4642. @return true if the AM is not managed by the RM]]>
  4643. </doc>
  4644. </method>
  4645. <method name="setUnmanagedAM"
  4646. abstract="true" native="false" synchronized="false"
  4647. static="false" final="false" visibility="public"
  4648. deprecated="not deprecated">
  4649. <param name="value" type="boolean"/>
  4650. <doc>
  4651. <![CDATA[@param value true if RM should not manage the AM]]>
  4652. </doc>
  4653. </method>
  4654. <method name="getMaxAppAttempts" return="int"
  4655. abstract="true" native="false" synchronized="false"
  4656. static="false" final="false" visibility="public"
  4657. deprecated="not deprecated">
  4658. <doc>
  4659. <![CDATA[@return the number of max attempts of the application to be submitted]]>
  4660. </doc>
  4661. </method>
  4662. <method name="setMaxAppAttempts"
  4663. abstract="true" native="false" synchronized="false"
  4664. static="false" final="false" visibility="public"
  4665. deprecated="not deprecated">
  4666. <param name="maxAppAttempts" type="int"/>
  4667. <doc>
  4668. <![CDATA[Set the number of max attempts of the application to be submitted. WARNING:
  4669. it should be no larger than the global number of max attempts in the Yarn
  4670. configuration.
  4671. @param maxAppAttempts the number of max attempts of the application
  4672. to be submitted.]]>
  4673. </doc>
  4674. </method>
  4675. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  4676. abstract="true" native="false" synchronized="false"
  4677. static="false" final="false" visibility="public"
  4678. deprecated="not deprecated">
  4679. <doc>
  4680. <![CDATA[Get the resource required by the <code>ApplicationMaster</code> for this
  4681. application. Please note this will be DEPRECATED, use <em>getResource</em>
  4682. in <em>getAMContainerResourceRequest</em> instead.
  4683. @return the resource required by the <code>ApplicationMaster</code> for
  4684. this application.]]>
  4685. </doc>
  4686. </method>
  4687. <method name="setResource"
  4688. abstract="true" native="false" synchronized="false"
  4689. static="false" final="false" visibility="public"
  4690. deprecated="not deprecated">
  4691. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  4692. <doc>
  4693. <![CDATA[Set the resource required by the <code>ApplicationMaster</code> for this
  4694. application.
  4695. @param resource the resource required by the <code>ApplicationMaster</code>
  4696. for this application.]]>
  4697. </doc>
  4698. </method>
  4699. <method name="getApplicationType" return="java.lang.String"
  4700. abstract="true" native="false" synchronized="false"
  4701. static="false" final="false" visibility="public"
  4702. deprecated="not deprecated">
  4703. <doc>
  4704. <![CDATA[Get the application type
  4705. @return the application type]]>
  4706. </doc>
  4707. </method>
  4708. <method name="setApplicationType"
  4709. abstract="true" native="false" synchronized="false"
  4710. static="false" final="false" visibility="public"
  4711. deprecated="not deprecated">
  4712. <param name="applicationType" type="java.lang.String"/>
  4713. <doc>
  4714. <![CDATA[Set the application type
  4715. @param applicationType the application type]]>
  4716. </doc>
  4717. </method>
  4718. <method name="getKeepContainersAcrossApplicationAttempts" return="boolean"
  4719. abstract="true" native="false" synchronized="false"
  4720. static="false" final="false" visibility="public"
  4721. deprecated="not deprecated">
  4722. <doc>
  4723. <![CDATA[Get the flag which indicates whether to keep containers across application
  4724. attempts or not.
  4725. @return the flag which indicates whether to keep containers across
  4726. application attempts or not.]]>
  4727. </doc>
  4728. </method>
  4729. <method name="setKeepContainersAcrossApplicationAttempts"
  4730. abstract="true" native="false" synchronized="false"
  4731. static="false" final="false" visibility="public"
  4732. deprecated="not deprecated">
  4733. <param name="keepContainers" type="boolean"/>
  4734. <doc>
  4735. <![CDATA[Set the flag which indicates whether to keep containers across application
  4736. attempts.
  4737. <p>
  4738. If the flag is true, running containers will not be killed when application
  4739. attempt fails and these containers will be retrieved by the new application
  4740. attempt on registration via
  4741. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}.
  4742. </p>
  4743. @param keepContainers
  4744. the flag which indicates whether to keep containers across
  4745. application attempts.]]>
  4746. </doc>
  4747. </method>
  4748. <method name="getApplicationTags" return="java.util.Set"
  4749. abstract="true" native="false" synchronized="false"
  4750. static="false" final="false" visibility="public"
  4751. deprecated="not deprecated">
  4752. <doc>
  4753. <![CDATA[Get tags for the application
  4754. @return the application tags]]>
  4755. </doc>
  4756. </method>
  4757. <method name="setApplicationTags"
  4758. abstract="true" native="false" synchronized="false"
  4759. static="false" final="false" visibility="public"
  4760. deprecated="not deprecated">
  4761. <param name="tags" type="java.util.Set"/>
  4762. <doc>
  4763. <![CDATA[Set tags for the application. A maximum of
  4764. {@link YarnConfiguration#APPLICATION_MAX_TAGS} are allowed
  4765. per application. Each tag can be at most
  4766. {@link YarnConfiguration#APPLICATION_MAX_TAG_LENGTH}
  4767. characters, and can contain only ASCII characters.
  4768. @param tags tags to set]]>
  4769. </doc>
  4770. </method>
  4771. <method name="getNodeLabelExpression" return="java.lang.String"
  4772. abstract="true" native="false" synchronized="false"
  4773. static="false" final="false" visibility="public"
  4774. deprecated="not deprecated">
  4775. <doc>
  4776. <![CDATA[Get node-label-expression for this app. If this is set, all containers of
  4777. this application without setting node-label-expression in ResurceRequest
  4778. will get allocated resources on only those nodes that satisfy this
  4779. node-label-expression.
  4780. If different node-label-expression of this app and ResourceRequest are set
  4781. at the same time, the one set in ResourceRequest will be used when
  4782. allocating container
  4783. @return node-label-expression for this app]]>
  4784. </doc>
  4785. </method>
  4786. <method name="setNodeLabelExpression"
  4787. abstract="true" native="false" synchronized="false"
  4788. static="false" final="false" visibility="public"
  4789. deprecated="not deprecated">
  4790. <param name="nodeLabelExpression" type="java.lang.String"/>
  4791. <doc>
  4792. <![CDATA[Set node-label-expression for this app
  4793. @param nodeLabelExpression node-label-expression of this app]]>
  4794. </doc>
  4795. </method>
  4796. <method name="getAMContainerResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  4797. abstract="true" native="false" synchronized="false"
  4798. static="false" final="false" visibility="public"
  4799. deprecated="not deprecated">
  4800. <doc>
  4801. <![CDATA[Get ResourceRequest of AM container, if this is not null, scheduler will
  4802. use this to acquire resource for AM container.
  4803. If this is null, scheduler will assemble a ResourceRequest by using
  4804. <em>getResource</em> and <em>getPriority</em> of
  4805. <em>ApplicationSubmissionContext</em>.
  4806. Number of containers and Priority will be ignore.
  4807. @return ResourceRequest of AM container]]>
  4808. </doc>
  4809. </method>
  4810. <method name="setAMContainerResourceRequest"
  4811. abstract="true" native="false" synchronized="false"
  4812. static="false" final="false" visibility="public"
  4813. deprecated="not deprecated">
  4814. <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  4815. <doc>
  4816. <![CDATA[Set ResourceRequest of AM container
  4817. @param request of AM container]]>
  4818. </doc>
  4819. </method>
  4820. <method name="getAttemptFailuresValidityInterval" return="long"
  4821. abstract="true" native="false" synchronized="false"
  4822. static="false" final="false" visibility="public"
  4823. deprecated="not deprecated">
  4824. <doc>
  4825. <![CDATA[Get the attemptFailuresValidityInterval in milliseconds for the application
  4826. @return the attemptFailuresValidityInterval]]>
  4827. </doc>
  4828. </method>
  4829. <method name="setAttemptFailuresValidityInterval"
  4830. abstract="true" native="false" synchronized="false"
  4831. static="false" final="false" visibility="public"
  4832. deprecated="not deprecated">
  4833. <param name="attemptFailuresValidityInterval" type="long"/>
  4834. <doc>
  4835. <![CDATA[Set the attemptFailuresValidityInterval in milliseconds for the application
  4836. @param attemptFailuresValidityInterval]]>
  4837. </doc>
  4838. </method>
  4839. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  4840. abstract="true" native="false" synchronized="false"
  4841. static="false" final="false" visibility="public"
  4842. deprecated="not deprecated">
  4843. <doc>
  4844. <![CDATA[Get <code>LogAggregationContext</code> of the application
  4845. @return <code>LogAggregationContext</code> of the application]]>
  4846. </doc>
  4847. </method>
  4848. <method name="setLogAggregationContext"
  4849. abstract="true" native="false" synchronized="false"
  4850. static="false" final="false" visibility="public"
  4851. deprecated="not deprecated">
  4852. <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
  4853. <doc>
  4854. <![CDATA[Set <code>LogAggregationContext</code> for the application
  4855. @param logAggregationContext
  4856. for the application]]>
  4857. </doc>
  4858. </method>
  4859. <method name="getReservationID" return="org.apache.hadoop.yarn.api.records.ReservationId"
  4860. abstract="true" native="false" synchronized="false"
  4861. static="false" final="false" visibility="public"
  4862. deprecated="not deprecated">
  4863. <doc>
  4864. <![CDATA[Get the reservation id, that corresponds to a valid resource allocation in
  4865. the scheduler (between start and end time of the corresponding reservation)
  4866. @return the reservation id representing the unique id of the corresponding
  4867. reserved resource allocation in the scheduler]]>
  4868. </doc>
  4869. </method>
  4870. <method name="setReservationID"
  4871. abstract="true" native="false" synchronized="false"
  4872. static="false" final="false" visibility="public"
  4873. deprecated="not deprecated">
  4874. <param name="reservationID" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  4875. <doc>
  4876. <![CDATA[Set the reservation id, that correspond to a valid resource allocation in
  4877. the scheduler (between start and end time of the corresponding reservation)
  4878. @param reservationID representing the unique id of the
  4879. corresponding reserved resource allocation in the scheduler]]>
  4880. </doc>
  4881. </method>
  4882. <doc>
  4883. <![CDATA[{@code ApplicationSubmissionContext} represents all of the
  4884. information needed by the {@code ResourceManager} to launch
  4885. the {@code ApplicationMaster} for an application.
  4886. <p>
  4887. It includes details such as:
  4888. <ul>
  4889. <li>{@link ApplicationId} of the application.</li>
  4890. <li>Application user.</li>
  4891. <li>Application name.</li>
  4892. <li>{@link Priority} of the application.</li>
  4893. <li>
  4894. {@link ContainerLaunchContext} of the container in which the
  4895. <code>ApplicationMaster</code> is executed.
  4896. </li>
  4897. <li>
  4898. maxAppAttempts. The maximum number of application attempts.
  4899. It should be no larger than the global number of max attempts in the
  4900. Yarn configuration.
  4901. </li>
  4902. <li>
  4903. attemptFailuresValidityInterval. The default value is -1.
  4904. when attemptFailuresValidityInterval in milliseconds is set to
  4905. {@literal >} 0, the failure number will no take failures which happen
  4906. out of the validityInterval into failure count. If failure count
  4907. reaches to maxAppAttempts, the application will be failed.
  4908. </li>
  4909. <li>Optional, application-specific {@link LogAggregationContext}</li>
  4910. </ul>
  4911. @see ContainerLaunchContext
  4912. @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)]]>
  4913. </doc>
  4914. </class>
  4915. <!-- end class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
  4916. <!-- start class org.apache.hadoop.yarn.api.records.Container -->
  4917. <class name="Container" extends="java.lang.Object"
  4918. abstract="true"
  4919. static="false" final="false" visibility="public"
  4920. deprecated="not deprecated">
  4921. <implements name="java.lang.Comparable"/>
  4922. <constructor name="Container"
  4923. static="false" final="false" visibility="public"
  4924. deprecated="not deprecated">
  4925. </constructor>
  4926. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  4927. abstract="true" native="false" synchronized="false"
  4928. static="false" final="false" visibility="public"
  4929. deprecated="not deprecated">
  4930. <doc>
  4931. <![CDATA[Get the globally unique identifier for the container.
  4932. @return globally unique identifier for the container]]>
  4933. </doc>
  4934. </method>
  4935. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  4936. abstract="true" native="false" synchronized="false"
  4937. static="false" final="false" visibility="public"
  4938. deprecated="not deprecated">
  4939. <doc>
  4940. <![CDATA[Get the identifier of the node on which the container is allocated.
  4941. @return identifier of the node on which the container is allocated]]>
  4942. </doc>
  4943. </method>
  4944. <method name="getNodeHttpAddress" return="java.lang.String"
  4945. abstract="true" native="false" synchronized="false"
  4946. static="false" final="false" visibility="public"
  4947. deprecated="not deprecated">
  4948. <doc>
  4949. <![CDATA[Get the http uri of the node on which the container is allocated.
  4950. @return http uri of the node on which the container is allocated]]>
  4951. </doc>
  4952. </method>
  4953. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  4954. abstract="true" native="false" synchronized="false"
  4955. static="false" final="false" visibility="public"
  4956. deprecated="not deprecated">
  4957. <doc>
  4958. <![CDATA[Get the <code>Resource</code> allocated to the container.
  4959. @return <code>Resource</code> allocated to the container]]>
  4960. </doc>
  4961. </method>
  4962. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  4963. abstract="true" native="false" synchronized="false"
  4964. static="false" final="false" visibility="public"
  4965. deprecated="not deprecated">
  4966. <doc>
  4967. <![CDATA[Get the <code>Priority</code> at which the <code>Container</code> was
  4968. allocated.
  4969. @return <code>Priority</code> at which the <code>Container</code> was
  4970. allocated]]>
  4971. </doc>
  4972. </method>
  4973. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  4974. abstract="true" native="false" synchronized="false"
  4975. static="false" final="false" visibility="public"
  4976. deprecated="not deprecated">
  4977. <doc>
  4978. <![CDATA[Get the <code>ContainerToken</code> for the container.
  4979. <p><code>ContainerToken</code> is the security token used by the framework
  4980. to verify authenticity of any <code>Container</code>.</p>
  4981. <p>The <code>ResourceManager</code>, on container allocation provides a
  4982. secure token which is verified by the <code>NodeManager</code> on
  4983. container launch.</p>
  4984. <p>Applications do not need to care about <code>ContainerToken</code>, they
  4985. are transparently handled by the framework - the allocated
  4986. <code>Container</code> includes the <code>ContainerToken</code>.</p>
  4987. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  4988. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  4989. @return <code>ContainerToken</code> for the container]]>
  4990. </doc>
  4991. </method>
  4992. <doc>
  4993. <![CDATA[{@code Container} represents an allocated resource in the cluster.
  4994. <p>
  4995. The {@code ResourceManager} is the sole authority to allocate any
  4996. {@code Container} to applications. The allocated {@code Container}
  4997. is always on a single node and has a unique {@link ContainerId}. It has
  4998. a specific amount of {@link Resource} allocated.
  4999. <p>
  5000. It includes details such as:
  5001. <ul>
  5002. <li>{@link ContainerId} for the container, which is globally unique.</li>
  5003. <li>
  5004. {@link NodeId} of the node on which it is allocated.
  5005. </li>
  5006. <li>HTTP uri of the node.</li>
  5007. <li>{@link Resource} allocated to the container.</li>
  5008. <li>{@link Priority} at which the container was allocated.</li>
  5009. <li>
  5010. Container {@link Token} of the container, used to securely verify
  5011. authenticity of the allocation.
  5012. </li>
  5013. </ul>
  5014. Typically, an {@code ApplicationMaster} receives the {@code Container}
  5015. from the {@code ResourceManager} during resource-negotiation and then
  5016. talks to the {@code NodeManager} to start/stop containers.
  5017. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
  5018. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
  5019. @see ContainerManagementProtocol#stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)]]>
  5020. </doc>
  5021. </class>
  5022. <!-- end class org.apache.hadoop.yarn.api.records.Container -->
  5023. <!-- start class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  5024. <class name="ContainerExitStatus" extends="java.lang.Object"
  5025. abstract="false"
  5026. static="false" final="false" visibility="public"
  5027. deprecated="not deprecated">
  5028. <constructor name="ContainerExitStatus"
  5029. static="false" final="false" visibility="public"
  5030. deprecated="not deprecated">
  5031. </constructor>
  5032. <field name="SUCCESS" type="int"
  5033. transient="false" volatile="false"
  5034. static="true" final="true" visibility="public"
  5035. deprecated="not deprecated">
  5036. </field>
  5037. <field name="INVALID" type="int"
  5038. transient="false" volatile="false"
  5039. static="true" final="true" visibility="public"
  5040. deprecated="not deprecated">
  5041. </field>
  5042. <field name="ABORTED" type="int"
  5043. transient="false" volatile="false"
  5044. static="true" final="true" visibility="public"
  5045. deprecated="not deprecated">
  5046. <doc>
  5047. <![CDATA[Containers killed by the framework, either due to being released by
  5048. the application or being 'lost' due to node failures etc.]]>
  5049. </doc>
  5050. </field>
  5051. <field name="DISKS_FAILED" type="int"
  5052. transient="false" volatile="false"
  5053. static="true" final="true" visibility="public"
  5054. deprecated="not deprecated">
  5055. <doc>
  5056. <![CDATA[When threshold number of the nodemanager-local-directories or
  5057. threshold number of the nodemanager-log-directories become bad.]]>
  5058. </doc>
  5059. </field>
  5060. <field name="PREEMPTED" type="int"
  5061. transient="false" volatile="false"
  5062. static="true" final="true" visibility="public"
  5063. deprecated="not deprecated">
  5064. <doc>
  5065. <![CDATA[Containers preempted by the framework.]]>
  5066. </doc>
  5067. </field>
  5068. <field name="KILLED_EXCEEDED_VMEM" type="int"
  5069. transient="false" volatile="false"
  5070. static="true" final="true" visibility="public"
  5071. deprecated="not deprecated">
  5072. <doc>
  5073. <![CDATA[Container terminated because of exceeding allocated virtual memory.]]>
  5074. </doc>
  5075. </field>
  5076. <field name="KILLED_EXCEEDED_PMEM" type="int"
  5077. transient="false" volatile="false"
  5078. static="true" final="true" visibility="public"
  5079. deprecated="not deprecated">
  5080. <doc>
  5081. <![CDATA[Container terminated because of exceeding allocated physical memory.]]>
  5082. </doc>
  5083. </field>
  5084. <field name="KILLED_BY_APPMASTER" type="int"
  5085. transient="false" volatile="false"
  5086. static="true" final="true" visibility="public"
  5087. deprecated="not deprecated">
  5088. <doc>
  5089. <![CDATA[Container was terminated by stop request by the app master.]]>
  5090. </doc>
  5091. </field>
  5092. <field name="KILLED_BY_RESOURCEMANAGER" type="int"
  5093. transient="false" volatile="false"
  5094. static="true" final="true" visibility="public"
  5095. deprecated="not deprecated">
  5096. <doc>
  5097. <![CDATA[Container was terminated by the resource manager.]]>
  5098. </doc>
  5099. </field>
  5100. <field name="KILLED_AFTER_APP_COMPLETION" type="int"
  5101. transient="false" volatile="false"
  5102. static="true" final="true" visibility="public"
  5103. deprecated="not deprecated">
  5104. <doc>
  5105. <![CDATA[Container was terminated after the application finished.]]>
  5106. </doc>
  5107. </field>
  5108. <doc>
  5109. <![CDATA[Container exit statuses indicating special exit circumstances.]]>
  5110. </doc>
  5111. </class>
  5112. <!-- end class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
  5113. <!-- start class org.apache.hadoop.yarn.api.records.ContainerId -->
  5114. <class name="ContainerId" extends="java.lang.Object"
  5115. abstract="true"
  5116. static="false" final="false" visibility="public"
  5117. deprecated="not deprecated">
  5118. <implements name="java.lang.Comparable"/>
  5119. <constructor name="ContainerId"
  5120. static="false" final="false" visibility="public"
  5121. deprecated="not deprecated">
  5122. </constructor>
  5123. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  5124. abstract="true" native="false" synchronized="false"
  5125. static="false" final="false" visibility="public"
  5126. deprecated="not deprecated">
  5127. <doc>
  5128. <![CDATA[Get the <code>ApplicationAttemptId</code> of the application to which the
  5129. <code>Container</code> was assigned.
  5130. <p>
  5131. Note: If containers are kept alive across application attempts via
  5132. {@link ApplicationSubmissionContext#setKeepContainersAcrossApplicationAttempts(boolean)}
  5133. the <code>ContainerId</code> does not necessarily contain the current
  5134. running application attempt's <code>ApplicationAttemptId</code> This
  5135. container can be allocated by previously exited application attempt and
  5136. managed by the current running attempt thus have the previous application
  5137. attempt's <code>ApplicationAttemptId</code>.
  5138. </p>
  5139. @return <code>ApplicationAttemptId</code> of the application to which the
  5140. <code>Container</code> was assigned]]>
  5141. </doc>
  5142. </method>
  5143. <method name="getId" return="int"
  5144. abstract="true" native="false" synchronized="false"
  5145. static="false" final="false" visibility="public"
  5146. deprecated="not deprecated">
  5147. <doc>
  5148. <![CDATA[Get the lower 32 bits of identifier of the <code>ContainerId</code>,
  5149. which doesn't include epoch. Note that this method will be marked as
  5150. deprecated, so please use <code>getContainerId</code> instead.
  5151. @return lower 32 bits of identifier of the <code>ContainerId</code>]]>
  5152. </doc>
  5153. </method>
  5154. <method name="getContainerId" return="long"
  5155. abstract="true" native="false" synchronized="false"
  5156. static="false" final="false" visibility="public"
  5157. deprecated="not deprecated">
  5158. <doc>
  5159. <![CDATA[Get the identifier of the <code>ContainerId</code>. Upper 24 bits are
  5160. reserved as epoch of cluster, and lower 40 bits are reserved as
  5161. sequential number of containers.
  5162. @return identifier of the <code>ContainerId</code>]]>
  5163. </doc>
  5164. </method>
  5165. <method name="hashCode" return="int"
  5166. abstract="false" native="false" synchronized="false"
  5167. static="false" final="false" visibility="public"
  5168. deprecated="not deprecated">
  5169. </method>
  5170. <method name="equals" return="boolean"
  5171. abstract="false" native="false" synchronized="false"
  5172. static="false" final="false" visibility="public"
  5173. deprecated="not deprecated">
  5174. <param name="obj" type="java.lang.Object"/>
  5175. </method>
  5176. <method name="compareTo" return="int"
  5177. abstract="false" native="false" synchronized="false"
  5178. static="false" final="false" visibility="public"
  5179. deprecated="not deprecated">
  5180. <param name="other" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5181. </method>
  5182. <method name="toString" return="java.lang.String"
  5183. abstract="false" native="false" synchronized="false"
  5184. static="false" final="false" visibility="public"
  5185. deprecated="not deprecated">
  5186. <doc>
  5187. <![CDATA[@return A string representation of containerId. The format is
  5188. container_e*epoch*_*clusterTimestamp*_*appId*_*attemptId*_*containerId*
  5189. when epoch is larger than 0
  5190. (e.g. container_e17_1410901177871_0001_01_000005).
  5191. *epoch* is increased when RM restarts or fails over.
  5192. When epoch is 0, epoch is omitted
  5193. (e.g. container_1410901177871_0001_01_000005).]]>
  5194. </doc>
  5195. </method>
  5196. <method name="fromString" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5197. abstract="false" native="false" synchronized="false"
  5198. static="true" final="false" visibility="public"
  5199. deprecated="not deprecated">
  5200. <param name="containerIdStr" type="java.lang.String"/>
  5201. </method>
  5202. <method name="build"
  5203. abstract="true" native="false" synchronized="false"
  5204. static="false" final="false" visibility="protected"
  5205. deprecated="not deprecated">
  5206. </method>
  5207. <field name="CONTAINER_ID_BITMASK" type="long"
  5208. transient="false" volatile="false"
  5209. static="true" final="true" visibility="public"
  5210. deprecated="not deprecated">
  5211. </field>
  5212. <doc>
  5213. <![CDATA[<p><code>ContainerId</code> represents a globally unique identifier
  5214. for a {@link Container} in the cluster.</p>]]>
  5215. </doc>
  5216. </class>
  5217. <!-- end class org.apache.hadoop.yarn.api.records.ContainerId -->
  5218. <!-- start class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  5219. <class name="ContainerLaunchContext" extends="java.lang.Object"
  5220. abstract="true"
  5221. static="false" final="false" visibility="public"
  5222. deprecated="not deprecated">
  5223. <constructor name="ContainerLaunchContext"
  5224. static="false" final="false" visibility="public"
  5225. deprecated="not deprecated">
  5226. </constructor>
  5227. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
  5228. abstract="false" native="false" synchronized="false"
  5229. static="true" final="false" visibility="public"
  5230. deprecated="not deprecated">
  5231. <param name="localResources" type="java.util.Map"/>
  5232. <param name="environment" type="java.util.Map"/>
  5233. <param name="commands" type="java.util.List"/>
  5234. <param name="serviceData" type="java.util.Map"/>
  5235. <param name="tokens" type="java.nio.ByteBuffer"/>
  5236. <param name="acls" type="java.util.Map"/>
  5237. </method>
  5238. <method name="getTokens" return="java.nio.ByteBuffer"
  5239. abstract="true" native="false" synchronized="false"
  5240. static="false" final="false" visibility="public"
  5241. deprecated="not deprecated">
  5242. <doc>
  5243. <![CDATA[Get all the tokens needed by this container. It may include file-system
  5244. tokens, ApplicationMaster related tokens if this container is an
  5245. ApplicationMaster or framework level tokens needed by this container to
  5246. communicate to various services in a secure manner.
  5247. @return tokens needed by this container.]]>
  5248. </doc>
  5249. </method>
  5250. <method name="setTokens"
  5251. abstract="true" native="false" synchronized="false"
  5252. static="false" final="false" visibility="public"
  5253. deprecated="not deprecated">
  5254. <param name="tokens" type="java.nio.ByteBuffer"/>
  5255. <doc>
  5256. <![CDATA[Set security tokens needed by this container.
  5257. @param tokens security tokens]]>
  5258. </doc>
  5259. </method>
  5260. <method name="getLocalResources" return="java.util.Map"
  5261. abstract="true" native="false" synchronized="false"
  5262. static="false" final="false" visibility="public"
  5263. deprecated="not deprecated">
  5264. <doc>
  5265. <![CDATA[Get <code>LocalResource</code> required by the container.
  5266. @return all <code>LocalResource</code> required by the container]]>
  5267. </doc>
  5268. </method>
  5269. <method name="setLocalResources"
  5270. abstract="true" native="false" synchronized="false"
  5271. static="false" final="false" visibility="public"
  5272. deprecated="not deprecated">
  5273. <param name="localResources" type="java.util.Map"/>
  5274. <doc>
  5275. <![CDATA[Set <code>LocalResource</code> required by the container. All pre-existing
  5276. Map entries are cleared before adding the new Map
  5277. @param localResources <code>LocalResource</code> required by the container]]>
  5278. </doc>
  5279. </method>
  5280. <method name="getServiceData" return="java.util.Map"
  5281. abstract="true" native="false" synchronized="false"
  5282. static="false" final="false" visibility="public"
  5283. deprecated="not deprecated">
  5284. <doc>
  5285. <![CDATA[<p>
  5286. Get application-specific binary <em>service data</em>. This is a map keyed
  5287. by the name of each {@link AuxiliaryService} that is configured on a
  5288. NodeManager and value correspond to the application specific data targeted
  5289. for the keyed {@link AuxiliaryService}.
  5290. </p>
  5291. <p>
  5292. This will be used to initialize this application on the specific
  5293. {@link AuxiliaryService} running on the NodeManager by calling
  5294. {@link AuxiliaryService#initializeApplication(ApplicationInitializationContext)}
  5295. </p>
  5296. @return application-specific binary <em>service data</em>]]>
  5297. </doc>
  5298. </method>
  5299. <method name="setServiceData"
  5300. abstract="true" native="false" synchronized="false"
  5301. static="false" final="false" visibility="public"
  5302. deprecated="not deprecated">
  5303. <param name="serviceData" type="java.util.Map"/>
  5304. <doc>
  5305. <![CDATA[<p>
  5306. Set application-specific binary <em>service data</em>. This is a map keyed
  5307. by the name of each {@link AuxiliaryService} that is configured on a
  5308. NodeManager and value correspond to the application specific data targeted
  5309. for the keyed {@link AuxiliaryService}. All pre-existing Map entries are
  5310. preserved.
  5311. </p>
  5312. @param serviceData
  5313. application-specific binary <em>service data</em>]]>
  5314. </doc>
  5315. </method>
  5316. <method name="getEnvironment" return="java.util.Map"
  5317. abstract="true" native="false" synchronized="false"
  5318. static="false" final="false" visibility="public"
  5319. deprecated="not deprecated">
  5320. <doc>
  5321. <![CDATA[Get <em>environment variables</em> for the container.
  5322. @return <em>environment variables</em> for the container]]>
  5323. </doc>
  5324. </method>
  5325. <method name="setEnvironment"
  5326. abstract="true" native="false" synchronized="false"
  5327. static="false" final="false" visibility="public"
  5328. deprecated="not deprecated">
  5329. <param name="environment" type="java.util.Map"/>
  5330. <doc>
  5331. <![CDATA[Add <em>environment variables</em> for the container. All pre-existing Map
  5332. entries are cleared before adding the new Map
  5333. @param environment <em>environment variables</em> for the container]]>
  5334. </doc>
  5335. </method>
  5336. <method name="getCommands" return="java.util.List"
  5337. abstract="true" native="false" synchronized="false"
  5338. static="false" final="false" visibility="public"
  5339. deprecated="not deprecated">
  5340. <doc>
  5341. <![CDATA[Get the list of <em>commands</em> for launching the container.
  5342. @return the list of <em>commands</em> for launching the container]]>
  5343. </doc>
  5344. </method>
  5345. <method name="setCommands"
  5346. abstract="true" native="false" synchronized="false"
  5347. static="false" final="false" visibility="public"
  5348. deprecated="not deprecated">
  5349. <param name="commands" type="java.util.List"/>
  5350. <doc>
  5351. <![CDATA[Add the list of <em>commands</em> for launching the container. All
  5352. pre-existing List entries are cleared before adding the new List
  5353. @param commands the list of <em>commands</em> for launching the container]]>
  5354. </doc>
  5355. </method>
  5356. <method name="getApplicationACLs" return="java.util.Map"
  5357. abstract="true" native="false" synchronized="false"
  5358. static="false" final="false" visibility="public"
  5359. deprecated="not deprecated">
  5360. <doc>
  5361. <![CDATA[Get the <code>ApplicationACL</code>s for the application.
  5362. @return all the <code>ApplicationACL</code>s]]>
  5363. </doc>
  5364. </method>
  5365. <method name="setApplicationACLs"
  5366. abstract="true" native="false" synchronized="false"
  5367. static="false" final="false" visibility="public"
  5368. deprecated="not deprecated">
  5369. <param name="acls" type="java.util.Map"/>
  5370. <doc>
  5371. <![CDATA[Set the <code>ApplicationACL</code>s for the application. All pre-existing
  5372. Map entries are cleared before adding the new Map
  5373. @param acls <code>ApplicationACL</code>s for the application]]>
  5374. </doc>
  5375. </method>
  5376. <doc>
  5377. <![CDATA[{@code ContainerLaunchContext} represents all of the information
  5378. needed by the {@code NodeManager} to launch a container.
  5379. <p>
  5380. It includes details such as:
  5381. <ul>
  5382. <li>{@link ContainerId} of the container.</li>
  5383. <li>{@link Resource} allocated to the container.</li>
  5384. <li>User to whom the container is allocated.</li>
  5385. <li>Security tokens (if security is enabled).</li>
  5386. <li>
  5387. {@link LocalResource} necessary for running the container such
  5388. as binaries, jar, shared-objects, side-files etc.
  5389. </li>
  5390. <li>Optional, application-specific binary service data.</li>
  5391. <li>Environment variables for the launched process.</li>
  5392. <li>Command to launch the container.</li>
  5393. </ul>
  5394. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  5395. </doc>
  5396. </class>
  5397. <!-- end class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
  5398. <!-- start class org.apache.hadoop.yarn.api.records.ContainerReport -->
  5399. <class name="ContainerReport" extends="java.lang.Object"
  5400. abstract="true"
  5401. static="false" final="false" visibility="public"
  5402. deprecated="not deprecated">
  5403. <constructor name="ContainerReport"
  5404. static="false" final="false" visibility="public"
  5405. deprecated="not deprecated">
  5406. </constructor>
  5407. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5408. abstract="true" native="false" synchronized="false"
  5409. static="false" final="false" visibility="public"
  5410. deprecated="not deprecated">
  5411. <doc>
  5412. <![CDATA[Get the <code>ContainerId</code> of the container.
  5413. @return <code>ContainerId</code> of the container.]]>
  5414. </doc>
  5415. </method>
  5416. <method name="setContainerId"
  5417. abstract="true" native="false" synchronized="false"
  5418. static="false" final="false" visibility="public"
  5419. deprecated="not deprecated">
  5420. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5421. </method>
  5422. <method name="getAllocatedResource" return="org.apache.hadoop.yarn.api.records.Resource"
  5423. abstract="true" native="false" synchronized="false"
  5424. static="false" final="false" visibility="public"
  5425. deprecated="not deprecated">
  5426. <doc>
  5427. <![CDATA[Get the allocated <code>Resource</code> of the container.
  5428. @return allocated <code>Resource</code> of the container.]]>
  5429. </doc>
  5430. </method>
  5431. <method name="setAllocatedResource"
  5432. abstract="true" native="false" synchronized="false"
  5433. static="false" final="false" visibility="public"
  5434. deprecated="not deprecated">
  5435. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5436. </method>
  5437. <method name="getAssignedNode" return="org.apache.hadoop.yarn.api.records.NodeId"
  5438. abstract="true" native="false" synchronized="false"
  5439. static="false" final="false" visibility="public"
  5440. deprecated="not deprecated">
  5441. <doc>
  5442. <![CDATA[Get the allocated <code>NodeId</code> where container is running.
  5443. @return allocated <code>NodeId</code> where container is running.]]>
  5444. </doc>
  5445. </method>
  5446. <method name="setAssignedNode"
  5447. abstract="true" native="false" synchronized="false"
  5448. static="false" final="false" visibility="public"
  5449. deprecated="not deprecated">
  5450. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  5451. </method>
  5452. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  5453. abstract="true" native="false" synchronized="false"
  5454. static="false" final="false" visibility="public"
  5455. deprecated="not deprecated">
  5456. <doc>
  5457. <![CDATA[Get the allocated <code>Priority</code> of the container.
  5458. @return allocated <code>Priority</code> of the container.]]>
  5459. </doc>
  5460. </method>
  5461. <method name="setPriority"
  5462. abstract="true" native="false" synchronized="false"
  5463. static="false" final="false" visibility="public"
  5464. deprecated="not deprecated">
  5465. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  5466. </method>
  5467. <method name="getCreationTime" return="long"
  5468. abstract="true" native="false" synchronized="false"
  5469. static="false" final="false" visibility="public"
  5470. deprecated="not deprecated">
  5471. <doc>
  5472. <![CDATA[Get the creation time of the container.
  5473. @return creation time of the container]]>
  5474. </doc>
  5475. </method>
  5476. <method name="setCreationTime"
  5477. abstract="true" native="false" synchronized="false"
  5478. static="false" final="false" visibility="public"
  5479. deprecated="not deprecated">
  5480. <param name="creationTime" type="long"/>
  5481. </method>
  5482. <method name="getFinishTime" return="long"
  5483. abstract="true" native="false" synchronized="false"
  5484. static="false" final="false" visibility="public"
  5485. deprecated="not deprecated">
  5486. <doc>
  5487. <![CDATA[Get the Finish time of the container.
  5488. @return Finish time of the container]]>
  5489. </doc>
  5490. </method>
  5491. <method name="setFinishTime"
  5492. abstract="true" native="false" synchronized="false"
  5493. static="false" final="false" visibility="public"
  5494. deprecated="not deprecated">
  5495. <param name="finishTime" type="long"/>
  5496. </method>
  5497. <method name="getDiagnosticsInfo" return="java.lang.String"
  5498. abstract="true" native="false" synchronized="false"
  5499. static="false" final="false" visibility="public"
  5500. deprecated="not deprecated">
  5501. <doc>
  5502. <![CDATA[Get the DiagnosticsInfo of the container.
  5503. @return DiagnosticsInfo of the container]]>
  5504. </doc>
  5505. </method>
  5506. <method name="setDiagnosticsInfo"
  5507. abstract="true" native="false" synchronized="false"
  5508. static="false" final="false" visibility="public"
  5509. deprecated="not deprecated">
  5510. <param name="diagnosticsInfo" type="java.lang.String"/>
  5511. </method>
  5512. <method name="getLogUrl" return="java.lang.String"
  5513. abstract="true" native="false" synchronized="false"
  5514. static="false" final="false" visibility="public"
  5515. deprecated="not deprecated">
  5516. <doc>
  5517. <![CDATA[Get the LogURL of the container.
  5518. @return LogURL of the container]]>
  5519. </doc>
  5520. </method>
  5521. <method name="setLogUrl"
  5522. abstract="true" native="false" synchronized="false"
  5523. static="false" final="false" visibility="public"
  5524. deprecated="not deprecated">
  5525. <param name="logUrl" type="java.lang.String"/>
  5526. </method>
  5527. <method name="getContainerState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  5528. abstract="true" native="false" synchronized="false"
  5529. static="false" final="false" visibility="public"
  5530. deprecated="not deprecated">
  5531. <doc>
  5532. <![CDATA[Get the final <code>ContainerState</code> of the container.
  5533. @return final <code>ContainerState</code> of the container.]]>
  5534. </doc>
  5535. </method>
  5536. <method name="setContainerState"
  5537. abstract="true" native="false" synchronized="false"
  5538. static="false" final="false" visibility="public"
  5539. deprecated="not deprecated">
  5540. <param name="containerState" type="org.apache.hadoop.yarn.api.records.ContainerState"/>
  5541. </method>
  5542. <method name="getContainerExitStatus" return="int"
  5543. abstract="true" native="false" synchronized="false"
  5544. static="false" final="false" visibility="public"
  5545. deprecated="not deprecated">
  5546. <doc>
  5547. <![CDATA[Get the final <code>exit status</code> of the container.
  5548. @return final <code>exit status</code> of the container.]]>
  5549. </doc>
  5550. </method>
  5551. <method name="setContainerExitStatus"
  5552. abstract="true" native="false" synchronized="false"
  5553. static="false" final="false" visibility="public"
  5554. deprecated="not deprecated">
  5555. <param name="containerExitStatus" type="int"/>
  5556. </method>
  5557. <method name="getNodeHttpAddress" return="java.lang.String"
  5558. abstract="true" native="false" synchronized="false"
  5559. static="false" final="false" visibility="public"
  5560. deprecated="not deprecated">
  5561. <doc>
  5562. <![CDATA[Get the Node Http address of the container
  5563. @return the node http address of the container]]>
  5564. </doc>
  5565. </method>
  5566. <doc>
  5567. <![CDATA[{@code ContainerReport} is a report of an container.
  5568. <p>
  5569. It includes details such as:
  5570. <ul>
  5571. <li>{@link ContainerId} of the container.</li>
  5572. <li>Allocated Resources to the container.</li>
  5573. <li>Assigned Node id.</li>
  5574. <li>Assigned Priority.</li>
  5575. <li>Creation Time.</li>
  5576. <li>Finish Time.</li>
  5577. <li>Container Exit Status.</li>
  5578. <li>{@link ContainerState} of the container.</li>
  5579. <li>Diagnostic information in case of errors.</li>
  5580. <li>Log URL.</li>
  5581. <li>nodeHttpAddress</li>
  5582. </ul>]]>
  5583. </doc>
  5584. </class>
  5585. <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
  5586. <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceDecrease -->
  5587. <class name="ContainerResourceDecrease" extends="java.lang.Object"
  5588. abstract="true"
  5589. static="false" final="false" visibility="public"
  5590. deprecated="not deprecated">
  5591. <constructor name="ContainerResourceDecrease"
  5592. static="false" final="false" visibility="public"
  5593. deprecated="not deprecated">
  5594. </constructor>
  5595. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceDecrease"
  5596. abstract="false" native="false" synchronized="false"
  5597. static="true" final="false" visibility="public"
  5598. deprecated="not deprecated">
  5599. <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5600. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5601. </method>
  5602. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5603. abstract="true" native="false" synchronized="false"
  5604. static="false" final="false" visibility="public"
  5605. deprecated="not deprecated">
  5606. </method>
  5607. <method name="setContainerId"
  5608. abstract="true" native="false" synchronized="false"
  5609. static="false" final="false" visibility="public"
  5610. deprecated="not deprecated">
  5611. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5612. </method>
  5613. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  5614. abstract="true" native="false" synchronized="false"
  5615. static="false" final="false" visibility="public"
  5616. deprecated="not deprecated">
  5617. </method>
  5618. <method name="setCapability"
  5619. abstract="true" native="false" synchronized="false"
  5620. static="false" final="false" visibility="public"
  5621. deprecated="not deprecated">
  5622. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5623. </method>
  5624. <method name="hashCode" return="int"
  5625. abstract="false" native="false" synchronized="false"
  5626. static="false" final="false" visibility="public"
  5627. deprecated="not deprecated">
  5628. </method>
  5629. <method name="equals" return="boolean"
  5630. abstract="false" native="false" synchronized="false"
  5631. static="false" final="false" visibility="public"
  5632. deprecated="not deprecated">
  5633. <param name="other" type="java.lang.Object"/>
  5634. </method>
  5635. <doc>
  5636. <![CDATA[Used by Application Master to ask Node Manager reduce size of a specified
  5637. container]]>
  5638. </doc>
  5639. </class>
  5640. <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceDecrease -->
  5641. <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceIncrease -->
  5642. <class name="ContainerResourceIncrease" extends="java.lang.Object"
  5643. abstract="true"
  5644. static="false" final="false" visibility="public"
  5645. deprecated="not deprecated">
  5646. <constructor name="ContainerResourceIncrease"
  5647. static="false" final="false" visibility="public"
  5648. deprecated="not deprecated">
  5649. </constructor>
  5650. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceIncrease"
  5651. abstract="false" native="false" synchronized="false"
  5652. static="true" final="false" visibility="public"
  5653. deprecated="not deprecated">
  5654. <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5655. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5656. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  5657. </method>
  5658. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5659. abstract="true" native="false" synchronized="false"
  5660. static="false" final="false" visibility="public"
  5661. deprecated="not deprecated">
  5662. </method>
  5663. <method name="setContainerId"
  5664. abstract="true" native="false" synchronized="false"
  5665. static="false" final="false" visibility="public"
  5666. deprecated="not deprecated">
  5667. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5668. </method>
  5669. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  5670. abstract="true" native="false" synchronized="false"
  5671. static="false" final="false" visibility="public"
  5672. deprecated="not deprecated">
  5673. </method>
  5674. <method name="setCapability"
  5675. abstract="true" native="false" synchronized="false"
  5676. static="false" final="false" visibility="public"
  5677. deprecated="not deprecated">
  5678. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5679. </method>
  5680. <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
  5681. abstract="true" native="false" synchronized="false"
  5682. static="false" final="false" visibility="public"
  5683. deprecated="not deprecated">
  5684. </method>
  5685. <method name="setContainerToken"
  5686. abstract="true" native="false" synchronized="false"
  5687. static="false" final="false" visibility="public"
  5688. deprecated="not deprecated">
  5689. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  5690. </method>
  5691. <method name="hashCode" return="int"
  5692. abstract="false" native="false" synchronized="false"
  5693. static="false" final="false" visibility="public"
  5694. deprecated="not deprecated">
  5695. </method>
  5696. <method name="equals" return="boolean"
  5697. abstract="false" native="false" synchronized="false"
  5698. static="false" final="false" visibility="public"
  5699. deprecated="not deprecated">
  5700. <param name="other" type="java.lang.Object"/>
  5701. </method>
  5702. <doc>
  5703. <![CDATA[Represent a new increased container accepted by Resource Manager]]>
  5704. </doc>
  5705. </class>
  5706. <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceIncrease -->
  5707. <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
  5708. <class name="ContainerResourceIncreaseRequest" extends="java.lang.Object"
  5709. abstract="true"
  5710. static="false" final="false" visibility="public"
  5711. deprecated="not deprecated">
  5712. <constructor name="ContainerResourceIncreaseRequest"
  5713. static="false" final="false" visibility="public"
  5714. deprecated="not deprecated">
  5715. </constructor>
  5716. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest"
  5717. abstract="false" native="false" synchronized="false"
  5718. static="true" final="false" visibility="public"
  5719. deprecated="not deprecated">
  5720. <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5721. <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5722. </method>
  5723. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5724. abstract="true" native="false" synchronized="false"
  5725. static="false" final="false" visibility="public"
  5726. deprecated="not deprecated">
  5727. </method>
  5728. <method name="setContainerId"
  5729. abstract="true" native="false" synchronized="false"
  5730. static="false" final="false" visibility="public"
  5731. deprecated="not deprecated">
  5732. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  5733. </method>
  5734. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  5735. abstract="true" native="false" synchronized="false"
  5736. static="false" final="false" visibility="public"
  5737. deprecated="not deprecated">
  5738. </method>
  5739. <method name="setCapability"
  5740. abstract="true" native="false" synchronized="false"
  5741. static="false" final="false" visibility="public"
  5742. deprecated="not deprecated">
  5743. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  5744. </method>
  5745. <method name="hashCode" return="int"
  5746. abstract="false" native="false" synchronized="false"
  5747. static="false" final="false" visibility="public"
  5748. deprecated="not deprecated">
  5749. </method>
  5750. <method name="equals" return="boolean"
  5751. abstract="false" native="false" synchronized="false"
  5752. static="false" final="false" visibility="public"
  5753. deprecated="not deprecated">
  5754. <param name="other" type="java.lang.Object"/>
  5755. </method>
  5756. <doc>
  5757. <![CDATA[Used by Application Master, send a container resource increase request to
  5758. Resource Manager]]>
  5759. </doc>
  5760. </class>
  5761. <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
  5762. <!-- start class org.apache.hadoop.yarn.api.records.ContainerState -->
  5763. <class name="ContainerState" extends="java.lang.Enum"
  5764. abstract="false"
  5765. static="false" final="true" visibility="public"
  5766. deprecated="not deprecated">
  5767. <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerState[]"
  5768. abstract="false" native="false" synchronized="false"
  5769. static="true" final="false" visibility="public"
  5770. deprecated="not deprecated">
  5771. </method>
  5772. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerState"
  5773. abstract="false" native="false" synchronized="false"
  5774. static="true" final="false" visibility="public"
  5775. deprecated="not deprecated">
  5776. <param name="name" type="java.lang.String"/>
  5777. </method>
  5778. <doc>
  5779. <![CDATA[<p>State of a <code>Container</code>.</p>]]>
  5780. </doc>
  5781. </class>
  5782. <!-- end class org.apache.hadoop.yarn.api.records.ContainerState -->
  5783. <!-- start class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  5784. <class name="ContainerStatus" extends="java.lang.Object"
  5785. abstract="true"
  5786. static="false" final="false" visibility="public"
  5787. deprecated="not deprecated">
  5788. <constructor name="ContainerStatus"
  5789. static="false" final="false" visibility="public"
  5790. deprecated="not deprecated">
  5791. </constructor>
  5792. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  5793. abstract="true" native="false" synchronized="false"
  5794. static="false" final="false" visibility="public"
  5795. deprecated="not deprecated">
  5796. <doc>
  5797. <![CDATA[Get the <code>ContainerId</code> of the container.
  5798. @return <code>ContainerId</code> of the container]]>
  5799. </doc>
  5800. </method>
  5801. <method name="getState" return="org.apache.hadoop.yarn.api.records.ContainerState"
  5802. abstract="true" native="false" synchronized="false"
  5803. static="false" final="false" visibility="public"
  5804. deprecated="not deprecated">
  5805. <doc>
  5806. <![CDATA[Get the <code>ContainerState</code> of the container.
  5807. @return <code>ContainerState</code> of the container]]>
  5808. </doc>
  5809. </method>
  5810. <method name="getExitStatus" return="int"
  5811. abstract="true" native="false" synchronized="false"
  5812. static="false" final="false" visibility="public"
  5813. deprecated="not deprecated">
  5814. <doc>
  5815. <![CDATA[<p>Get the <em>exit status</em> for the container.</p>
  5816. <p>Note: This is valid only for completed containers i.e. containers
  5817. with state {@link ContainerState#COMPLETE}.
  5818. Otherwise, it returns an ContainerExitStatus.INVALID.
  5819. </p>
  5820. <p>Containers killed by the framework, either due to being released by
  5821. the application or being 'lost' due to node failures etc. have a special
  5822. exit code of ContainerExitStatus.ABORTED.</p>
  5823. <p>When threshold number of the nodemanager-local-directories or
  5824. threshold number of the nodemanager-log-directories become bad, then
  5825. container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.
  5826. </p>
  5827. @return <em>exit status</em> for the container]]>
  5828. </doc>
  5829. </method>
  5830. <method name="getDiagnostics" return="java.lang.String"
  5831. abstract="true" native="false" synchronized="false"
  5832. static="false" final="false" visibility="public"
  5833. deprecated="not deprecated">
  5834. <doc>
  5835. <![CDATA[Get <em>diagnostic messages</em> for failed containers.
  5836. @return <em>diagnostic messages</em> for failed containers]]>
  5837. </doc>
  5838. </method>
  5839. <doc>
  5840. <![CDATA[{@code ContainerStatus} represents the current status of a
  5841. {@code Container}.
  5842. <p>
  5843. It provides details such as:
  5844. <ul>
  5845. <li>{@code ContainerId} of the container.</li>
  5846. <li>{@code ContainerState} of the container.</li>
  5847. <li><em>Exit status</em> of a completed container.</li>
  5848. <li><em>Diagnostic</em> message for a failed container.</li>
  5849. </ul>]]>
  5850. </doc>
  5851. </class>
  5852. <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
  5853. <!-- start class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  5854. <class name="FinalApplicationStatus" extends="java.lang.Enum"
  5855. abstract="false"
  5856. static="false" final="true" visibility="public"
  5857. deprecated="not deprecated">
  5858. <method name="values" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus[]"
  5859. abstract="false" native="false" synchronized="false"
  5860. static="true" final="false" visibility="public"
  5861. deprecated="not deprecated">
  5862. </method>
  5863. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
  5864. abstract="false" native="false" synchronized="false"
  5865. static="true" final="false" visibility="public"
  5866. deprecated="not deprecated">
  5867. <param name="name" type="java.lang.String"/>
  5868. </method>
  5869. <doc>
  5870. <![CDATA[Enumeration of various final states of an <code>Application</code>.]]>
  5871. </doc>
  5872. </class>
  5873. <!-- end class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
  5874. <!-- start class org.apache.hadoop.yarn.api.records.LocalResource -->
  5875. <class name="LocalResource" extends="java.lang.Object"
  5876. abstract="true"
  5877. static="false" final="false" visibility="public"
  5878. deprecated="not deprecated">
  5879. <constructor name="LocalResource"
  5880. static="false" final="false" visibility="public"
  5881. deprecated="not deprecated">
  5882. </constructor>
  5883. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  5884. abstract="false" native="false" synchronized="false"
  5885. static="true" final="false" visibility="public"
  5886. deprecated="not deprecated">
  5887. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  5888. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  5889. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  5890. <param name="size" type="long"/>
  5891. <param name="timestamp" type="long"/>
  5892. <param name="pattern" type="java.lang.String"/>
  5893. </method>
  5894. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  5895. abstract="false" native="false" synchronized="false"
  5896. static="true" final="false" visibility="public"
  5897. deprecated="not deprecated">
  5898. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  5899. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  5900. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  5901. <param name="size" type="long"/>
  5902. <param name="timestamp" type="long"/>
  5903. <param name="pattern" type="java.lang.String"/>
  5904. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  5905. </method>
  5906. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  5907. abstract="false" native="false" synchronized="false"
  5908. static="true" final="false" visibility="public"
  5909. deprecated="not deprecated">
  5910. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  5911. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  5912. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  5913. <param name="size" type="long"/>
  5914. <param name="timestamp" type="long"/>
  5915. </method>
  5916. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
  5917. abstract="false" native="false" synchronized="false"
  5918. static="true" final="false" visibility="public"
  5919. deprecated="not deprecated">
  5920. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  5921. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  5922. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  5923. <param name="size" type="long"/>
  5924. <param name="timestamp" type="long"/>
  5925. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  5926. </method>
  5927. <method name="getResource" return="org.apache.hadoop.yarn.api.records.URL"
  5928. abstract="true" native="false" synchronized="false"
  5929. static="false" final="false" visibility="public"
  5930. deprecated="not deprecated">
  5931. <doc>
  5932. <![CDATA[Get the <em>location</em> of the resource to be localized.
  5933. @return <em>location</em> of the resource to be localized]]>
  5934. </doc>
  5935. </method>
  5936. <method name="setResource"
  5937. abstract="true" native="false" synchronized="false"
  5938. static="false" final="false" visibility="public"
  5939. deprecated="not deprecated">
  5940. <param name="resource" type="org.apache.hadoop.yarn.api.records.URL"/>
  5941. <doc>
  5942. <![CDATA[Set <em>location</em> of the resource to be localized.
  5943. @param resource <em>location</em> of the resource to be localized]]>
  5944. </doc>
  5945. </method>
  5946. <method name="getSize" return="long"
  5947. abstract="true" native="false" synchronized="false"
  5948. static="false" final="false" visibility="public"
  5949. deprecated="not deprecated">
  5950. <doc>
  5951. <![CDATA[Get the <em>size</em> of the resource to be localized.
  5952. @return <em>size</em> of the resource to be localized]]>
  5953. </doc>
  5954. </method>
  5955. <method name="setSize"
  5956. abstract="true" native="false" synchronized="false"
  5957. static="false" final="false" visibility="public"
  5958. deprecated="not deprecated">
  5959. <param name="size" type="long"/>
  5960. <doc>
  5961. <![CDATA[Set the <em>size</em> of the resource to be localized.
  5962. @param size <em>size</em> of the resource to be localized]]>
  5963. </doc>
  5964. </method>
  5965. <method name="getTimestamp" return="long"
  5966. abstract="true" native="false" synchronized="false"
  5967. static="false" final="false" visibility="public"
  5968. deprecated="not deprecated">
  5969. <doc>
  5970. <![CDATA[Get the original <em>timestamp</em> of the resource to be localized, used
  5971. for verification.
  5972. @return <em>timestamp</em> of the resource to be localized]]>
  5973. </doc>
  5974. </method>
  5975. <method name="setTimestamp"
  5976. abstract="true" native="false" synchronized="false"
  5977. static="false" final="false" visibility="public"
  5978. deprecated="not deprecated">
  5979. <param name="timestamp" type="long"/>
  5980. <doc>
  5981. <![CDATA[Set the <em>timestamp</em> of the resource to be localized, used
  5982. for verification.
  5983. @param timestamp <em>timestamp</em> of the resource to be localized]]>
  5984. </doc>
  5985. </method>
  5986. <method name="getType" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  5987. abstract="true" native="false" synchronized="false"
  5988. static="false" final="false" visibility="public"
  5989. deprecated="not deprecated">
  5990. <doc>
  5991. <![CDATA[Get the <code>LocalResourceType</code> of the resource to be localized.
  5992. @return <code>LocalResourceType</code> of the resource to be localized]]>
  5993. </doc>
  5994. </method>
  5995. <method name="setType"
  5996. abstract="true" native="false" synchronized="false"
  5997. static="false" final="false" visibility="public"
  5998. deprecated="not deprecated">
  5999. <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
  6000. <doc>
  6001. <![CDATA[Set the <code>LocalResourceType</code> of the resource to be localized.
  6002. @param type <code>LocalResourceType</code> of the resource to be localized]]>
  6003. </doc>
  6004. </method>
  6005. <method name="getVisibility" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  6006. abstract="true" native="false" synchronized="false"
  6007. static="false" final="false" visibility="public"
  6008. deprecated="not deprecated">
  6009. <doc>
  6010. <![CDATA[Get the <code>LocalResourceVisibility</code> of the resource to be
  6011. localized.
  6012. @return <code>LocalResourceVisibility</code> of the resource to be
  6013. localized]]>
  6014. </doc>
  6015. </method>
  6016. <method name="setVisibility"
  6017. abstract="true" native="false" synchronized="false"
  6018. static="false" final="false" visibility="public"
  6019. deprecated="not deprecated">
  6020. <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
  6021. <doc>
  6022. <![CDATA[Set the <code>LocalResourceVisibility</code> of the resource to be
  6023. localized.
  6024. @param visibility <code>LocalResourceVisibility</code> of the resource to be
  6025. localized]]>
  6026. </doc>
  6027. </method>
  6028. <method name="getPattern" return="java.lang.String"
  6029. abstract="true" native="false" synchronized="false"
  6030. static="false" final="false" visibility="public"
  6031. deprecated="not deprecated">
  6032. <doc>
  6033. <![CDATA[Get the <em>pattern</em> that should be used to extract entries from the
  6034. archive (only used when type is <code>PATTERN</code>).
  6035. @return <em>pattern</em> that should be used to extract entries from the
  6036. archive.]]>
  6037. </doc>
  6038. </method>
  6039. <method name="setPattern"
  6040. abstract="true" native="false" synchronized="false"
  6041. static="false" final="false" visibility="public"
  6042. deprecated="not deprecated">
  6043. <param name="pattern" type="java.lang.String"/>
  6044. <doc>
  6045. <![CDATA[Set the <em>pattern</em> that should be used to extract entries from the
  6046. archive (only used when type is <code>PATTERN</code>).
  6047. @param pattern <em>pattern</em> that should be used to extract entries
  6048. from the archive.]]>
  6049. </doc>
  6050. </method>
  6051. <method name="getShouldBeUploadedToSharedCache" return="boolean"
  6052. abstract="true" native="false" synchronized="false"
  6053. static="false" final="false" visibility="public"
  6054. deprecated="not deprecated">
  6055. <doc>
  6056. <![CDATA[NM uses it to decide whether if it is necessary to upload the resource to
  6057. the shared cache]]>
  6058. </doc>
  6059. </method>
  6060. <method name="setShouldBeUploadedToSharedCache"
  6061. abstract="true" native="false" synchronized="false"
  6062. static="false" final="false" visibility="public"
  6063. deprecated="not deprecated">
  6064. <param name="shouldBeUploadedToSharedCache" type="boolean"/>
  6065. <doc>
  6066. <![CDATA[Inform NM whether upload to SCM is needed.
  6067. @param shouldBeUploadedToSharedCache <em>shouldBeUploadedToSharedCache</em>
  6068. of this request]]>
  6069. </doc>
  6070. </method>
  6071. <doc>
  6072. <![CDATA[<p><code>LocalResource</code> represents a local resource required to
  6073. run a container.</p>
  6074. <p>The <code>NodeManager</code> is responsible for localizing the resource
  6075. prior to launching the container.</p>
  6076. <p>Applications can specify {@link LocalResourceType} and
  6077. {@link LocalResourceVisibility}.</p>
  6078. @see LocalResourceType
  6079. @see LocalResourceVisibility
  6080. @see ContainerLaunchContext
  6081. @see ApplicationSubmissionContext
  6082. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6083. </doc>
  6084. </class>
  6085. <!-- end class org.apache.hadoop.yarn.api.records.LocalResource -->
  6086. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  6087. <class name="LocalResourceType" extends="java.lang.Enum"
  6088. abstract="false"
  6089. static="false" final="true" visibility="public"
  6090. deprecated="not deprecated">
  6091. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceType[]"
  6092. abstract="false" native="false" synchronized="false"
  6093. static="true" final="false" visibility="public"
  6094. deprecated="not deprecated">
  6095. </method>
  6096. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
  6097. abstract="false" native="false" synchronized="false"
  6098. static="true" final="false" visibility="public"
  6099. deprecated="not deprecated">
  6100. <param name="name" type="java.lang.String"/>
  6101. </method>
  6102. <doc>
  6103. <![CDATA[{@code LocalResourceType} specifies the <em>type</em>
  6104. of a resource localized by the {@code NodeManager}.
  6105. <p>
  6106. The <em>type</em> can be one of:
  6107. <ul>
  6108. <li>
  6109. {@link #FILE} - Regular file i.e. uninterpreted bytes.
  6110. </li>
  6111. <li>
  6112. {@link #ARCHIVE} - Archive, which is automatically unarchived by the
  6113. <code>NodeManager</code>.
  6114. </li>
  6115. <li>
  6116. {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
  6117. </li>
  6118. </ul>
  6119. @see LocalResource
  6120. @see ContainerLaunchContext
  6121. @see ApplicationSubmissionContext
  6122. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6123. </doc>
  6124. </class>
  6125. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceType -->
  6126. <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  6127. <class name="LocalResourceVisibility" extends="java.lang.Enum"
  6128. abstract="false"
  6129. static="false" final="true" visibility="public"
  6130. deprecated="not deprecated">
  6131. <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility[]"
  6132. abstract="false" native="false" synchronized="false"
  6133. static="true" final="false" visibility="public"
  6134. deprecated="not deprecated">
  6135. </method>
  6136. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
  6137. abstract="false" native="false" synchronized="false"
  6138. static="true" final="false" visibility="public"
  6139. deprecated="not deprecated">
  6140. <param name="name" type="java.lang.String"/>
  6141. </method>
  6142. <doc>
  6143. <![CDATA[{@code LocalResourceVisibility} specifies the <em>visibility</em>
  6144. of a resource localized by the {@code NodeManager}.
  6145. <p>
  6146. The <em>visibility</em> can be one of:
  6147. <ul>
  6148. <li>{@link #PUBLIC} - Shared by all users on the node.</li>
  6149. <li>
  6150. {@link #PRIVATE} - Shared among all applications of the
  6151. <em>same user</em> on the node.
  6152. </li>
  6153. <li>
  6154. {@link #APPLICATION} - Shared only among containers of the
  6155. <em>same application</em> on the node.
  6156. </li>
  6157. </ul>
  6158. @see LocalResource
  6159. @see ContainerLaunchContext
  6160. @see ApplicationSubmissionContext
  6161. @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
  6162. </doc>
  6163. </class>
  6164. <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
  6165. <!-- start class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  6166. <class name="LogAggregationContext" extends="java.lang.Object"
  6167. abstract="true"
  6168. static="false" final="false" visibility="public"
  6169. deprecated="not deprecated">
  6170. <constructor name="LogAggregationContext"
  6171. static="false" final="false" visibility="public"
  6172. deprecated="not deprecated">
  6173. </constructor>
  6174. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  6175. abstract="false" native="false" synchronized="false"
  6176. static="true" final="false" visibility="public"
  6177. deprecated="not deprecated">
  6178. <param name="includePattern" type="java.lang.String"/>
  6179. <param name="excludePattern" type="java.lang.String"/>
  6180. </method>
  6181. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  6182. abstract="false" native="false" synchronized="false"
  6183. static="true" final="false" visibility="public"
  6184. deprecated="not deprecated">
  6185. <param name="includePattern" type="java.lang.String"/>
  6186. <param name="excludePattern" type="java.lang.String"/>
  6187. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  6188. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  6189. </method>
  6190. <method name="getIncludePattern" return="java.lang.String"
  6191. abstract="true" native="false" synchronized="false"
  6192. static="false" final="false" visibility="public"
  6193. deprecated="not deprecated">
  6194. <doc>
  6195. <![CDATA[Get include pattern. This includePattern only takes affect
  6196. on logs that exist at the time of application finish.
  6197. @return include pattern]]>
  6198. </doc>
  6199. </method>
  6200. <method name="setIncludePattern"
  6201. abstract="true" native="false" synchronized="false"
  6202. static="false" final="false" visibility="public"
  6203. deprecated="not deprecated">
  6204. <param name="includePattern" type="java.lang.String"/>
  6205. <doc>
  6206. <![CDATA[Set include pattern. This includePattern only takes affect
  6207. on logs that exist at the time of application finish.
  6208. @param includePattern]]>
  6209. </doc>
  6210. </method>
  6211. <method name="getExcludePattern" return="java.lang.String"
  6212. abstract="true" native="false" synchronized="false"
  6213. static="false" final="false" visibility="public"
  6214. deprecated="not deprecated">
  6215. <doc>
  6216. <![CDATA[Get exclude pattern. This excludePattern only takes affect
  6217. on logs that exist at the time of application finish.
  6218. @return exclude pattern]]>
  6219. </doc>
  6220. </method>
  6221. <method name="setExcludePattern"
  6222. abstract="true" native="false" synchronized="false"
  6223. static="false" final="false" visibility="public"
  6224. deprecated="not deprecated">
  6225. <param name="excludePattern" type="java.lang.String"/>
  6226. <doc>
  6227. <![CDATA[Set exclude pattern. This excludePattern only takes affect
  6228. on logs that exist at the time of application finish.
  6229. @param excludePattern]]>
  6230. </doc>
  6231. </method>
  6232. <method name="getRolledLogsIncludePattern" return="java.lang.String"
  6233. abstract="true" native="false" synchronized="false"
  6234. static="false" final="false" visibility="public"
  6235. deprecated="not deprecated">
  6236. <doc>
  6237. <![CDATA[Get include pattern in a rolling fashion.
  6238. @return include pattern]]>
  6239. </doc>
  6240. </method>
  6241. <method name="setRolledLogsIncludePattern"
  6242. abstract="true" native="false" synchronized="false"
  6243. static="false" final="false" visibility="public"
  6244. deprecated="not deprecated">
  6245. <param name="rolledLogsIncludePattern" type="java.lang.String"/>
  6246. <doc>
  6247. <![CDATA[Set include pattern in a rolling fashion.
  6248. @param rolledLogsIncludePattern]]>
  6249. </doc>
  6250. </method>
  6251. <method name="getRolledLogsExcludePattern" return="java.lang.String"
  6252. abstract="true" native="false" synchronized="false"
  6253. static="false" final="false" visibility="public"
  6254. deprecated="not deprecated">
  6255. <doc>
  6256. <![CDATA[Get exclude pattern for aggregation in a rolling fashion.
  6257. @return exclude pattern]]>
  6258. </doc>
  6259. </method>
  6260. <method name="setRolledLogsExcludePattern"
  6261. abstract="true" native="false" synchronized="false"
  6262. static="false" final="false" visibility="public"
  6263. deprecated="not deprecated">
  6264. <param name="rolledLogsExcludePattern" type="java.lang.String"/>
  6265. <doc>
  6266. <![CDATA[Set exclude pattern for in a rolling fashion.
  6267. @param rolledLogsExcludePattern]]>
  6268. </doc>
  6269. </method>
  6270. <doc>
  6271. <![CDATA[{@code LogAggregationContext} represents all of the
  6272. information needed by the {@code NodeManager} to handle
  6273. the logs for an application.
  6274. <p>
  6275. It includes details such as:
  6276. <ul>
  6277. <li>
  6278. includePattern. It uses Java Regex to filter the log files
  6279. which match the defined include pattern and those log files
  6280. will be uploaded when the application finishes.
  6281. </li>
  6282. <li>
  6283. excludePattern. It uses Java Regex to filter the log files
  6284. which match the defined exclude pattern and those log files
  6285. will not be uploaded when application finishes. If the log file
  6286. name matches both the include and the exclude pattern, this file
  6287. will be excluded eventually.
  6288. </li>
  6289. <li>
  6290. rolledLogsIncludePattern. It uses Java Regex to filter the log files
  6291. which match the defined include pattern and those log files
  6292. will be aggregated in a rolling fashion.
  6293. </li>
  6294. <li>
  6295. rolledLogsExcludePattern. It uses Java Regex to filter the log files
  6296. which match the defined exclude pattern and those log files
  6297. will not be aggregated in a rolling fashion. If the log file
  6298. name matches both the include and the exclude pattern, this file
  6299. will be excluded eventually.
  6300. </li>
  6301. </ul>
  6302. @see ApplicationSubmissionContext]]>
  6303. </doc>
  6304. </class>
  6305. <!-- end class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
  6306. <!-- start class org.apache.hadoop.yarn.api.records.NMToken -->
  6307. <class name="NMToken" extends="java.lang.Object"
  6308. abstract="true"
  6309. static="false" final="false" visibility="public"
  6310. deprecated="not deprecated">
  6311. <constructor name="NMToken"
  6312. static="false" final="false" visibility="public"
  6313. deprecated="not deprecated">
  6314. </constructor>
  6315. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  6316. abstract="true" native="false" synchronized="false"
  6317. static="false" final="false" visibility="public"
  6318. deprecated="not deprecated">
  6319. <doc>
  6320. <![CDATA[Get the {@link NodeId} of the <code>NodeManager</code> for which the NMToken
  6321. is used to authenticate.
  6322. @return the {@link NodeId} of the <code>NodeManager</code> for which the
  6323. NMToken is used to authenticate.]]>
  6324. </doc>
  6325. </method>
  6326. <method name="setNodeId"
  6327. abstract="true" native="false" synchronized="false"
  6328. static="false" final="false" visibility="public"
  6329. deprecated="not deprecated">
  6330. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  6331. </method>
  6332. <method name="getToken" return="org.apache.hadoop.yarn.api.records.Token"
  6333. abstract="true" native="false" synchronized="false"
  6334. static="false" final="false" visibility="public"
  6335. deprecated="not deprecated">
  6336. <doc>
  6337. <![CDATA[Get the {@link Token} used for authenticating with <code>NodeManager</code>
  6338. @return the {@link Token} used for authenticating with <code>NodeManager</code>]]>
  6339. </doc>
  6340. </method>
  6341. <method name="setToken"
  6342. abstract="true" native="false" synchronized="false"
  6343. static="false" final="false" visibility="public"
  6344. deprecated="not deprecated">
  6345. <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
  6346. </method>
  6347. <method name="hashCode" return="int"
  6348. abstract="false" native="false" synchronized="false"
  6349. static="false" final="false" visibility="public"
  6350. deprecated="not deprecated">
  6351. </method>
  6352. <method name="equals" return="boolean"
  6353. abstract="false" native="false" synchronized="false"
  6354. static="false" final="false" visibility="public"
  6355. deprecated="not deprecated">
  6356. <param name="obj" type="java.lang.Object"/>
  6357. </method>
  6358. <doc>
  6359. <![CDATA[<p>The NMToken is used for authenticating communication with
  6360. <code>NodeManager</code></p>
  6361. <p>It is issued by <code>ResourceMananger</code> when <code>ApplicationMaster</code>
  6362. negotiates resource with <code>ResourceManager</code> and
  6363. validated on <code>NodeManager</code> side.</p>
  6364. @see AllocateResponse#getNMTokens()]]>
  6365. </doc>
  6366. </class>
  6367. <!-- end class org.apache.hadoop.yarn.api.records.NMToken -->
  6368. <!-- start class org.apache.hadoop.yarn.api.records.NodeId -->
  6369. <class name="NodeId" extends="java.lang.Object"
  6370. abstract="true"
  6371. static="false" final="false" visibility="public"
  6372. deprecated="not deprecated">
  6373. <implements name="java.lang.Comparable"/>
  6374. <constructor name="NodeId"
  6375. static="false" final="false" visibility="public"
  6376. deprecated="not deprecated">
  6377. </constructor>
  6378. <method name="getHost" return="java.lang.String"
  6379. abstract="true" native="false" synchronized="false"
  6380. static="false" final="false" visibility="public"
  6381. deprecated="not deprecated">
  6382. <doc>
  6383. <![CDATA[Get the <em>hostname</em> of the node.
  6384. @return <em>hostname</em> of the node]]>
  6385. </doc>
  6386. </method>
  6387. <method name="getPort" return="int"
  6388. abstract="true" native="false" synchronized="false"
  6389. static="false" final="false" visibility="public"
  6390. deprecated="not deprecated">
  6391. <doc>
  6392. <![CDATA[Get the <em>port</em> for communicating with the node.
  6393. @return <em>port</em> for communicating with the node]]>
  6394. </doc>
  6395. </method>
  6396. <method name="toString" return="java.lang.String"
  6397. abstract="false" native="false" synchronized="false"
  6398. static="false" final="false" visibility="public"
  6399. deprecated="not deprecated">
  6400. </method>
  6401. <method name="hashCode" return="int"
  6402. abstract="false" native="false" synchronized="false"
  6403. static="false" final="false" visibility="public"
  6404. deprecated="not deprecated">
  6405. </method>
  6406. <method name="equals" return="boolean"
  6407. abstract="false" native="false" synchronized="false"
  6408. static="false" final="false" visibility="public"
  6409. deprecated="not deprecated">
  6410. <param name="obj" type="java.lang.Object"/>
  6411. </method>
  6412. <method name="compareTo" return="int"
  6413. abstract="false" native="false" synchronized="false"
  6414. static="false" final="false" visibility="public"
  6415. deprecated="not deprecated">
  6416. <param name="other" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  6417. </method>
  6418. <method name="build"
  6419. abstract="true" native="false" synchronized="false"
  6420. static="false" final="false" visibility="protected"
  6421. deprecated="not deprecated">
  6422. </method>
  6423. <doc>
  6424. <![CDATA[<p><code>NodeId</code> is the unique identifier for a node.</p>
  6425. <p>It includes the <em>hostname</em> and <em>port</em> to uniquely
  6426. identify the node. Thus, it is unique across restarts of any
  6427. <code>NodeManager</code>.</p>]]>
  6428. </doc>
  6429. </class>
  6430. <!-- end class org.apache.hadoop.yarn.api.records.NodeId -->
  6431. <!-- start class org.apache.hadoop.yarn.api.records.NodeReport -->
  6432. <class name="NodeReport" extends="java.lang.Object"
  6433. abstract="true"
  6434. static="false" final="false" visibility="public"
  6435. deprecated="not deprecated">
  6436. <constructor name="NodeReport"
  6437. static="false" final="false" visibility="public"
  6438. deprecated="not deprecated">
  6439. </constructor>
  6440. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  6441. abstract="true" native="false" synchronized="false"
  6442. static="false" final="false" visibility="public"
  6443. deprecated="not deprecated">
  6444. <doc>
  6445. <![CDATA[Get the <code>NodeId</code> of the node.
  6446. @return <code>NodeId</code> of the node]]>
  6447. </doc>
  6448. </method>
  6449. <method name="getNodeState" return="org.apache.hadoop.yarn.api.records.NodeState"
  6450. abstract="true" native="false" synchronized="false"
  6451. static="false" final="false" visibility="public"
  6452. deprecated="not deprecated">
  6453. <doc>
  6454. <![CDATA[Get the <code>NodeState</code> of the node.
  6455. @return <code>NodeState</code> of the node]]>
  6456. </doc>
  6457. </method>
  6458. <method name="getHttpAddress" return="java.lang.String"
  6459. abstract="true" native="false" synchronized="false"
  6460. static="false" final="false" visibility="public"
  6461. deprecated="not deprecated">
  6462. <doc>
  6463. <![CDATA[Get the <em>http address</em> of the node.
  6464. @return <em>http address</em> of the node]]>
  6465. </doc>
  6466. </method>
  6467. <method name="getRackName" return="java.lang.String"
  6468. abstract="true" native="false" synchronized="false"
  6469. static="false" final="false" visibility="public"
  6470. deprecated="not deprecated">
  6471. <doc>
  6472. <![CDATA[Get the <em>rack name</em> for the node.
  6473. @return <em>rack name</em> for the node]]>
  6474. </doc>
  6475. </method>
  6476. <method name="getUsed" return="org.apache.hadoop.yarn.api.records.Resource"
  6477. abstract="true" native="false" synchronized="false"
  6478. static="false" final="false" visibility="public"
  6479. deprecated="not deprecated">
  6480. <doc>
  6481. <![CDATA[Get <em>used</em> <code>Resource</code> on the node.
  6482. @return <em>used</em> <code>Resource</code> on the node]]>
  6483. </doc>
  6484. </method>
  6485. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  6486. abstract="true" native="false" synchronized="false"
  6487. static="false" final="false" visibility="public"
  6488. deprecated="not deprecated">
  6489. <doc>
  6490. <![CDATA[Get the <em>total</em> <code>Resource</code> on the node.
  6491. @return <em>total</em> <code>Resource</code> on the node]]>
  6492. </doc>
  6493. </method>
  6494. <method name="getHealthReport" return="java.lang.String"
  6495. abstract="true" native="false" synchronized="false"
  6496. static="false" final="false" visibility="public"
  6497. deprecated="not deprecated">
  6498. <doc>
  6499. <![CDATA[Get the <em>diagnostic health report</em> of the node.
  6500. @return <em>diagnostic health report</em> of the node]]>
  6501. </doc>
  6502. </method>
  6503. <method name="getLastHealthReportTime" return="long"
  6504. abstract="true" native="false" synchronized="false"
  6505. static="false" final="false" visibility="public"
  6506. deprecated="not deprecated">
  6507. <doc>
  6508. <![CDATA[Get the <em>last timestamp</em> at which the health report was received.
  6509. @return <em>last timestamp</em> at which the health report was received]]>
  6510. </doc>
  6511. </method>
  6512. <method name="getNodeLabels" return="java.util.Set"
  6513. abstract="true" native="false" synchronized="false"
  6514. static="false" final="false" visibility="public"
  6515. deprecated="not deprecated">
  6516. <doc>
  6517. <![CDATA[Get labels of this node
  6518. @return labels of this node]]>
  6519. </doc>
  6520. </method>
  6521. <doc>
  6522. <![CDATA[{@code NodeReport} is a summary of runtime information of a node
  6523. in the cluster.
  6524. <p>
  6525. It includes details such as:
  6526. <ul>
  6527. <li>{@link NodeId} of the node.</li>
  6528. <li>HTTP Tracking URL of the node.</li>
  6529. <li>Rack name for the node.</li>
  6530. <li>Used {@link Resource} on the node.</li>
  6531. <li>Total available {@link Resource} of the node.</li>
  6532. <li>Number of running containers on the node.</li>
  6533. </ul>
  6534. @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)]]>
  6535. </doc>
  6536. </class>
  6537. <!-- end class org.apache.hadoop.yarn.api.records.NodeReport -->
  6538. <!-- start class org.apache.hadoop.yarn.api.records.NodeState -->
  6539. <class name="NodeState" extends="java.lang.Enum"
  6540. abstract="false"
  6541. static="false" final="true" visibility="public"
  6542. deprecated="not deprecated">
  6543. <method name="values" return="org.apache.hadoop.yarn.api.records.NodeState[]"
  6544. abstract="false" native="false" synchronized="false"
  6545. static="true" final="false" visibility="public"
  6546. deprecated="not deprecated">
  6547. </method>
  6548. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeState"
  6549. abstract="false" native="false" synchronized="false"
  6550. static="true" final="false" visibility="public"
  6551. deprecated="not deprecated">
  6552. <param name="name" type="java.lang.String"/>
  6553. </method>
  6554. <method name="isUnusable" return="boolean"
  6555. abstract="false" native="false" synchronized="false"
  6556. static="false" final="false" visibility="public"
  6557. deprecated="not deprecated">
  6558. </method>
  6559. <doc>
  6560. <![CDATA[<p>State of a <code>Node</code>.</p>]]>
  6561. </doc>
  6562. </class>
  6563. <!-- end class org.apache.hadoop.yarn.api.records.NodeState -->
  6564. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  6565. <class name="PreemptionContainer" extends="java.lang.Object"
  6566. abstract="true"
  6567. static="false" final="false" visibility="public"
  6568. deprecated="not deprecated">
  6569. <constructor name="PreemptionContainer"
  6570. static="false" final="false" visibility="public"
  6571. deprecated="not deprecated">
  6572. </constructor>
  6573. <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  6574. abstract="true" native="false" synchronized="false"
  6575. static="false" final="false" visibility="public"
  6576. deprecated="not deprecated">
  6577. <doc>
  6578. <![CDATA[@return Container referenced by this handle.]]>
  6579. </doc>
  6580. </method>
  6581. <doc>
  6582. <![CDATA[Specific container requested back by the <code>ResourceManager</code>.
  6583. @see PreemptionContract
  6584. @see StrictPreemptionContract]]>
  6585. </doc>
  6586. </class>
  6587. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
  6588. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  6589. <class name="PreemptionContract" extends="java.lang.Object"
  6590. abstract="true"
  6591. static="false" final="false" visibility="public"
  6592. deprecated="not deprecated">
  6593. <constructor name="PreemptionContract"
  6594. static="false" final="false" visibility="public"
  6595. deprecated="not deprecated">
  6596. </constructor>
  6597. <method name="getResourceRequest" return="java.util.List"
  6598. abstract="true" native="false" synchronized="false"
  6599. static="false" final="false" visibility="public"
  6600. deprecated="not deprecated">
  6601. <doc>
  6602. <![CDATA[If the AM releases resources matching these requests, then the {@link
  6603. PreemptionContainer}s enumerated in {@link #getContainers()} should not be
  6604. evicted from the cluster. Due to delays in propagating cluster state and
  6605. sending these messages, there are conditions where satisfied contracts may
  6606. not prevent the platform from killing containers.
  6607. @return List of {@link PreemptionResourceRequest} to update the
  6608. <code>ApplicationMaster</code> about resources requested back by the
  6609. <code>ResourceManager</code>.
  6610. @see AllocateRequest#setAskList(List)]]>
  6611. </doc>
  6612. </method>
  6613. <method name="getContainers" return="java.util.Set"
  6614. abstract="true" native="false" synchronized="false"
  6615. static="false" final="false" visibility="public"
  6616. deprecated="not deprecated">
  6617. <doc>
  6618. <![CDATA[Assign the set of {@link PreemptionContainer} specifying which containers
  6619. owned by the <code>ApplicationMaster</code> that may be reclaimed by the
  6620. <code>ResourceManager</code>. If the AM prefers a different set of
  6621. containers, then it may checkpoint or kill containers matching the
  6622. description in {@link #getResourceRequest}.
  6623. @return Set of containers at risk if the contract is not met.]]>
  6624. </doc>
  6625. </method>
  6626. <doc>
  6627. <![CDATA[Description of resources requested back by the <code>ResourceManager</code>.
  6628. The <code>ApplicationMaster</code> (AM) can satisfy this request according
  6629. to its own priorities to prevent containers from being forcibly killed by
  6630. the platform.
  6631. @see PreemptionMessage]]>
  6632. </doc>
  6633. </class>
  6634. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContract -->
  6635. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  6636. <class name="PreemptionMessage" extends="java.lang.Object"
  6637. abstract="true"
  6638. static="false" final="false" visibility="public"
  6639. deprecated="not deprecated">
  6640. <constructor name="PreemptionMessage"
  6641. static="false" final="false" visibility="public"
  6642. deprecated="not deprecated">
  6643. </constructor>
  6644. <method name="getStrictContract" return="org.apache.hadoop.yarn.api.records.StrictPreemptionContract"
  6645. abstract="true" native="false" synchronized="false"
  6646. static="false" final="false" visibility="public"
  6647. deprecated="not deprecated">
  6648. <doc>
  6649. <![CDATA[@return Specific resources that may be killed by the
  6650. <code>ResourceManager</code>]]>
  6651. </doc>
  6652. </method>
  6653. <method name="getContract" return="org.apache.hadoop.yarn.api.records.PreemptionContract"
  6654. abstract="true" native="false" synchronized="false"
  6655. static="false" final="false" visibility="public"
  6656. deprecated="not deprecated">
  6657. <doc>
  6658. <![CDATA[@return Contract describing resources to return to the cluster.]]>
  6659. </doc>
  6660. </method>
  6661. <doc>
  6662. <![CDATA[A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by
  6663. the RM to specify resources that the RM wants to reclaim from this
  6664. {@code ApplicationMaster} (AM). The AM receives a {@link
  6665. StrictPreemptionContract} message encoding which containers the platform may
  6666. forcibly kill, granting it an opportunity to checkpoint state or adjust its
  6667. execution plan. The message may also include a {@link PreemptionContract}
  6668. granting the AM more latitude in selecting which resources to return to the
  6669. cluster.
  6670. <p>
  6671. The AM should decode both parts of the message. The {@link
  6672. StrictPreemptionContract} specifies particular allocations that the RM
  6673. requires back. The AM can checkpoint containers' state, adjust its execution
  6674. plan to move the computation, or take no action and hope that conditions that
  6675. caused the RM to ask for the container will change.
  6676. <p>
  6677. In contrast, the {@link PreemptionContract} also includes a description of
  6678. resources with a set of containers. If the AM releases containers matching
  6679. that profile, then the containers enumerated in {@link
  6680. PreemptionContract#getContainers()} may not be killed.
  6681. <p>
  6682. Each preemption message reflects the RM's current understanding of the
  6683. cluster state, so a request to return <em>N</em> containers may not
  6684. reflect containers the AM is releasing, recently exited containers the RM has
  6685. yet to learn about, or new containers allocated before the message was
  6686. generated. Conversely, an RM may request a different profile of containers in
  6687. subsequent requests.
  6688. <p>
  6689. The policy enforced by the RM is part of the scheduler. Generally, only
  6690. containers that have been requested consistently should be killed, but the
  6691. details are not specified.]]>
  6692. </doc>
  6693. </class>
  6694. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
  6695. <!-- start class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  6696. <class name="PreemptionResourceRequest" extends="java.lang.Object"
  6697. abstract="true"
  6698. static="false" final="false" visibility="public"
  6699. deprecated="not deprecated">
  6700. <constructor name="PreemptionResourceRequest"
  6701. static="false" final="false" visibility="public"
  6702. deprecated="not deprecated">
  6703. </constructor>
  6704. <method name="getResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  6705. abstract="true" native="false" synchronized="false"
  6706. static="false" final="false" visibility="public"
  6707. deprecated="not deprecated">
  6708. <doc>
  6709. <![CDATA[@return Resource described in this request, to be matched against running
  6710. containers.]]>
  6711. </doc>
  6712. </method>
  6713. <doc>
  6714. <![CDATA[Description of resources requested back by the cluster.
  6715. @see PreemptionContract
  6716. @see AllocateRequest#setAskList(java.util.List)]]>
  6717. </doc>
  6718. </class>
  6719. <!-- end class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
  6720. <!-- start class org.apache.hadoop.yarn.api.records.Priority -->
  6721. <class name="Priority" extends="java.lang.Object"
  6722. abstract="true"
  6723. static="false" final="false" visibility="public"
  6724. deprecated="not deprecated">
  6725. <implements name="java.lang.Comparable"/>
  6726. <constructor name="Priority"
  6727. static="false" final="false" visibility="public"
  6728. deprecated="not deprecated">
  6729. </constructor>
  6730. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Priority"
  6731. abstract="false" native="false" synchronized="false"
  6732. static="true" final="false" visibility="public"
  6733. deprecated="not deprecated">
  6734. <param name="p" type="int"/>
  6735. </method>
  6736. <method name="getPriority" return="int"
  6737. abstract="true" native="false" synchronized="false"
  6738. static="false" final="false" visibility="public"
  6739. deprecated="not deprecated">
  6740. <doc>
  6741. <![CDATA[Get the assigned priority
  6742. @return the assigned priority]]>
  6743. </doc>
  6744. </method>
  6745. <method name="setPriority"
  6746. abstract="true" native="false" synchronized="false"
  6747. static="false" final="false" visibility="public"
  6748. deprecated="not deprecated">
  6749. <param name="priority" type="int"/>
  6750. <doc>
  6751. <![CDATA[Set the assigned priority
  6752. @param priority the assigned priority]]>
  6753. </doc>
  6754. </method>
  6755. <method name="hashCode" return="int"
  6756. abstract="false" native="false" synchronized="false"
  6757. static="false" final="false" visibility="public"
  6758. deprecated="not deprecated">
  6759. </method>
  6760. <method name="equals" return="boolean"
  6761. abstract="false" native="false" synchronized="false"
  6762. static="false" final="false" visibility="public"
  6763. deprecated="not deprecated">
  6764. <param name="obj" type="java.lang.Object"/>
  6765. </method>
  6766. <method name="compareTo" return="int"
  6767. abstract="false" native="false" synchronized="false"
  6768. static="false" final="false" visibility="public"
  6769. deprecated="not deprecated">
  6770. <param name="other" type="org.apache.hadoop.yarn.api.records.Priority"/>
  6771. </method>
  6772. <method name="toString" return="java.lang.String"
  6773. abstract="false" native="false" synchronized="false"
  6774. static="false" final="false" visibility="public"
  6775. deprecated="not deprecated">
  6776. </method>
  6777. <field name="UNDEFINED" type="org.apache.hadoop.yarn.api.records.Priority"
  6778. transient="false" volatile="false"
  6779. static="true" final="true" visibility="public"
  6780. deprecated="not deprecated">
  6781. </field>
  6782. <doc>
  6783. <![CDATA[The priority assigned to a ResourceRequest or Application or Container
  6784. allocation]]>
  6785. </doc>
  6786. </class>
  6787. <!-- end class org.apache.hadoop.yarn.api.records.Priority -->
  6788. <!-- start class org.apache.hadoop.yarn.api.records.QueueACL -->
  6789. <class name="QueueACL" extends="java.lang.Enum"
  6790. abstract="false"
  6791. static="false" final="true" visibility="public"
  6792. deprecated="not deprecated">
  6793. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueACL[]"
  6794. abstract="false" native="false" synchronized="false"
  6795. static="true" final="false" visibility="public"
  6796. deprecated="not deprecated">
  6797. </method>
  6798. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueACL"
  6799. abstract="false" native="false" synchronized="false"
  6800. static="true" final="false" visibility="public"
  6801. deprecated="not deprecated">
  6802. <param name="name" type="java.lang.String"/>
  6803. </method>
  6804. <doc>
  6805. <![CDATA[{@code QueueACL} enumerates the various ACLs for queues.
  6806. <p>
  6807. The ACL is one of:
  6808. <ul>
  6809. <li>
  6810. {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue.
  6811. </li>
  6812. <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
  6813. </ul>
  6814. @see QueueInfo
  6815. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  6816. </doc>
  6817. </class>
  6818. <!-- end class org.apache.hadoop.yarn.api.records.QueueACL -->
  6819. <!-- start class org.apache.hadoop.yarn.api.records.QueueInfo -->
  6820. <class name="QueueInfo" extends="java.lang.Object"
  6821. abstract="true"
  6822. static="false" final="false" visibility="public"
  6823. deprecated="not deprecated">
  6824. <constructor name="QueueInfo"
  6825. static="false" final="false" visibility="public"
  6826. deprecated="not deprecated">
  6827. </constructor>
  6828. <method name="getQueueName" return="java.lang.String"
  6829. abstract="true" native="false" synchronized="false"
  6830. static="false" final="false" visibility="public"
  6831. deprecated="not deprecated">
  6832. <doc>
  6833. <![CDATA[Get the <em>name</em> of the queue.
  6834. @return <em>name</em> of the queue]]>
  6835. </doc>
  6836. </method>
  6837. <method name="getCapacity" return="float"
  6838. abstract="true" native="false" synchronized="false"
  6839. static="false" final="false" visibility="public"
  6840. deprecated="not deprecated">
  6841. <doc>
  6842. <![CDATA[Get the <em>configured capacity</em> of the queue.
  6843. @return <em>configured capacity</em> of the queue]]>
  6844. </doc>
  6845. </method>
  6846. <method name="getMaximumCapacity" return="float"
  6847. abstract="true" native="false" synchronized="false"
  6848. static="false" final="false" visibility="public"
  6849. deprecated="not deprecated">
  6850. <doc>
  6851. <![CDATA[Get the <em>maximum capacity</em> of the queue.
  6852. @return <em>maximum capacity</em> of the queue]]>
  6853. </doc>
  6854. </method>
  6855. <method name="getCurrentCapacity" return="float"
  6856. abstract="true" native="false" synchronized="false"
  6857. static="false" final="false" visibility="public"
  6858. deprecated="not deprecated">
  6859. <doc>
  6860. <![CDATA[Get the <em>current capacity</em> of the queue.
  6861. @return <em>current capacity</em> of the queue]]>
  6862. </doc>
  6863. </method>
  6864. <method name="getChildQueues" return="java.util.List"
  6865. abstract="true" native="false" synchronized="false"
  6866. static="false" final="false" visibility="public"
  6867. deprecated="not deprecated">
  6868. <doc>
  6869. <![CDATA[Get the <em>child queues</em> of the queue.
  6870. @return <em>child queues</em> of the queue]]>
  6871. </doc>
  6872. </method>
  6873. <method name="getApplications" return="java.util.List"
  6874. abstract="true" native="false" synchronized="false"
  6875. static="false" final="false" visibility="public"
  6876. deprecated="not deprecated">
  6877. <doc>
  6878. <![CDATA[Get the <em>running applications</em> of the queue.
  6879. @return <em>running applications</em> of the queue]]>
  6880. </doc>
  6881. </method>
  6882. <method name="getQueueState" return="org.apache.hadoop.yarn.api.records.QueueState"
  6883. abstract="true" native="false" synchronized="false"
  6884. static="false" final="false" visibility="public"
  6885. deprecated="not deprecated">
  6886. <doc>
  6887. <![CDATA[Get the <code>QueueState</code> of the queue.
  6888. @return <code>QueueState</code> of the queue]]>
  6889. </doc>
  6890. </method>
  6891. <method name="getAccessibleNodeLabels" return="java.util.Set"
  6892. abstract="true" native="false" synchronized="false"
  6893. static="false" final="false" visibility="public"
  6894. deprecated="not deprecated">
  6895. <doc>
  6896. <![CDATA[Get the <code>accessible node labels</code> of the queue.
  6897. @return <code>accessible node labels</code> of the queue]]>
  6898. </doc>
  6899. </method>
  6900. <method name="getDefaultNodeLabelExpression" return="java.lang.String"
  6901. abstract="true" native="false" synchronized="false"
  6902. static="false" final="false" visibility="public"
  6903. deprecated="not deprecated">
  6904. <doc>
  6905. <![CDATA[Get the <code>default node label expression</code> of the queue, this takes
  6906. affect only when the <code>ApplicationSubmissionContext</code> and
  6907. <code>ResourceRequest</code> don't specify their
  6908. <code>NodeLabelExpression</code>.
  6909. @return <code>default node label expression</code> of the queue]]>
  6910. </doc>
  6911. </method>
  6912. <method name="setDefaultNodeLabelExpression"
  6913. abstract="true" native="false" synchronized="false"
  6914. static="false" final="false" visibility="public"
  6915. deprecated="not deprecated">
  6916. <param name="defaultLabelExpression" type="java.lang.String"/>
  6917. </method>
  6918. <doc>
  6919. <![CDATA[QueueInfo is a report of the runtime information of the queue.
  6920. <p>
  6921. It includes information such as:
  6922. <ul>
  6923. <li>Queue name.</li>
  6924. <li>Capacity of the queue.</li>
  6925. <li>Maximum capacity of the queue.</li>
  6926. <li>Current capacity of the queue.</li>
  6927. <li>Child queues.</li>
  6928. <li>Running applications.</li>
  6929. <li>{@link QueueState} of the queue.</li>
  6930. </ul>
  6931. @see QueueState
  6932. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  6933. </doc>
  6934. </class>
  6935. <!-- end class org.apache.hadoop.yarn.api.records.QueueInfo -->
  6936. <!-- start class org.apache.hadoop.yarn.api.records.QueueState -->
  6937. <class name="QueueState" extends="java.lang.Enum"
  6938. abstract="false"
  6939. static="false" final="true" visibility="public"
  6940. deprecated="not deprecated">
  6941. <method name="values" return="org.apache.hadoop.yarn.api.records.QueueState[]"
  6942. abstract="false" native="false" synchronized="false"
  6943. static="true" final="false" visibility="public"
  6944. deprecated="not deprecated">
  6945. </method>
  6946. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueState"
  6947. abstract="false" native="false" synchronized="false"
  6948. static="true" final="false" visibility="public"
  6949. deprecated="not deprecated">
  6950. <param name="name" type="java.lang.String"/>
  6951. </method>
  6952. <doc>
  6953. <![CDATA[State of a Queue.
  6954. <p>
  6955. A queue is in one of:
  6956. <ul>
  6957. <li>{@link #RUNNING} - normal state.</li>
  6958. <li>{@link #STOPPED} - not accepting new application submissions.</li>
  6959. </ul>
  6960. @see QueueInfo
  6961. @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
  6962. </doc>
  6963. </class>
  6964. <!-- end class org.apache.hadoop.yarn.api.records.QueueState -->
  6965. <!-- start class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  6966. <class name="QueueUserACLInfo" extends="java.lang.Object"
  6967. abstract="true"
  6968. static="false" final="false" visibility="public"
  6969. deprecated="not deprecated">
  6970. <constructor name="QueueUserACLInfo"
  6971. static="false" final="false" visibility="public"
  6972. deprecated="not deprecated">
  6973. </constructor>
  6974. <method name="getQueueName" return="java.lang.String"
  6975. abstract="true" native="false" synchronized="false"
  6976. static="false" final="false" visibility="public"
  6977. deprecated="not deprecated">
  6978. <doc>
  6979. <![CDATA[Get the <em>queue name</em> of the queue.
  6980. @return <em>queue name</em> of the queue]]>
  6981. </doc>
  6982. </method>
  6983. <method name="getUserAcls" return="java.util.List"
  6984. abstract="true" native="false" synchronized="false"
  6985. static="false" final="false" visibility="public"
  6986. deprecated="not deprecated">
  6987. <doc>
  6988. <![CDATA[Get the list of <code>QueueACL</code> for the given user.
  6989. @return list of <code>QueueACL</code> for the given user]]>
  6990. </doc>
  6991. </method>
  6992. <doc>
  6993. <![CDATA[<p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
  6994. the given user.</p>
  6995. @see QueueACL
  6996. @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
  6997. </doc>
  6998. </class>
  6999. <!-- end class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
  7000. <!-- start class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  7001. <class name="ReservationDefinition" extends="java.lang.Object"
  7002. abstract="true"
  7003. static="false" final="false" visibility="public"
  7004. deprecated="not deprecated">
  7005. <constructor name="ReservationDefinition"
  7006. static="false" final="false" visibility="public"
  7007. deprecated="not deprecated">
  7008. </constructor>
  7009. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
  7010. abstract="false" native="false" synchronized="false"
  7011. static="true" final="false" visibility="public"
  7012. deprecated="not deprecated">
  7013. <param name="arrival" type="long"/>
  7014. <param name="deadline" type="long"/>
  7015. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  7016. <param name="name" type="java.lang.String"/>
  7017. </method>
  7018. <method name="getArrival" return="long"
  7019. abstract="true" native="false" synchronized="false"
  7020. static="false" final="false" visibility="public"
  7021. deprecated="not deprecated">
  7022. <doc>
  7023. <![CDATA[Get the arrival time or the earliest time from which the resource(s) can be
  7024. allocated. Time expressed as UTC.
  7025. @return the earliest valid time for this reservation]]>
  7026. </doc>
  7027. </method>
  7028. <method name="setArrival"
  7029. abstract="true" native="false" synchronized="false"
  7030. static="false" final="false" visibility="public"
  7031. deprecated="not deprecated">
  7032. <param name="earliestStartTime" type="long"/>
  7033. <doc>
  7034. <![CDATA[Set the arrival time or the earliest time from which the resource(s) can be
  7035. allocated. Time expressed as UTC.
  7036. @param earliestStartTime the earliest valid time for this reservation]]>
  7037. </doc>
  7038. </method>
  7039. <method name="getDeadline" return="long"
  7040. abstract="true" native="false" synchronized="false"
  7041. static="false" final="false" visibility="public"
  7042. deprecated="not deprecated">
  7043. <doc>
  7044. <![CDATA[Get the deadline or the latest time by when the resource(s) must be
  7045. allocated. Time expressed as UTC.
  7046. @return the deadline or the latest time by when the resource(s) must be
  7047. allocated]]>
  7048. </doc>
  7049. </method>
  7050. <method name="setDeadline"
  7051. abstract="true" native="false" synchronized="false"
  7052. static="false" final="false" visibility="public"
  7053. deprecated="not deprecated">
  7054. <param name="latestEndTime" type="long"/>
  7055. <doc>
  7056. <![CDATA[Set the deadline or the latest time by when the resource(s) must be
  7057. allocated. Time expressed as UTC.
  7058. @param latestEndTime the deadline or the latest time by when the
  7059. resource(s) should be allocated]]>
  7060. </doc>
  7061. </method>
  7062. <method name="getReservationRequests" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  7063. abstract="true" native="false" synchronized="false"
  7064. static="false" final="false" visibility="public"
  7065. deprecated="not deprecated">
  7066. <doc>
  7067. <![CDATA[Get the list of {@link ReservationRequests} representing the resources
  7068. required by the application
  7069. @return the list of {@link ReservationRequests}]]>
  7070. </doc>
  7071. </method>
  7072. <method name="setReservationRequests"
  7073. abstract="true" native="false" synchronized="false"
  7074. static="false" final="false" visibility="public"
  7075. deprecated="not deprecated">
  7076. <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
  7077. <doc>
  7078. <![CDATA[Set the list of {@link ReservationRequests} representing the resources
  7079. required by the application
  7080. @param reservationRequests the list of {@link ReservationRequests}]]>
  7081. </doc>
  7082. </method>
  7083. <method name="getReservationName" return="java.lang.String"
  7084. abstract="true" native="false" synchronized="false"
  7085. static="false" final="false" visibility="public"
  7086. deprecated="not deprecated">
  7087. <doc>
  7088. <![CDATA[Get the name for this reservation. The name need-not be unique, and it is
  7089. just a mnemonic for the user (akin to job names). Accepted reservations are
  7090. uniquely identified by a system-generated ReservationId.
  7091. @return string representing the name of the corresponding reserved resource
  7092. allocation in the scheduler]]>
  7093. </doc>
  7094. </method>
  7095. <method name="setReservationName"
  7096. abstract="true" native="false" synchronized="false"
  7097. static="false" final="false" visibility="public"
  7098. deprecated="not deprecated">
  7099. <param name="name" type="java.lang.String"/>
  7100. <doc>
  7101. <![CDATA[Set the name for this reservation. The name need-not be unique, and it is
  7102. just a mnemonic for the user (akin to job names). Accepted reservations are
  7103. uniquely identified by a system-generated ReservationId.
  7104. @param name representing the name of the corresponding reserved resource
  7105. allocation in the scheduler]]>
  7106. </doc>
  7107. </method>
  7108. <doc>
  7109. <![CDATA[{@link ReservationDefinition} captures the set of resource and time
  7110. constraints the user cares about regarding a reservation.
  7111. @see ResourceRequest]]>
  7112. </doc>
  7113. </class>
  7114. <!-- end class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
  7115. <!-- start class org.apache.hadoop.yarn.api.records.ReservationId -->
  7116. <class name="ReservationId" extends="java.lang.Object"
  7117. abstract="true"
  7118. static="false" final="false" visibility="public"
  7119. deprecated="not deprecated">
  7120. <implements name="java.lang.Comparable"/>
  7121. <constructor name="ReservationId"
  7122. static="false" final="false" visibility="public"
  7123. deprecated="not deprecated">
  7124. </constructor>
  7125. <method name="getId" return="long"
  7126. abstract="true" native="false" synchronized="false"
  7127. static="false" final="false" visibility="public"
  7128. deprecated="not deprecated">
  7129. <doc>
  7130. <![CDATA[Get the long identifier of the {@link ReservationId} which is unique for
  7131. all Reservations started by a particular instance of the
  7132. {@code ResourceManager}.
  7133. @return long identifier of the {@link ReservationId}]]>
  7134. </doc>
  7135. </method>
  7136. <method name="getClusterTimestamp" return="long"
  7137. abstract="true" native="false" synchronized="false"
  7138. static="false" final="false" visibility="public"
  7139. deprecated="not deprecated">
  7140. <doc>
  7141. <![CDATA[Get the <em>start time</em> of the {@code ResourceManager} which is used to
  7142. generate globally unique {@link ReservationId}.
  7143. @return <em>start time</em> of the {@code ResourceManager}]]>
  7144. </doc>
  7145. </method>
  7146. <method name="build"
  7147. abstract="true" native="false" synchronized="false"
  7148. static="false" final="false" visibility="protected"
  7149. deprecated="not deprecated">
  7150. </method>
  7151. <method name="compareTo" return="int"
  7152. abstract="false" native="false" synchronized="false"
  7153. static="false" final="false" visibility="public"
  7154. deprecated="not deprecated">
  7155. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
  7156. </method>
  7157. <method name="toString" return="java.lang.String"
  7158. abstract="false" native="false" synchronized="false"
  7159. static="false" final="false" visibility="public"
  7160. deprecated="not deprecated">
  7161. </method>
  7162. <method name="parseReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
  7163. abstract="false" native="false" synchronized="false"
  7164. static="true" final="false" visibility="public"
  7165. deprecated="not deprecated">
  7166. <param name="reservationId" type="java.lang.String"/>
  7167. <exception name="IOException" type="java.io.IOException"/>
  7168. <doc>
  7169. <![CDATA[Parse the string argument as a {@link ReservationId}
  7170. @param reservationId the string representation of the {@link ReservationId}
  7171. @return the {@link ReservationId} corresponding to the input string if
  7172. valid, null if input is null
  7173. @throws IOException if unable to parse the input string]]>
  7174. </doc>
  7175. </method>
  7176. <method name="hashCode" return="int"
  7177. abstract="false" native="false" synchronized="false"
  7178. static="false" final="false" visibility="public"
  7179. deprecated="not deprecated">
  7180. </method>
  7181. <method name="equals" return="boolean"
  7182. abstract="false" native="false" synchronized="false"
  7183. static="false" final="false" visibility="public"
  7184. deprecated="not deprecated">
  7185. <param name="obj" type="java.lang.Object"/>
  7186. </method>
  7187. <field name="reserveIdStrPrefix" type="java.lang.String"
  7188. transient="false" volatile="false"
  7189. static="true" final="true" visibility="public"
  7190. deprecated="not deprecated">
  7191. </field>
  7192. <field name="clusterTimestamp" type="long"
  7193. transient="false" volatile="false"
  7194. static="false" final="false" visibility="protected"
  7195. deprecated="not deprecated">
  7196. </field>
  7197. <field name="id" type="long"
  7198. transient="false" volatile="false"
  7199. static="false" final="false" visibility="protected"
  7200. deprecated="not deprecated">
  7201. </field>
  7202. <doc>
  7203. <![CDATA[<p>
  7204. {@link ReservationId} represents the <em>globally unique</em> identifier for
  7205. a reservation.
  7206. </p>
  7207. <p>
  7208. The globally unique nature of the identifier is achieved by using the
  7209. <em>cluster timestamp</em> i.e. start-time of the {@code ResourceManager}
  7210. along with a monotonically increasing counter for the reservation.
  7211. </p>]]>
  7212. </doc>
  7213. </class>
  7214. <!-- end class org.apache.hadoop.yarn.api.records.ReservationId -->
  7215. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  7216. <class name="ReservationRequest" extends="java.lang.Object"
  7217. abstract="true"
  7218. static="false" final="false" visibility="public"
  7219. deprecated="not deprecated">
  7220. <implements name="java.lang.Comparable"/>
  7221. <constructor name="ReservationRequest"
  7222. static="false" final="false" visibility="public"
  7223. deprecated="not deprecated">
  7224. </constructor>
  7225. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  7226. abstract="false" native="false" synchronized="false"
  7227. static="true" final="false" visibility="public"
  7228. deprecated="not deprecated">
  7229. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7230. <param name="numContainers" type="int"/>
  7231. </method>
  7232. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
  7233. abstract="false" native="false" synchronized="false"
  7234. static="true" final="false" visibility="public"
  7235. deprecated="not deprecated">
  7236. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7237. <param name="numContainers" type="int"/>
  7238. <param name="concurrency" type="int"/>
  7239. <param name="duration" type="long"/>
  7240. </method>
  7241. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  7242. abstract="true" native="false" synchronized="false"
  7243. static="false" final="false" visibility="public"
  7244. deprecated="not deprecated">
  7245. <doc>
  7246. <![CDATA[Get the {@link Resource} capability of the request.
  7247. @return {@link Resource} capability of the request]]>
  7248. </doc>
  7249. </method>
  7250. <method name="setCapability"
  7251. abstract="true" native="false" synchronized="false"
  7252. static="false" final="false" visibility="public"
  7253. deprecated="not deprecated">
  7254. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7255. <doc>
  7256. <![CDATA[Set the {@link Resource} capability of the request
  7257. @param capability {@link Resource} capability of the request]]>
  7258. </doc>
  7259. </method>
  7260. <method name="getNumContainers" return="int"
  7261. abstract="true" native="false" synchronized="false"
  7262. static="false" final="false" visibility="public"
  7263. deprecated="not deprecated">
  7264. <doc>
  7265. <![CDATA[Get the number of containers required with the given specifications.
  7266. @return number of containers required with the given specifications]]>
  7267. </doc>
  7268. </method>
  7269. <method name="setNumContainers"
  7270. abstract="true" native="false" synchronized="false"
  7271. static="false" final="false" visibility="public"
  7272. deprecated="not deprecated">
  7273. <param name="numContainers" type="int"/>
  7274. <doc>
  7275. <![CDATA[Set the number of containers required with the given specifications
  7276. @param numContainers number of containers required with the given
  7277. specifications]]>
  7278. </doc>
  7279. </method>
  7280. <method name="getConcurrency" return="int"
  7281. abstract="true" native="false" synchronized="false"
  7282. static="false" final="false" visibility="public"
  7283. deprecated="not deprecated">
  7284. <doc>
  7285. <![CDATA[Get the number of containers that need to be scheduled concurrently. The
  7286. default value of 1 would fall back to the current non concurrency
  7287. constraints on the scheduling behavior.
  7288. @return the number of containers to be concurrently scheduled]]>
  7289. </doc>
  7290. </method>
  7291. <method name="setConcurrency"
  7292. abstract="true" native="false" synchronized="false"
  7293. static="false" final="false" visibility="public"
  7294. deprecated="not deprecated">
  7295. <param name="numContainers" type="int"/>
  7296. <doc>
  7297. <![CDATA[Set the number of containers that need to be scheduled concurrently. The
  7298. default value of 1 would fall back to the current non concurrency
  7299. constraints on the scheduling behavior.
  7300. @param numContainers the number of containers to be concurrently scheduled]]>
  7301. </doc>
  7302. </method>
  7303. <method name="getDuration" return="long"
  7304. abstract="true" native="false" synchronized="false"
  7305. static="false" final="false" visibility="public"
  7306. deprecated="not deprecated">
  7307. <doc>
  7308. <![CDATA[Get the duration in milliseconds for which the resource is required. A
  7309. default value of -1, indicates an unspecified lease duration, and fallback
  7310. to current behavior.
  7311. @return the duration in milliseconds for which the resource is required]]>
  7312. </doc>
  7313. </method>
  7314. <method name="setDuration"
  7315. abstract="true" native="false" synchronized="false"
  7316. static="false" final="false" visibility="public"
  7317. deprecated="not deprecated">
  7318. <param name="duration" type="long"/>
  7319. <doc>
  7320. <![CDATA[Set the duration in milliseconds for which the resource is required.
  7321. @param duration the duration in milliseconds for which the resource is
  7322. required]]>
  7323. </doc>
  7324. </method>
  7325. <method name="hashCode" return="int"
  7326. abstract="false" native="false" synchronized="false"
  7327. static="false" final="false" visibility="public"
  7328. deprecated="not deprecated">
  7329. </method>
  7330. <method name="equals" return="boolean"
  7331. abstract="false" native="false" synchronized="false"
  7332. static="false" final="false" visibility="public"
  7333. deprecated="not deprecated">
  7334. <param name="obj" type="java.lang.Object"/>
  7335. </method>
  7336. <method name="compareTo" return="int"
  7337. abstract="false" native="false" synchronized="false"
  7338. static="false" final="false" visibility="public"
  7339. deprecated="not deprecated">
  7340. <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  7341. </method>
  7342. <doc>
  7343. <![CDATA[{@link ReservationRequest} represents the request made by an application to
  7344. the {@code ResourceManager} to reserve {@link Resource}s.
  7345. <p>
  7346. It includes:
  7347. <ul>
  7348. <li>{@link Resource} required for each request.</li>
  7349. <li>
  7350. Number of containers, of above specifications, which are required by the
  7351. application.
  7352. </li>
  7353. <li>Concurrency that indicates the gang size of the request.</li>
  7354. </ul>]]>
  7355. </doc>
  7356. </class>
  7357. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest -->
  7358. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  7359. <class name="ReservationRequest.ReservationRequestComparator" extends="java.lang.Object"
  7360. abstract="false"
  7361. static="true" final="false" visibility="public"
  7362. deprecated="not deprecated">
  7363. <implements name="java.util.Comparator"/>
  7364. <implements name="java.io.Serializable"/>
  7365. <constructor name="ReservationRequest.ReservationRequestComparator"
  7366. static="false" final="false" visibility="public"
  7367. deprecated="not deprecated">
  7368. </constructor>
  7369. <method name="compare" return="int"
  7370. abstract="false" native="false" synchronized="false"
  7371. static="false" final="false" visibility="public"
  7372. deprecated="not deprecated">
  7373. <param name="r1" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  7374. <param name="r2" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
  7375. </method>
  7376. </class>
  7377. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
  7378. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  7379. <class name="ReservationRequestInterpreter" extends="java.lang.Enum"
  7380. abstract="false"
  7381. static="false" final="true" visibility="public"
  7382. deprecated="not deprecated">
  7383. <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter[]"
  7384. abstract="false" native="false" synchronized="false"
  7385. static="true" final="false" visibility="public"
  7386. deprecated="not deprecated">
  7387. </method>
  7388. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  7389. abstract="false" native="false" synchronized="false"
  7390. static="true" final="false" visibility="public"
  7391. deprecated="not deprecated">
  7392. <param name="name" type="java.lang.String"/>
  7393. </method>
  7394. <doc>
  7395. <![CDATA[Enumeration of various types of dependencies among multiple
  7396. {@link ReservationRequests} within one {@link ReservationDefinition} (from
  7397. least constraining to most constraining).]]>
  7398. </doc>
  7399. </class>
  7400. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
  7401. <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  7402. <class name="ReservationRequests" extends="java.lang.Object"
  7403. abstract="true"
  7404. static="false" final="false" visibility="public"
  7405. deprecated="not deprecated">
  7406. <constructor name="ReservationRequests"
  7407. static="false" final="false" visibility="public"
  7408. deprecated="not deprecated">
  7409. </constructor>
  7410. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
  7411. abstract="false" native="false" synchronized="false"
  7412. static="true" final="false" visibility="public"
  7413. deprecated="not deprecated">
  7414. <param name="reservationResources" type="java.util.List"/>
  7415. <param name="type" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  7416. </method>
  7417. <method name="getReservationResources" return="java.util.List"
  7418. abstract="true" native="false" synchronized="false"
  7419. static="false" final="false" visibility="public"
  7420. deprecated="not deprecated">
  7421. <doc>
  7422. <![CDATA[Get the list of {@link ReservationRequest} representing the resources
  7423. required by the application
  7424. @return the list of {@link ReservationRequest}]]>
  7425. </doc>
  7426. </method>
  7427. <method name="setReservationResources"
  7428. abstract="true" native="false" synchronized="false"
  7429. static="false" final="false" visibility="public"
  7430. deprecated="not deprecated">
  7431. <param name="reservationResources" type="java.util.List"/>
  7432. <doc>
  7433. <![CDATA[Set the list of {@link ReservationRequest} representing the resources
  7434. required by the application
  7435. @param reservationResources the list of {@link ReservationRequest}]]>
  7436. </doc>
  7437. </method>
  7438. <method name="getInterpreter" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
  7439. abstract="true" native="false" synchronized="false"
  7440. static="false" final="false" visibility="public"
  7441. deprecated="not deprecated">
  7442. <doc>
  7443. <![CDATA[Get the {@link ReservationRequestInterpreter}, representing how the list of
  7444. resources should be allocated, this captures temporal ordering and other
  7445. constraints.
  7446. @return the list of {@link ReservationRequestInterpreter}]]>
  7447. </doc>
  7448. </method>
  7449. <method name="setInterpreter"
  7450. abstract="true" native="false" synchronized="false"
  7451. static="false" final="false" visibility="public"
  7452. deprecated="not deprecated">
  7453. <param name="interpreter" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
  7454. <doc>
  7455. <![CDATA[Set the {@link ReservationRequestInterpreter}, representing how the list of
  7456. resources should be allocated, this captures temporal ordering and other
  7457. constraints.
  7458. @param interpreter the {@link ReservationRequestInterpreter} for this
  7459. reservation]]>
  7460. </doc>
  7461. </method>
  7462. <doc>
  7463. <![CDATA[{@link ReservationRequests} captures the set of resource and constraints the
  7464. user cares about regarding a reservation.
  7465. @see ReservationRequest]]>
  7466. </doc>
  7467. </class>
  7468. <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequests -->
  7469. <!-- start class org.apache.hadoop.yarn.api.records.Resource -->
  7470. <class name="Resource" extends="java.lang.Object"
  7471. abstract="true"
  7472. static="false" final="false" visibility="public"
  7473. deprecated="not deprecated">
  7474. <implements name="java.lang.Comparable"/>
  7475. <constructor name="Resource"
  7476. static="false" final="false" visibility="public"
  7477. deprecated="not deprecated">
  7478. </constructor>
  7479. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
  7480. abstract="false" native="false" synchronized="false"
  7481. static="true" final="false" visibility="public"
  7482. deprecated="not deprecated">
  7483. <param name="memory" type="int"/>
  7484. <param name="vCores" type="int"/>
  7485. </method>
  7486. <method name="getMemory" return="int"
  7487. abstract="true" native="false" synchronized="false"
  7488. static="false" final="false" visibility="public"
  7489. deprecated="not deprecated">
  7490. <doc>
  7491. <![CDATA[Get <em>memory</em> of the resource.
  7492. @return <em>memory</em> of the resource]]>
  7493. </doc>
  7494. </method>
  7495. <method name="setMemory"
  7496. abstract="true" native="false" synchronized="false"
  7497. static="false" final="false" visibility="public"
  7498. deprecated="not deprecated">
  7499. <param name="memory" type="int"/>
  7500. <doc>
  7501. <![CDATA[Set <em>memory</em> of the resource.
  7502. @param memory <em>memory</em> of the resource]]>
  7503. </doc>
  7504. </method>
  7505. <method name="getVirtualCores" return="int"
  7506. abstract="true" native="false" synchronized="false"
  7507. static="false" final="false" visibility="public"
  7508. deprecated="not deprecated">
  7509. <doc>
  7510. <![CDATA[Get <em>number of virtual cpu cores</em> of the resource.
  7511. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  7512. should be configured with virtual cores equal to its number of physical cores.
  7513. A container should be requested with the number of cores it can saturate, i.e.
  7514. the average number of threads it expects to have runnable at a time.
  7515. @return <em>num of virtual cpu cores</em> of the resource]]>
  7516. </doc>
  7517. </method>
  7518. <method name="setVirtualCores"
  7519. abstract="true" native="false" synchronized="false"
  7520. static="false" final="false" visibility="public"
  7521. deprecated="not deprecated">
  7522. <param name="vCores" type="int"/>
  7523. <doc>
  7524. <![CDATA[Set <em>number of virtual cpu cores</em> of the resource.
  7525. Virtual cores are a unit for expressing CPU parallelism. A node's capacity
  7526. should be configured with virtual cores equal to its number of physical cores.
  7527. A container should be requested with the number of cores it can saturate, i.e.
  7528. the average number of threads it expects to have runnable at a time.
  7529. @param vCores <em>number of virtual cpu cores</em> of the resource]]>
  7530. </doc>
  7531. </method>
  7532. <method name="hashCode" return="int"
  7533. abstract="false" native="false" synchronized="false"
  7534. static="false" final="false" visibility="public"
  7535. deprecated="not deprecated">
  7536. </method>
  7537. <method name="equals" return="boolean"
  7538. abstract="false" native="false" synchronized="false"
  7539. static="false" final="false" visibility="public"
  7540. deprecated="not deprecated">
  7541. <param name="obj" type="java.lang.Object"/>
  7542. </method>
  7543. <method name="toString" return="java.lang.String"
  7544. abstract="false" native="false" synchronized="false"
  7545. static="false" final="false" visibility="public"
  7546. deprecated="not deprecated">
  7547. </method>
  7548. <doc>
  7549. <![CDATA[<p><code>Resource</code> models a set of computer resources in the
  7550. cluster.</p>
  7551. <p>Currently it models both <em>memory</em> and <em>CPU</em>.</p>
  7552. <p>The unit for memory is megabytes. CPU is modeled with virtual cores
  7553. (vcores), a unit for expressing parallelism. A node's capacity should
  7554. be configured with virtual cores equal to its number of physical cores. A
  7555. container should be requested with the number of cores it can saturate, i.e.
  7556. the average number of threads it expects to have runnable at a time.</p>
  7557. <p>Virtual cores take integer values and thus currently CPU-scheduling is
  7558. very coarse. A complementary axis for CPU requests that represents processing
  7559. power will likely be added in the future to enable finer-grained resource
  7560. configuration.</p>
  7561. <p>Typically, applications request <code>Resource</code> of suitable
  7562. capability to run their component tasks.</p>
  7563. @see ResourceRequest
  7564. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  7565. </doc>
  7566. </class>
  7567. <!-- end class org.apache.hadoop.yarn.api.records.Resource -->
  7568. <!-- start class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  7569. <class name="ResourceBlacklistRequest" extends="java.lang.Object"
  7570. abstract="true"
  7571. static="false" final="false" visibility="public"
  7572. deprecated="not deprecated">
  7573. <constructor name="ResourceBlacklistRequest"
  7574. static="false" final="false" visibility="public"
  7575. deprecated="not deprecated">
  7576. </constructor>
  7577. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
  7578. abstract="false" native="false" synchronized="false"
  7579. static="true" final="false" visibility="public"
  7580. deprecated="not deprecated">
  7581. <param name="additions" type="java.util.List"/>
  7582. <param name="removals" type="java.util.List"/>
  7583. </method>
  7584. <method name="getBlacklistAdditions" return="java.util.List"
  7585. abstract="true" native="false" synchronized="false"
  7586. static="false" final="false" visibility="public"
  7587. deprecated="not deprecated">
  7588. <doc>
  7589. <![CDATA[Get the list of resource-names which should be added to the
  7590. application blacklist.
  7591. @return list of resource-names which should be added to the
  7592. application blacklist]]>
  7593. </doc>
  7594. </method>
  7595. <method name="setBlacklistAdditions"
  7596. abstract="true" native="false" synchronized="false"
  7597. static="false" final="false" visibility="public"
  7598. deprecated="not deprecated">
  7599. <param name="resourceNames" type="java.util.List"/>
  7600. <doc>
  7601. <![CDATA[Set list of resource-names which should be added to the application blacklist.
  7602. @param resourceNames list of resource-names which should be added to the
  7603. application blacklist]]>
  7604. </doc>
  7605. </method>
  7606. <method name="getBlacklistRemovals" return="java.util.List"
  7607. abstract="true" native="false" synchronized="false"
  7608. static="false" final="false" visibility="public"
  7609. deprecated="not deprecated">
  7610. <doc>
  7611. <![CDATA[Get the list of resource-names which should be removed from the
  7612. application blacklist.
  7613. @return list of resource-names which should be removed from the
  7614. application blacklist]]>
  7615. </doc>
  7616. </method>
  7617. <method name="setBlacklistRemovals"
  7618. abstract="true" native="false" synchronized="false"
  7619. static="false" final="false" visibility="public"
  7620. deprecated="not deprecated">
  7621. <param name="resourceNames" type="java.util.List"/>
  7622. <doc>
  7623. <![CDATA[Set list of resource-names which should be removed from the
  7624. application blacklist.
  7625. @param resourceNames list of resource-names which should be removed from the
  7626. application blacklist]]>
  7627. </doc>
  7628. </method>
  7629. <doc>
  7630. <![CDATA[{@link ResourceBlacklistRequest} encapsulates the list of resource-names
  7631. which should be added or removed from the <em>blacklist</em> of resources
  7632. for the application.
  7633. @see ResourceRequest
  7634. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  7635. </doc>
  7636. </class>
  7637. <!-- end class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
  7638. <!-- start class org.apache.hadoop.yarn.api.records.ResourceOption -->
  7639. <class name="ResourceOption" extends="java.lang.Object"
  7640. abstract="true"
  7641. static="false" final="false" visibility="public"
  7642. deprecated="not deprecated">
  7643. <constructor name="ResourceOption"
  7644. static="false" final="false" visibility="public"
  7645. deprecated="not deprecated">
  7646. </constructor>
  7647. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceOption"
  7648. abstract="false" native="false" synchronized="false"
  7649. static="true" final="false" visibility="public"
  7650. deprecated="not deprecated">
  7651. <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7652. <param name="overCommitTimeout" type="int"/>
  7653. </method>
  7654. <method name="toString" return="java.lang.String"
  7655. abstract="false" native="false" synchronized="false"
  7656. static="false" final="false" visibility="public"
  7657. deprecated="not deprecated">
  7658. </method>
  7659. </class>
  7660. <!-- end class org.apache.hadoop.yarn.api.records.ResourceOption -->
  7661. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  7662. <class name="ResourceRequest" extends="java.lang.Object"
  7663. abstract="true"
  7664. static="false" final="false" visibility="public"
  7665. deprecated="not deprecated">
  7666. <implements name="java.lang.Comparable"/>
  7667. <constructor name="ResourceRequest"
  7668. static="false" final="false" visibility="public"
  7669. deprecated="not deprecated">
  7670. </constructor>
  7671. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7672. abstract="false" native="false" synchronized="false"
  7673. static="true" final="false" visibility="public"
  7674. deprecated="not deprecated">
  7675. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7676. <param name="hostName" type="java.lang.String"/>
  7677. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7678. <param name="numContainers" type="int"/>
  7679. </method>
  7680. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7681. abstract="false" native="false" synchronized="false"
  7682. static="true" final="false" visibility="public"
  7683. deprecated="not deprecated">
  7684. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7685. <param name="hostName" type="java.lang.String"/>
  7686. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7687. <param name="numContainers" type="int"/>
  7688. <param name="relaxLocality" type="boolean"/>
  7689. </method>
  7690. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
  7691. abstract="false" native="false" synchronized="false"
  7692. static="true" final="false" visibility="public"
  7693. deprecated="not deprecated">
  7694. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7695. <param name="hostName" type="java.lang.String"/>
  7696. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7697. <param name="numContainers" type="int"/>
  7698. <param name="relaxLocality" type="boolean"/>
  7699. <param name="labelExpression" type="java.lang.String"/>
  7700. </method>
  7701. <method name="isAnyLocation" return="boolean"
  7702. abstract="false" native="false" synchronized="false"
  7703. static="true" final="false" visibility="public"
  7704. deprecated="not deprecated">
  7705. <param name="hostName" type="java.lang.String"/>
  7706. <doc>
  7707. <![CDATA[Check whether the given <em>host/rack</em> string represents an arbitrary
  7708. host name.
  7709. @param hostName <em>host/rack</em> on which the allocation is desired
  7710. @return whether the given <em>host/rack</em> string represents an arbitrary
  7711. host name]]>
  7712. </doc>
  7713. </method>
  7714. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  7715. abstract="true" native="false" synchronized="false"
  7716. static="false" final="false" visibility="public"
  7717. deprecated="not deprecated">
  7718. <doc>
  7719. <![CDATA[Get the <code>Priority</code> of the request.
  7720. @return <code>Priority</code> of the request]]>
  7721. </doc>
  7722. </method>
  7723. <method name="setPriority"
  7724. abstract="true" native="false" synchronized="false"
  7725. static="false" final="false" visibility="public"
  7726. deprecated="not deprecated">
  7727. <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
  7728. <doc>
  7729. <![CDATA[Set the <code>Priority</code> of the request
  7730. @param priority <code>Priority</code> of the request]]>
  7731. </doc>
  7732. </method>
  7733. <method name="getResourceName" return="java.lang.String"
  7734. abstract="true" native="false" synchronized="false"
  7735. static="false" final="false" visibility="public"
  7736. deprecated="not deprecated">
  7737. <doc>
  7738. <![CDATA[Get the resource (e.g. <em>host/rack</em>) on which the allocation
  7739. is desired.
  7740. A special value of <em>*</em> signifies that <em>any</em> resource
  7741. (host/rack) is acceptable.
  7742. @return resource (e.g. <em>host/rack</em>) on which the allocation
  7743. is desired]]>
  7744. </doc>
  7745. </method>
  7746. <method name="setResourceName"
  7747. abstract="true" native="false" synchronized="false"
  7748. static="false" final="false" visibility="public"
  7749. deprecated="not deprecated">
  7750. <param name="resourceName" type="java.lang.String"/>
  7751. <doc>
  7752. <![CDATA[Set the resource name (e.g. <em>host/rack</em>) on which the allocation
  7753. is desired.
  7754. A special value of <em>*</em> signifies that <em>any</em> resource name
  7755. (e.g. host/rack) is acceptable.
  7756. @param resourceName (e.g. <em>host/rack</em>) on which the
  7757. allocation is desired]]>
  7758. </doc>
  7759. </method>
  7760. <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
  7761. abstract="true" native="false" synchronized="false"
  7762. static="false" final="false" visibility="public"
  7763. deprecated="not deprecated">
  7764. <doc>
  7765. <![CDATA[Get the <code>Resource</code> capability of the request.
  7766. @return <code>Resource</code> capability of the request]]>
  7767. </doc>
  7768. </method>
  7769. <method name="setCapability"
  7770. abstract="true" native="false" synchronized="false"
  7771. static="false" final="false" visibility="public"
  7772. deprecated="not deprecated">
  7773. <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
  7774. <doc>
  7775. <![CDATA[Set the <code>Resource</code> capability of the request
  7776. @param capability <code>Resource</code> capability of the request]]>
  7777. </doc>
  7778. </method>
  7779. <method name="getNumContainers" return="int"
  7780. abstract="true" native="false" synchronized="false"
  7781. static="false" final="false" visibility="public"
  7782. deprecated="not deprecated">
  7783. <doc>
  7784. <![CDATA[Get the number of containers required with the given specifications.
  7785. @return number of containers required with the given specifications]]>
  7786. </doc>
  7787. </method>
  7788. <method name="setNumContainers"
  7789. abstract="true" native="false" synchronized="false"
  7790. static="false" final="false" visibility="public"
  7791. deprecated="not deprecated">
  7792. <param name="numContainers" type="int"/>
  7793. <doc>
  7794. <![CDATA[Set the number of containers required with the given specifications
  7795. @param numContainers number of containers required with the given
  7796. specifications]]>
  7797. </doc>
  7798. </method>
  7799. <method name="getRelaxLocality" return="boolean"
  7800. abstract="true" native="false" synchronized="false"
  7801. static="false" final="false" visibility="public"
  7802. deprecated="not deprecated">
  7803. <doc>
  7804. <![CDATA[Get whether locality relaxation is enabled with this
  7805. <code>ResourceRequest</code>. Defaults to true.
  7806. @return whether locality relaxation is enabled with this
  7807. <code>ResourceRequest</code>.]]>
  7808. </doc>
  7809. </method>
  7810. <method name="setRelaxLocality"
  7811. abstract="true" native="false" synchronized="false"
  7812. static="false" final="false" visibility="public"
  7813. deprecated="not deprecated">
  7814. <param name="relaxLocality" type="boolean"/>
  7815. <doc>
  7816. <![CDATA[<p>For a request at a network hierarchy level, set whether locality can be relaxed
  7817. to that level and beyond.<p>
  7818. <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
  7819. containers at that request's priority will not be assigned to nodes on that
  7820. request's rack unless requests specifically for those nodes have also been
  7821. submitted.<p>
  7822. <p>If the flag is off on an {@link ResourceRequest#ANY}-level
  7823. <code>ResourceRequest</code>, containers at that request's priority will
  7824. only be assigned on racks for which specific requests have also been
  7825. submitted.<p>
  7826. <p>For example, to request a container strictly on a specific node, the
  7827. corresponding rack-level and any-level requests should have locality
  7828. relaxation set to false. Similarly, to request a container strictly on a
  7829. specific rack, the corresponding any-level request should have locality
  7830. relaxation set to false.<p>
  7831. @param relaxLocality whether locality relaxation is enabled with this
  7832. <code>ResourceRequest</code>.]]>
  7833. </doc>
  7834. </method>
  7835. <method name="getNodeLabelExpression" return="java.lang.String"
  7836. abstract="true" native="false" synchronized="false"
  7837. static="false" final="false" visibility="public"
  7838. deprecated="not deprecated">
  7839. <doc>
  7840. <![CDATA[Get node-label-expression for this Resource Request. If this is set, all
  7841. containers allocated to satisfy this resource-request will be only on those
  7842. nodes that satisfy this node-label-expression.
  7843. Please note that node label expression now can only take effect when the
  7844. resource request has resourceName = ANY
  7845. @return node-label-expression]]>
  7846. </doc>
  7847. </method>
  7848. <method name="setNodeLabelExpression"
  7849. abstract="true" native="false" synchronized="false"
  7850. static="false" final="false" visibility="public"
  7851. deprecated="not deprecated">
  7852. <param name="nodelabelExpression" type="java.lang.String"/>
  7853. <doc>
  7854. <![CDATA[Set node label expression of this resource request. Now only support
  7855. specifying a single node label. In the future we will support more complex
  7856. node label expression specification like {@code AND(&&), OR(||)}, etc.
  7857. Any please note that node label expression now can only take effect when
  7858. the resource request has resourceName = ANY
  7859. @param nodelabelExpression
  7860. node-label-expression of this ResourceRequest]]>
  7861. </doc>
  7862. </method>
  7863. <method name="hashCode" return="int"
  7864. abstract="false" native="false" synchronized="false"
  7865. static="false" final="false" visibility="public"
  7866. deprecated="not deprecated">
  7867. </method>
  7868. <method name="equals" return="boolean"
  7869. abstract="false" native="false" synchronized="false"
  7870. static="false" final="false" visibility="public"
  7871. deprecated="not deprecated">
  7872. <param name="obj" type="java.lang.Object"/>
  7873. </method>
  7874. <method name="compareTo" return="int"
  7875. abstract="false" native="false" synchronized="false"
  7876. static="false" final="false" visibility="public"
  7877. deprecated="not deprecated">
  7878. <param name="other" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7879. </method>
  7880. <field name="ANY" type="java.lang.String"
  7881. transient="false" volatile="false"
  7882. static="true" final="true" visibility="public"
  7883. deprecated="not deprecated">
  7884. <doc>
  7885. <![CDATA[The constant string representing no locality.
  7886. It should be used by all references that want to pass an arbitrary host
  7887. name in.]]>
  7888. </doc>
  7889. </field>
  7890. <doc>
  7891. <![CDATA[{@code ResourceRequest} represents the request made
  7892. by an application to the {@code ResourceManager}
  7893. to obtain various {@code Container} allocations.
  7894. <p>
  7895. It includes:
  7896. <ul>
  7897. <li>{@link Priority} of the request.</li>
  7898. <li>
  7899. The <em>name</em> of the machine or rack on which the allocation is
  7900. desired. A special value of <em>*</em> signifies that
  7901. <em>any</em> host/rack is acceptable to the application.
  7902. </li>
  7903. <li>{@link Resource} required for each request.</li>
  7904. <li>
  7905. Number of containers, of above specifications, which are required
  7906. by the application.
  7907. </li>
  7908. <li>
  7909. A boolean <em>relaxLocality</em> flag, defaulting to {@code true},
  7910. which tells the {@code ResourceManager} if the application wants
  7911. locality to be loose (i.e. allows fall-through to rack or <em>any</em>)
  7912. or strict (i.e. specify hard constraint on resource allocation).
  7913. </li>
  7914. </ul>
  7915. @see Resource
  7916. @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
  7917. </doc>
  7918. </class>
  7919. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest -->
  7920. <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  7921. <class name="ResourceRequest.ResourceRequestComparator" extends="java.lang.Object"
  7922. abstract="false"
  7923. static="true" final="false" visibility="public"
  7924. deprecated="not deprecated">
  7925. <implements name="java.util.Comparator"/>
  7926. <implements name="java.io.Serializable"/>
  7927. <constructor name="ResourceRequest.ResourceRequestComparator"
  7928. static="false" final="false" visibility="public"
  7929. deprecated="not deprecated">
  7930. </constructor>
  7931. <method name="compare" return="int"
  7932. abstract="false" native="false" synchronized="false"
  7933. static="false" final="false" visibility="public"
  7934. deprecated="not deprecated">
  7935. <param name="r1" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7936. <param name="r2" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
  7937. </method>
  7938. </class>
  7939. <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
  7940. <!-- start class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  7941. <class name="StrictPreemptionContract" extends="java.lang.Object"
  7942. abstract="true"
  7943. static="false" final="false" visibility="public"
  7944. deprecated="not deprecated">
  7945. <constructor name="StrictPreemptionContract"
  7946. static="false" final="false" visibility="public"
  7947. deprecated="not deprecated">
  7948. </constructor>
  7949. <method name="getContainers" return="java.util.Set"
  7950. abstract="true" native="false" synchronized="false"
  7951. static="false" final="false" visibility="public"
  7952. deprecated="not deprecated">
  7953. <doc>
  7954. <![CDATA[Get the set of {@link PreemptionContainer} specifying containers owned by
  7955. the <code>ApplicationMaster</code> that may be reclaimed by the
  7956. <code>ResourceManager</code>.
  7957. @return the set of {@link ContainerId} to be preempted.]]>
  7958. </doc>
  7959. </method>
  7960. <doc>
  7961. <![CDATA[Enumeration of particular allocations to be reclaimed. The platform will
  7962. reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM)
  7963. may attempt to checkpoint work or adjust its execution plan to accommodate
  7964. it. In contrast to {@link PreemptionContract}, the AM has no flexibility in
  7965. selecting which resources to return to the cluster.
  7966. @see PreemptionMessage]]>
  7967. </doc>
  7968. </class>
  7969. <!-- end class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
  7970. <!-- start class org.apache.hadoop.yarn.api.records.Token -->
  7971. <class name="Token" extends="java.lang.Object"
  7972. abstract="true"
  7973. static="false" final="false" visibility="public"
  7974. deprecated="not deprecated">
  7975. <constructor name="Token"
  7976. static="false" final="false" visibility="public"
  7977. deprecated="not deprecated">
  7978. </constructor>
  7979. <method name="getIdentifier" return="java.nio.ByteBuffer"
  7980. abstract="true" native="false" synchronized="false"
  7981. static="false" final="false" visibility="public"
  7982. deprecated="not deprecated">
  7983. <doc>
  7984. <![CDATA[Get the token identifier.
  7985. @return token identifier]]>
  7986. </doc>
  7987. </method>
  7988. <method name="getPassword" return="java.nio.ByteBuffer"
  7989. abstract="true" native="false" synchronized="false"
  7990. static="false" final="false" visibility="public"
  7991. deprecated="not deprecated">
  7992. <doc>
  7993. <![CDATA[Get the token password
  7994. @return token password]]>
  7995. </doc>
  7996. </method>
  7997. <method name="getKind" return="java.lang.String"
  7998. abstract="true" native="false" synchronized="false"
  7999. static="false" final="false" visibility="public"
  8000. deprecated="not deprecated">
  8001. <doc>
  8002. <![CDATA[Get the token kind.
  8003. @return token kind]]>
  8004. </doc>
  8005. </method>
  8006. <method name="getService" return="java.lang.String"
  8007. abstract="true" native="false" synchronized="false"
  8008. static="false" final="false" visibility="public"
  8009. deprecated="not deprecated">
  8010. <doc>
  8011. <![CDATA[Get the service to which the token is allocated.
  8012. @return service to which the token is allocated]]>
  8013. </doc>
  8014. </method>
  8015. <doc>
  8016. <![CDATA[<p><code>Token</code> is the security entity used by the framework
  8017. to verify authenticity of any resource.</p>]]>
  8018. </doc>
  8019. </class>
  8020. <!-- end class org.apache.hadoop.yarn.api.records.Token -->
  8021. <!-- start class org.apache.hadoop.yarn.api.records.URL -->
  8022. <class name="URL" extends="java.lang.Object"
  8023. abstract="true"
  8024. static="false" final="false" visibility="public"
  8025. deprecated="not deprecated">
  8026. <constructor name="URL"
  8027. static="false" final="false" visibility="public"
  8028. deprecated="not deprecated">
  8029. </constructor>
  8030. <method name="newInstance" return="org.apache.hadoop.yarn.api.records.URL"
  8031. abstract="false" native="false" synchronized="false"
  8032. static="true" final="false" visibility="public"
  8033. deprecated="not deprecated">
  8034. <param name="scheme" type="java.lang.String"/>
  8035. <param name="host" type="java.lang.String"/>
  8036. <param name="port" type="int"/>
  8037. <param name="file" type="java.lang.String"/>
  8038. </method>
  8039. <method name="getScheme" return="java.lang.String"
  8040. abstract="true" native="false" synchronized="false"
  8041. static="false" final="false" visibility="public"
  8042. deprecated="not deprecated">
  8043. <doc>
  8044. <![CDATA[Get the scheme of the URL.
  8045. @return scheme of the URL]]>
  8046. </doc>
  8047. </method>
  8048. <method name="setScheme"
  8049. abstract="true" native="false" synchronized="false"
  8050. static="false" final="false" visibility="public"
  8051. deprecated="not deprecated">
  8052. <param name="scheme" type="java.lang.String"/>
  8053. <doc>
  8054. <![CDATA[Set the scheme of the URL
  8055. @param scheme scheme of the URL]]>
  8056. </doc>
  8057. </method>
  8058. <method name="getUserInfo" return="java.lang.String"
  8059. abstract="true" native="false" synchronized="false"
  8060. static="false" final="false" visibility="public"
  8061. deprecated="not deprecated">
  8062. <doc>
  8063. <![CDATA[Get the user info of the URL.
  8064. @return user info of the URL]]>
  8065. </doc>
  8066. </method>
  8067. <method name="setUserInfo"
  8068. abstract="true" native="false" synchronized="false"
  8069. static="false" final="false" visibility="public"
  8070. deprecated="not deprecated">
  8071. <param name="userInfo" type="java.lang.String"/>
  8072. <doc>
  8073. <![CDATA[Set the user info of the URL.
  8074. @param userInfo user info of the URL]]>
  8075. </doc>
  8076. </method>
  8077. <method name="getHost" return="java.lang.String"
  8078. abstract="true" native="false" synchronized="false"
  8079. static="false" final="false" visibility="public"
  8080. deprecated="not deprecated">
  8081. <doc>
  8082. <![CDATA[Get the host of the URL.
  8083. @return host of the URL]]>
  8084. </doc>
  8085. </method>
  8086. <method name="setHost"
  8087. abstract="true" native="false" synchronized="false"
  8088. static="false" final="false" visibility="public"
  8089. deprecated="not deprecated">
  8090. <param name="host" type="java.lang.String"/>
  8091. <doc>
  8092. <![CDATA[Set the host of the URL.
  8093. @param host host of the URL]]>
  8094. </doc>
  8095. </method>
  8096. <method name="getPort" return="int"
  8097. abstract="true" native="false" synchronized="false"
  8098. static="false" final="false" visibility="public"
  8099. deprecated="not deprecated">
  8100. <doc>
  8101. <![CDATA[Get the port of the URL.
  8102. @return port of the URL]]>
  8103. </doc>
  8104. </method>
  8105. <method name="setPort"
  8106. abstract="true" native="false" synchronized="false"
  8107. static="false" final="false" visibility="public"
  8108. deprecated="not deprecated">
  8109. <param name="port" type="int"/>
  8110. <doc>
  8111. <![CDATA[Set the port of the URL
  8112. @param port port of the URL]]>
  8113. </doc>
  8114. </method>
  8115. <method name="getFile" return="java.lang.String"
  8116. abstract="true" native="false" synchronized="false"
  8117. static="false" final="false" visibility="public"
  8118. deprecated="not deprecated">
  8119. <doc>
  8120. <![CDATA[Get the file of the URL.
  8121. @return file of the URL]]>
  8122. </doc>
  8123. </method>
  8124. <method name="setFile"
  8125. abstract="true" native="false" synchronized="false"
  8126. static="false" final="false" visibility="public"
  8127. deprecated="not deprecated">
  8128. <param name="file" type="java.lang.String"/>
  8129. <doc>
  8130. <![CDATA[Set the file of the URL.
  8131. @param file file of the URL]]>
  8132. </doc>
  8133. </method>
  8134. <doc>
  8135. <![CDATA[<p><code>URL</code> represents a serializable {@link java.net.URL}.</p>]]>
  8136. </doc>
  8137. </class>
  8138. <!-- end class org.apache.hadoop.yarn.api.records.URL -->
  8139. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  8140. <class name="YarnApplicationAttemptState" extends="java.lang.Enum"
  8141. abstract="false"
  8142. static="false" final="true" visibility="public"
  8143. deprecated="not deprecated">
  8144. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState[]"
  8145. abstract="false" native="false" synchronized="false"
  8146. static="true" final="false" visibility="public"
  8147. deprecated="not deprecated">
  8148. </method>
  8149. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
  8150. abstract="false" native="false" synchronized="false"
  8151. static="true" final="false" visibility="public"
  8152. deprecated="not deprecated">
  8153. <param name="name" type="java.lang.String"/>
  8154. </method>
  8155. <doc>
  8156. <![CDATA[Enumeration of various states of a <code>RMAppAttempt</code>.]]>
  8157. </doc>
  8158. </class>
  8159. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
  8160. <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  8161. <class name="YarnApplicationState" extends="java.lang.Enum"
  8162. abstract="false"
  8163. static="false" final="true" visibility="public"
  8164. deprecated="not deprecated">
  8165. <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationState[]"
  8166. abstract="false" native="false" synchronized="false"
  8167. static="true" final="false" visibility="public"
  8168. deprecated="not deprecated">
  8169. </method>
  8170. <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
  8171. abstract="false" native="false" synchronized="false"
  8172. static="true" final="false" visibility="public"
  8173. deprecated="not deprecated">
  8174. <param name="name" type="java.lang.String"/>
  8175. </method>
  8176. <doc>
  8177. <![CDATA[Enumeration of various states of an <code>ApplicationMaster</code>.]]>
  8178. </doc>
  8179. </class>
  8180. <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
  8181. <!-- start class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  8182. <class name="YarnClusterMetrics" extends="java.lang.Object"
  8183. abstract="true"
  8184. static="false" final="false" visibility="public"
  8185. deprecated="not deprecated">
  8186. <constructor name="YarnClusterMetrics"
  8187. static="false" final="false" visibility="public"
  8188. deprecated="not deprecated">
  8189. </constructor>
  8190. <method name="getNumNodeManagers" return="int"
  8191. abstract="true" native="false" synchronized="false"
  8192. static="false" final="false" visibility="public"
  8193. deprecated="not deprecated">
  8194. <doc>
  8195. <![CDATA[Get the number of <code>NodeManager</code>s in the cluster.
  8196. @return number of <code>NodeManager</code>s in the cluster]]>
  8197. </doc>
  8198. </method>
  8199. <doc>
  8200. <![CDATA[<p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
  8201. <p>Currently only number of <code>NodeManager</code>s is provided.</p>]]>
  8202. </doc>
  8203. </class>
  8204. <!-- end class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
  8205. </package>
  8206. <package name="org.apache.hadoop.yarn.api.records.timeline">
  8207. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  8208. <class name="TimelineDelegationTokenResponse" extends="java.lang.Object"
  8209. abstract="false"
  8210. static="false" final="false" visibility="public"
  8211. deprecated="not deprecated">
  8212. <constructor name="TimelineDelegationTokenResponse"
  8213. static="false" final="false" visibility="public"
  8214. deprecated="not deprecated">
  8215. </constructor>
  8216. <method name="getType" return="java.lang.String"
  8217. abstract="false" native="false" synchronized="false"
  8218. static="false" final="false" visibility="public"
  8219. deprecated="not deprecated">
  8220. </method>
  8221. <method name="setType"
  8222. abstract="false" native="false" synchronized="false"
  8223. static="false" final="false" visibility="public"
  8224. deprecated="not deprecated">
  8225. <param name="type" type="java.lang.String"/>
  8226. </method>
  8227. <method name="getContent" return="java.lang.Object"
  8228. abstract="false" native="false" synchronized="false"
  8229. static="false" final="false" visibility="public"
  8230. deprecated="not deprecated">
  8231. </method>
  8232. <method name="setContent"
  8233. abstract="false" native="false" synchronized="false"
  8234. static="false" final="false" visibility="public"
  8235. deprecated="not deprecated">
  8236. <param name="content" type="java.lang.Object"/>
  8237. </method>
  8238. <doc>
  8239. <![CDATA[The response of delegation token related request]]>
  8240. </doc>
  8241. </class>
  8242. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
  8243. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  8244. <class name="TimelineDomain" extends="java.lang.Object"
  8245. abstract="false"
  8246. static="false" final="false" visibility="public"
  8247. deprecated="not deprecated">
  8248. <constructor name="TimelineDomain"
  8249. static="false" final="false" visibility="public"
  8250. deprecated="not deprecated">
  8251. </constructor>
  8252. <method name="getId" return="java.lang.String"
  8253. abstract="false" native="false" synchronized="false"
  8254. static="false" final="false" visibility="public"
  8255. deprecated="not deprecated">
  8256. <doc>
  8257. <![CDATA[Get the domain ID
  8258. @return the domain ID]]>
  8259. </doc>
  8260. </method>
  8261. <method name="setId"
  8262. abstract="false" native="false" synchronized="false"
  8263. static="false" final="false" visibility="public"
  8264. deprecated="not deprecated">
  8265. <param name="id" type="java.lang.String"/>
  8266. <doc>
  8267. <![CDATA[Set the domain ID
  8268. @param id the domain ID]]>
  8269. </doc>
  8270. </method>
  8271. <method name="getDescription" return="java.lang.String"
  8272. abstract="false" native="false" synchronized="false"
  8273. static="false" final="false" visibility="public"
  8274. deprecated="not deprecated">
  8275. <doc>
  8276. <![CDATA[Get the domain description
  8277. @return the domain description]]>
  8278. </doc>
  8279. </method>
  8280. <method name="setDescription"
  8281. abstract="false" native="false" synchronized="false"
  8282. static="false" final="false" visibility="public"
  8283. deprecated="not deprecated">
  8284. <param name="description" type="java.lang.String"/>
  8285. <doc>
  8286. <![CDATA[Set the domain description
  8287. @param description the domain description]]>
  8288. </doc>
  8289. </method>
  8290. <method name="getOwner" return="java.lang.String"
  8291. abstract="false" native="false" synchronized="false"
  8292. static="false" final="false" visibility="public"
  8293. deprecated="not deprecated">
  8294. <doc>
  8295. <![CDATA[Get the domain owner
  8296. @return the domain owner]]>
  8297. </doc>
  8298. </method>
  8299. <method name="setOwner"
  8300. abstract="false" native="false" synchronized="false"
  8301. static="false" final="false" visibility="public"
  8302. deprecated="not deprecated">
  8303. <param name="owner" type="java.lang.String"/>
  8304. <doc>
  8305. <![CDATA[Set the domain owner. The user doesn't need to set it, which will
  8306. automatically set to the user who puts the domain.
  8307. @param owner the domain owner]]>
  8308. </doc>
  8309. </method>
  8310. <method name="getReaders" return="java.lang.String"
  8311. abstract="false" native="false" synchronized="false"
  8312. static="false" final="false" visibility="public"
  8313. deprecated="not deprecated">
  8314. <doc>
  8315. <![CDATA[Get the reader (and/or reader group) list string
  8316. @return the reader (and/or reader group) list string]]>
  8317. </doc>
  8318. </method>
  8319. <method name="setReaders"
  8320. abstract="false" native="false" synchronized="false"
  8321. static="false" final="false" visibility="public"
  8322. deprecated="not deprecated">
  8323. <param name="readers" type="java.lang.String"/>
  8324. <doc>
  8325. <![CDATA[Set the reader (and/or reader group) list string
  8326. @param readers the reader (and/or reader group) list string]]>
  8327. </doc>
  8328. </method>
  8329. <method name="getWriters" return="java.lang.String"
  8330. abstract="false" native="false" synchronized="false"
  8331. static="false" final="false" visibility="public"
  8332. deprecated="not deprecated">
  8333. <doc>
  8334. <![CDATA[Get the writer (and/or writer group) list string
  8335. @return the writer (and/or writer group) list string]]>
  8336. </doc>
  8337. </method>
  8338. <method name="setWriters"
  8339. abstract="false" native="false" synchronized="false"
  8340. static="false" final="false" visibility="public"
  8341. deprecated="not deprecated">
  8342. <param name="writers" type="java.lang.String"/>
  8343. <doc>
  8344. <![CDATA[Set the writer (and/or writer group) list string
  8345. @param writers the writer (and/or writer group) list string]]>
  8346. </doc>
  8347. </method>
  8348. <method name="getCreatedTime" return="java.lang.Long"
  8349. abstract="false" native="false" synchronized="false"
  8350. static="false" final="false" visibility="public"
  8351. deprecated="not deprecated">
  8352. <doc>
  8353. <![CDATA[Get the created time of the domain
  8354. @return the created time of the domain]]>
  8355. </doc>
  8356. </method>
  8357. <method name="setCreatedTime"
  8358. abstract="false" native="false" synchronized="false"
  8359. static="false" final="false" visibility="public"
  8360. deprecated="not deprecated">
  8361. <param name="createdTime" type="java.lang.Long"/>
  8362. <doc>
  8363. <![CDATA[Set the created time of the domain
  8364. @param createdTime the created time of the domain]]>
  8365. </doc>
  8366. </method>
  8367. <method name="getModifiedTime" return="java.lang.Long"
  8368. abstract="false" native="false" synchronized="false"
  8369. static="false" final="false" visibility="public"
  8370. deprecated="not deprecated">
  8371. <doc>
  8372. <![CDATA[Get the modified time of the domain
  8373. @return the modified time of the domain]]>
  8374. </doc>
  8375. </method>
  8376. <method name="setModifiedTime"
  8377. abstract="false" native="false" synchronized="false"
  8378. static="false" final="false" visibility="public"
  8379. deprecated="not deprecated">
  8380. <param name="modifiedTime" type="java.lang.Long"/>
  8381. <doc>
  8382. <![CDATA[Set the modified time of the domain
  8383. @param modifiedTime the modified time of the domain]]>
  8384. </doc>
  8385. </method>
  8386. <doc>
  8387. <![CDATA[<p>
  8388. This class contains the information about a timeline domain, which is used
  8389. to a user to host a number of timeline entities, isolating them from others'.
  8390. The user can also define the reader and writer users/groups for the the
  8391. domain, which is used to control the access to its entities.
  8392. </p>
  8393. <p>
  8394. The reader and writer users/groups pattern that the user can supply is the
  8395. same as what <code>AccessControlList</code> takes.
  8396. </p>]]>
  8397. </doc>
  8398. </class>
  8399. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
  8400. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  8401. <class name="TimelineDomains" extends="java.lang.Object"
  8402. abstract="false"
  8403. static="false" final="false" visibility="public"
  8404. deprecated="not deprecated">
  8405. <constructor name="TimelineDomains"
  8406. static="false" final="false" visibility="public"
  8407. deprecated="not deprecated">
  8408. </constructor>
  8409. <method name="getDomains" return="java.util.List"
  8410. abstract="false" native="false" synchronized="false"
  8411. static="false" final="false" visibility="public"
  8412. deprecated="not deprecated">
  8413. <doc>
  8414. <![CDATA[Get a list of domains
  8415. @return a list of domains]]>
  8416. </doc>
  8417. </method>
  8418. <method name="addDomain"
  8419. abstract="false" native="false" synchronized="false"
  8420. static="false" final="false" visibility="public"
  8421. deprecated="not deprecated">
  8422. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  8423. <doc>
  8424. <![CDATA[Add a single domain into the existing domain list
  8425. @param domain
  8426. a single domain]]>
  8427. </doc>
  8428. </method>
  8429. <method name="addDomains"
  8430. abstract="false" native="false" synchronized="false"
  8431. static="false" final="false" visibility="public"
  8432. deprecated="not deprecated">
  8433. <param name="domains" type="java.util.List"/>
  8434. <doc>
  8435. <![CDATA[All a list of domains into the existing domain list
  8436. @param domains
  8437. a list of domains]]>
  8438. </doc>
  8439. </method>
  8440. <method name="setDomains"
  8441. abstract="false" native="false" synchronized="false"
  8442. static="false" final="false" visibility="public"
  8443. deprecated="not deprecated">
  8444. <param name="domains" type="java.util.List"/>
  8445. <doc>
  8446. <![CDATA[Set the domain list to the given list of domains
  8447. @param domains
  8448. a list of domains]]>
  8449. </doc>
  8450. </method>
  8451. <doc>
  8452. <![CDATA[The class that hosts a list of timeline domains.]]>
  8453. </doc>
  8454. </class>
  8455. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
  8456. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  8457. <class name="TimelineEntities" extends="java.lang.Object"
  8458. abstract="false"
  8459. static="false" final="false" visibility="public"
  8460. deprecated="not deprecated">
  8461. <constructor name="TimelineEntities"
  8462. static="false" final="false" visibility="public"
  8463. deprecated="not deprecated">
  8464. </constructor>
  8465. <method name="getEntities" return="java.util.List"
  8466. abstract="false" native="false" synchronized="false"
  8467. static="false" final="false" visibility="public"
  8468. deprecated="not deprecated">
  8469. <doc>
  8470. <![CDATA[Get a list of entities
  8471. @return a list of entities]]>
  8472. </doc>
  8473. </method>
  8474. <method name="addEntity"
  8475. abstract="false" native="false" synchronized="false"
  8476. static="false" final="false" visibility="public"
  8477. deprecated="not deprecated">
  8478. <param name="entity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  8479. <doc>
  8480. <![CDATA[Add a single entity into the existing entity list
  8481. @param entity
  8482. a single entity]]>
  8483. </doc>
  8484. </method>
  8485. <method name="addEntities"
  8486. abstract="false" native="false" synchronized="false"
  8487. static="false" final="false" visibility="public"
  8488. deprecated="not deprecated">
  8489. <param name="entities" type="java.util.List"/>
  8490. <doc>
  8491. <![CDATA[All a list of entities into the existing entity list
  8492. @param entities
  8493. a list of entities]]>
  8494. </doc>
  8495. </method>
  8496. <method name="setEntities"
  8497. abstract="false" native="false" synchronized="false"
  8498. static="false" final="false" visibility="public"
  8499. deprecated="not deprecated">
  8500. <param name="entities" type="java.util.List"/>
  8501. <doc>
  8502. <![CDATA[Set the entity list to the given list of entities
  8503. @param entities
  8504. a list of entities]]>
  8505. </doc>
  8506. </method>
  8507. <doc>
  8508. <![CDATA[The class that hosts a list of timeline entities.]]>
  8509. </doc>
  8510. </class>
  8511. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
  8512. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  8513. <class name="TimelineEntity" extends="java.lang.Object"
  8514. abstract="false"
  8515. static="false" final="false" visibility="public"
  8516. deprecated="not deprecated">
  8517. <implements name="java.lang.Comparable"/>
  8518. <constructor name="TimelineEntity"
  8519. static="false" final="false" visibility="public"
  8520. deprecated="not deprecated">
  8521. </constructor>
  8522. <method name="getEntityType" return="java.lang.String"
  8523. abstract="false" native="false" synchronized="false"
  8524. static="false" final="false" visibility="public"
  8525. deprecated="not deprecated">
  8526. <doc>
  8527. <![CDATA[Get the entity type
  8528. @return the entity type]]>
  8529. </doc>
  8530. </method>
  8531. <method name="setEntityType"
  8532. abstract="false" native="false" synchronized="false"
  8533. static="false" final="false" visibility="public"
  8534. deprecated="not deprecated">
  8535. <param name="entityType" type="java.lang.String"/>
  8536. <doc>
  8537. <![CDATA[Set the entity type
  8538. @param entityType
  8539. the entity type]]>
  8540. </doc>
  8541. </method>
  8542. <method name="getEntityId" return="java.lang.String"
  8543. abstract="false" native="false" synchronized="false"
  8544. static="false" final="false" visibility="public"
  8545. deprecated="not deprecated">
  8546. <doc>
  8547. <![CDATA[Get the entity Id
  8548. @return the entity Id]]>
  8549. </doc>
  8550. </method>
  8551. <method name="setEntityId"
  8552. abstract="false" native="false" synchronized="false"
  8553. static="false" final="false" visibility="public"
  8554. deprecated="not deprecated">
  8555. <param name="entityId" type="java.lang.String"/>
  8556. <doc>
  8557. <![CDATA[Set the entity Id
  8558. @param entityId
  8559. the entity Id]]>
  8560. </doc>
  8561. </method>
  8562. <method name="getStartTime" return="java.lang.Long"
  8563. abstract="false" native="false" synchronized="false"
  8564. static="false" final="false" visibility="public"
  8565. deprecated="not deprecated">
  8566. <doc>
  8567. <![CDATA[Get the start time of the entity
  8568. @return the start time of the entity]]>
  8569. </doc>
  8570. </method>
  8571. <method name="setStartTime"
  8572. abstract="false" native="false" synchronized="false"
  8573. static="false" final="false" visibility="public"
  8574. deprecated="not deprecated">
  8575. <param name="startTime" type="java.lang.Long"/>
  8576. <doc>
  8577. <![CDATA[Set the start time of the entity
  8578. @param startTime
  8579. the start time of the entity]]>
  8580. </doc>
  8581. </method>
  8582. <method name="getEvents" return="java.util.List"
  8583. abstract="false" native="false" synchronized="false"
  8584. static="false" final="false" visibility="public"
  8585. deprecated="not deprecated">
  8586. <doc>
  8587. <![CDATA[Get a list of events related to the entity
  8588. @return a list of events related to the entity]]>
  8589. </doc>
  8590. </method>
  8591. <method name="addEvent"
  8592. abstract="false" native="false" synchronized="false"
  8593. static="false" final="false" visibility="public"
  8594. deprecated="not deprecated">
  8595. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  8596. <doc>
  8597. <![CDATA[Add a single event related to the entity to the existing event list
  8598. @param event
  8599. a single event related to the entity]]>
  8600. </doc>
  8601. </method>
  8602. <method name="addEvents"
  8603. abstract="false" native="false" synchronized="false"
  8604. static="false" final="false" visibility="public"
  8605. deprecated="not deprecated">
  8606. <param name="events" type="java.util.List"/>
  8607. <doc>
  8608. <![CDATA[Add a list of events related to the entity to the existing event list
  8609. @param events
  8610. a list of events related to the entity]]>
  8611. </doc>
  8612. </method>
  8613. <method name="setEvents"
  8614. abstract="false" native="false" synchronized="false"
  8615. static="false" final="false" visibility="public"
  8616. deprecated="not deprecated">
  8617. <param name="events" type="java.util.List"/>
  8618. <doc>
  8619. <![CDATA[Set the event list to the given list of events related to the entity
  8620. @param events
  8621. events a list of events related to the entity]]>
  8622. </doc>
  8623. </method>
  8624. <method name="getRelatedEntities" return="java.util.Map"
  8625. abstract="false" native="false" synchronized="false"
  8626. static="false" final="false" visibility="public"
  8627. deprecated="not deprecated">
  8628. <doc>
  8629. <![CDATA[Get the related entities
  8630. @return the related entities]]>
  8631. </doc>
  8632. </method>
  8633. <method name="addRelatedEntity"
  8634. abstract="false" native="false" synchronized="false"
  8635. static="false" final="false" visibility="public"
  8636. deprecated="not deprecated">
  8637. <param name="entityType" type="java.lang.String"/>
  8638. <param name="entityId" type="java.lang.String"/>
  8639. <doc>
  8640. <![CDATA[Add an entity to the existing related entity map
  8641. @param entityType
  8642. the entity type
  8643. @param entityId
  8644. the entity Id]]>
  8645. </doc>
  8646. </method>
  8647. <method name="addRelatedEntities"
  8648. abstract="false" native="false" synchronized="false"
  8649. static="false" final="false" visibility="public"
  8650. deprecated="not deprecated">
  8651. <param name="relatedEntities" type="java.util.Map"/>
  8652. <doc>
  8653. <![CDATA[Add a map of related entities to the existing related entity map
  8654. @param relatedEntities
  8655. a map of related entities]]>
  8656. </doc>
  8657. </method>
  8658. <method name="setRelatedEntities"
  8659. abstract="false" native="false" synchronized="false"
  8660. static="false" final="false" visibility="public"
  8661. deprecated="not deprecated">
  8662. <param name="relatedEntities" type="java.util.Map"/>
  8663. <doc>
  8664. <![CDATA[Set the related entity map to the given map of related entities
  8665. @param relatedEntities
  8666. a map of related entities]]>
  8667. </doc>
  8668. </method>
  8669. <method name="getPrimaryFilters" return="java.util.Map"
  8670. abstract="false" native="false" synchronized="false"
  8671. static="false" final="false" visibility="public"
  8672. deprecated="not deprecated">
  8673. <doc>
  8674. <![CDATA[Get the primary filters
  8675. @return the primary filters]]>
  8676. </doc>
  8677. </method>
  8678. <method name="addPrimaryFilter"
  8679. abstract="false" native="false" synchronized="false"
  8680. static="false" final="false" visibility="public"
  8681. deprecated="not deprecated">
  8682. <param name="key" type="java.lang.String"/>
  8683. <param name="value" type="java.lang.Object"/>
  8684. <doc>
  8685. <![CDATA[Add a single piece of primary filter to the existing primary filter map
  8686. @param key
  8687. the primary filter key
  8688. @param value
  8689. the primary filter value]]>
  8690. </doc>
  8691. </method>
  8692. <method name="addPrimaryFilters"
  8693. abstract="false" native="false" synchronized="false"
  8694. static="false" final="false" visibility="public"
  8695. deprecated="not deprecated">
  8696. <param name="primaryFilters" type="java.util.Map"/>
  8697. <doc>
  8698. <![CDATA[Add a map of primary filters to the existing primary filter map
  8699. @param primaryFilters
  8700. a map of primary filters]]>
  8701. </doc>
  8702. </method>
  8703. <method name="setPrimaryFilters"
  8704. abstract="false" native="false" synchronized="false"
  8705. static="false" final="false" visibility="public"
  8706. deprecated="not deprecated">
  8707. <param name="primaryFilters" type="java.util.Map"/>
  8708. <doc>
  8709. <![CDATA[Set the primary filter map to the given map of primary filters
  8710. @param primaryFilters
  8711. a map of primary filters]]>
  8712. </doc>
  8713. </method>
  8714. <method name="getOtherInfo" return="java.util.Map"
  8715. abstract="false" native="false" synchronized="false"
  8716. static="false" final="false" visibility="public"
  8717. deprecated="not deprecated">
  8718. <doc>
  8719. <![CDATA[Get the other information of the entity
  8720. @return the other information of the entity]]>
  8721. </doc>
  8722. </method>
  8723. <method name="addOtherInfo"
  8724. abstract="false" native="false" synchronized="false"
  8725. static="false" final="false" visibility="public"
  8726. deprecated="not deprecated">
  8727. <param name="key" type="java.lang.String"/>
  8728. <param name="value" type="java.lang.Object"/>
  8729. <doc>
  8730. <![CDATA[Add one piece of other information of the entity to the existing other info
  8731. map
  8732. @param key
  8733. the other information key
  8734. @param value
  8735. the other information value]]>
  8736. </doc>
  8737. </method>
  8738. <method name="addOtherInfo"
  8739. abstract="false" native="false" synchronized="false"
  8740. static="false" final="false" visibility="public"
  8741. deprecated="not deprecated">
  8742. <param name="otherInfo" type="java.util.Map"/>
  8743. <doc>
  8744. <![CDATA[Add a map of other information of the entity to the existing other info map
  8745. @param otherInfo
  8746. a map of other information]]>
  8747. </doc>
  8748. </method>
  8749. <method name="setOtherInfo"
  8750. abstract="false" native="false" synchronized="false"
  8751. static="false" final="false" visibility="public"
  8752. deprecated="not deprecated">
  8753. <param name="otherInfo" type="java.util.Map"/>
  8754. <doc>
  8755. <![CDATA[Set the other info map to the given map of other information
  8756. @param otherInfo
  8757. a map of other information]]>
  8758. </doc>
  8759. </method>
  8760. <method name="getDomainId" return="java.lang.String"
  8761. abstract="false" native="false" synchronized="false"
  8762. static="false" final="false" visibility="public"
  8763. deprecated="not deprecated">
  8764. <doc>
  8765. <![CDATA[Get the ID of the domain that the entity is to be put
  8766. @return the domain ID]]>
  8767. </doc>
  8768. </method>
  8769. <method name="setDomainId"
  8770. abstract="false" native="false" synchronized="false"
  8771. static="false" final="false" visibility="public"
  8772. deprecated="not deprecated">
  8773. <param name="domainId" type="java.lang.String"/>
  8774. <doc>
  8775. <![CDATA[Set the ID of the domain that the entity is to be put
  8776. @param domainId
  8777. the name space ID]]>
  8778. </doc>
  8779. </method>
  8780. <method name="hashCode" return="int"
  8781. abstract="false" native="false" synchronized="false"
  8782. static="false" final="false" visibility="public"
  8783. deprecated="not deprecated">
  8784. </method>
  8785. <method name="equals" return="boolean"
  8786. abstract="false" native="false" synchronized="false"
  8787. static="false" final="false" visibility="public"
  8788. deprecated="not deprecated">
  8789. <param name="obj" type="java.lang.Object"/>
  8790. </method>
  8791. <method name="compareTo" return="int"
  8792. abstract="false" native="false" synchronized="false"
  8793. static="false" final="false" visibility="public"
  8794. deprecated="not deprecated">
  8795. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
  8796. </method>
  8797. <doc>
  8798. <![CDATA[<p>
  8799. The class that contains the the meta information of some conceptual entity
  8800. and its related events. The entity can be an application, an application
  8801. attempt, a container or whatever the user-defined object.
  8802. </p>
  8803. <p>
  8804. Primary filters will be used to index the entities in
  8805. <code>TimelineStore</code>, such that users should carefully choose the
  8806. information they want to store as the primary filters. The remaining can be
  8807. stored as other information.
  8808. </p>]]>
  8809. </doc>
  8810. </class>
  8811. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
  8812. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  8813. <class name="TimelineEvent" extends="java.lang.Object"
  8814. abstract="false"
  8815. static="false" final="false" visibility="public"
  8816. deprecated="not deprecated">
  8817. <implements name="java.lang.Comparable"/>
  8818. <constructor name="TimelineEvent"
  8819. static="false" final="false" visibility="public"
  8820. deprecated="not deprecated">
  8821. </constructor>
  8822. <method name="getTimestamp" return="long"
  8823. abstract="false" native="false" synchronized="false"
  8824. static="false" final="false" visibility="public"
  8825. deprecated="not deprecated">
  8826. <doc>
  8827. <![CDATA[Get the timestamp of the event
  8828. @return the timestamp of the event]]>
  8829. </doc>
  8830. </method>
  8831. <method name="setTimestamp"
  8832. abstract="false" native="false" synchronized="false"
  8833. static="false" final="false" visibility="public"
  8834. deprecated="not deprecated">
  8835. <param name="timestamp" type="long"/>
  8836. <doc>
  8837. <![CDATA[Set the timestamp of the event
  8838. @param timestamp
  8839. the timestamp of the event]]>
  8840. </doc>
  8841. </method>
  8842. <method name="getEventType" return="java.lang.String"
  8843. abstract="false" native="false" synchronized="false"
  8844. static="false" final="false" visibility="public"
  8845. deprecated="not deprecated">
  8846. <doc>
  8847. <![CDATA[Get the event type
  8848. @return the event type]]>
  8849. </doc>
  8850. </method>
  8851. <method name="setEventType"
  8852. abstract="false" native="false" synchronized="false"
  8853. static="false" final="false" visibility="public"
  8854. deprecated="not deprecated">
  8855. <param name="eventType" type="java.lang.String"/>
  8856. <doc>
  8857. <![CDATA[Set the event type
  8858. @param eventType
  8859. the event type]]>
  8860. </doc>
  8861. </method>
  8862. <method name="getEventInfo" return="java.util.Map"
  8863. abstract="false" native="false" synchronized="false"
  8864. static="false" final="false" visibility="public"
  8865. deprecated="not deprecated">
  8866. <doc>
  8867. <![CDATA[Set the information of the event
  8868. @return the information of the event]]>
  8869. </doc>
  8870. </method>
  8871. <method name="addEventInfo"
  8872. abstract="false" native="false" synchronized="false"
  8873. static="false" final="false" visibility="public"
  8874. deprecated="not deprecated">
  8875. <param name="key" type="java.lang.String"/>
  8876. <param name="value" type="java.lang.Object"/>
  8877. <doc>
  8878. <![CDATA[Add one piece of the information of the event to the existing information
  8879. map
  8880. @param key
  8881. the information key
  8882. @param value
  8883. the information value]]>
  8884. </doc>
  8885. </method>
  8886. <method name="addEventInfo"
  8887. abstract="false" native="false" synchronized="false"
  8888. static="false" final="false" visibility="public"
  8889. deprecated="not deprecated">
  8890. <param name="eventInfo" type="java.util.Map"/>
  8891. <doc>
  8892. <![CDATA[Add a map of the information of the event to the existing information map
  8893. @param eventInfo
  8894. a map of of the information of the event]]>
  8895. </doc>
  8896. </method>
  8897. <method name="setEventInfo"
  8898. abstract="false" native="false" synchronized="false"
  8899. static="false" final="false" visibility="public"
  8900. deprecated="not deprecated">
  8901. <param name="eventInfo" type="java.util.Map"/>
  8902. <doc>
  8903. <![CDATA[Set the information map to the given map of the information of the event
  8904. @param eventInfo
  8905. a map of of the information of the event]]>
  8906. </doc>
  8907. </method>
  8908. <method name="compareTo" return="int"
  8909. abstract="false" native="false" synchronized="false"
  8910. static="false" final="false" visibility="public"
  8911. deprecated="not deprecated">
  8912. <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  8913. </method>
  8914. <method name="equals" return="boolean"
  8915. abstract="false" native="false" synchronized="false"
  8916. static="false" final="false" visibility="public"
  8917. deprecated="not deprecated">
  8918. <param name="o" type="java.lang.Object"/>
  8919. </method>
  8920. <method name="hashCode" return="int"
  8921. abstract="false" native="false" synchronized="false"
  8922. static="false" final="false" visibility="public"
  8923. deprecated="not deprecated">
  8924. </method>
  8925. <doc>
  8926. <![CDATA[The class that contains the information of an event that is related to some
  8927. conceptual entity of an application. Users are free to define what the event
  8928. means, such as starting an application, getting allocated a container and
  8929. etc.]]>
  8930. </doc>
  8931. </class>
  8932. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
  8933. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  8934. <class name="TimelineEvents" extends="java.lang.Object"
  8935. abstract="false"
  8936. static="false" final="false" visibility="public"
  8937. deprecated="not deprecated">
  8938. <constructor name="TimelineEvents"
  8939. static="false" final="false" visibility="public"
  8940. deprecated="not deprecated">
  8941. </constructor>
  8942. <method name="getAllEvents" return="java.util.List"
  8943. abstract="false" native="false" synchronized="false"
  8944. static="false" final="false" visibility="public"
  8945. deprecated="not deprecated">
  8946. <doc>
  8947. <![CDATA[Get a list of {@link EventsOfOneEntity} instances
  8948. @return a list of {@link EventsOfOneEntity} instances]]>
  8949. </doc>
  8950. </method>
  8951. <method name="addEvent"
  8952. abstract="false" native="false" synchronized="false"
  8953. static="false" final="false" visibility="public"
  8954. deprecated="not deprecated">
  8955. <param name="eventsOfOneEntity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity"/>
  8956. <doc>
  8957. <![CDATA[Add a single {@link EventsOfOneEntity} instance into the existing list
  8958. @param eventsOfOneEntity
  8959. a single {@link EventsOfOneEntity} instance]]>
  8960. </doc>
  8961. </method>
  8962. <method name="addEvents"
  8963. abstract="false" native="false" synchronized="false"
  8964. static="false" final="false" visibility="public"
  8965. deprecated="not deprecated">
  8966. <param name="allEvents" type="java.util.List"/>
  8967. <doc>
  8968. <![CDATA[Add a list of {@link EventsOfOneEntity} instances into the existing list
  8969. @param allEvents
  8970. a list of {@link EventsOfOneEntity} instances]]>
  8971. </doc>
  8972. </method>
  8973. <method name="setEvents"
  8974. abstract="false" native="false" synchronized="false"
  8975. static="false" final="false" visibility="public"
  8976. deprecated="not deprecated">
  8977. <param name="allEvents" type="java.util.List"/>
  8978. <doc>
  8979. <![CDATA[Set the list to the given list of {@link EventsOfOneEntity} instances
  8980. @param allEvents
  8981. a list of {@link EventsOfOneEntity} instances]]>
  8982. </doc>
  8983. </method>
  8984. <doc>
  8985. <![CDATA[The class that hosts a list of events, which are categorized according to
  8986. their related entities.]]>
  8987. </doc>
  8988. </class>
  8989. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
  8990. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  8991. <class name="TimelineEvents.EventsOfOneEntity" extends="java.lang.Object"
  8992. abstract="false"
  8993. static="true" final="false" visibility="public"
  8994. deprecated="not deprecated">
  8995. <constructor name="TimelineEvents.EventsOfOneEntity"
  8996. static="false" final="false" visibility="public"
  8997. deprecated="not deprecated">
  8998. </constructor>
  8999. <method name="getEntityId" return="java.lang.String"
  9000. abstract="false" native="false" synchronized="false"
  9001. static="false" final="false" visibility="public"
  9002. deprecated="not deprecated">
  9003. <doc>
  9004. <![CDATA[Get the entity Id
  9005. @return the entity Id]]>
  9006. </doc>
  9007. </method>
  9008. <method name="setEntityId"
  9009. abstract="false" native="false" synchronized="false"
  9010. static="false" final="false" visibility="public"
  9011. deprecated="not deprecated">
  9012. <param name="entityId" type="java.lang.String"/>
  9013. <doc>
  9014. <![CDATA[Set the entity Id
  9015. @param entityId
  9016. the entity Id]]>
  9017. </doc>
  9018. </method>
  9019. <method name="getEntityType" return="java.lang.String"
  9020. abstract="false" native="false" synchronized="false"
  9021. static="false" final="false" visibility="public"
  9022. deprecated="not deprecated">
  9023. <doc>
  9024. <![CDATA[Get the entity type
  9025. @return the entity type]]>
  9026. </doc>
  9027. </method>
  9028. <method name="setEntityType"
  9029. abstract="false" native="false" synchronized="false"
  9030. static="false" final="false" visibility="public"
  9031. deprecated="not deprecated">
  9032. <param name="entityType" type="java.lang.String"/>
  9033. <doc>
  9034. <![CDATA[Set the entity type
  9035. @param entityType
  9036. the entity type]]>
  9037. </doc>
  9038. </method>
  9039. <method name="getEvents" return="java.util.List"
  9040. abstract="false" native="false" synchronized="false"
  9041. static="false" final="false" visibility="public"
  9042. deprecated="not deprecated">
  9043. <doc>
  9044. <![CDATA[Get a list of events
  9045. @return a list of events]]>
  9046. </doc>
  9047. </method>
  9048. <method name="addEvent"
  9049. abstract="false" native="false" synchronized="false"
  9050. static="false" final="false" visibility="public"
  9051. deprecated="not deprecated">
  9052. <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
  9053. <doc>
  9054. <![CDATA[Add a single event to the existing event list
  9055. @param event
  9056. a single event]]>
  9057. </doc>
  9058. </method>
  9059. <method name="addEvents"
  9060. abstract="false" native="false" synchronized="false"
  9061. static="false" final="false" visibility="public"
  9062. deprecated="not deprecated">
  9063. <param name="events" type="java.util.List"/>
  9064. <doc>
  9065. <![CDATA[Add a list of event to the existing event list
  9066. @param events
  9067. a list of events]]>
  9068. </doc>
  9069. </method>
  9070. <method name="setEvents"
  9071. abstract="false" native="false" synchronized="false"
  9072. static="false" final="false" visibility="public"
  9073. deprecated="not deprecated">
  9074. <param name="events" type="java.util.List"/>
  9075. <doc>
  9076. <![CDATA[Set the event list to the given list of events
  9077. @param events
  9078. a list of events]]>
  9079. </doc>
  9080. </method>
  9081. <doc>
  9082. <![CDATA[The class that hosts a list of events that are only related to one entity.]]>
  9083. </doc>
  9084. </class>
  9085. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
  9086. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  9087. <class name="TimelinePutResponse" extends="java.lang.Object"
  9088. abstract="false"
  9089. static="false" final="false" visibility="public"
  9090. deprecated="not deprecated">
  9091. <constructor name="TimelinePutResponse"
  9092. static="false" final="false" visibility="public"
  9093. deprecated="not deprecated">
  9094. </constructor>
  9095. <method name="getErrors" return="java.util.List"
  9096. abstract="false" native="false" synchronized="false"
  9097. static="false" final="false" visibility="public"
  9098. deprecated="not deprecated">
  9099. <doc>
  9100. <![CDATA[Get a list of {@link TimelinePutError} instances
  9101. @return a list of {@link TimelinePutError} instances]]>
  9102. </doc>
  9103. </method>
  9104. <method name="addError"
  9105. abstract="false" native="false" synchronized="false"
  9106. static="false" final="false" visibility="public"
  9107. deprecated="not deprecated">
  9108. <param name="error" type="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError"/>
  9109. <doc>
  9110. <![CDATA[Add a single {@link TimelinePutError} instance into the existing list
  9111. @param error
  9112. a single {@link TimelinePutError} instance]]>
  9113. </doc>
  9114. </method>
  9115. <method name="addErrors"
  9116. abstract="false" native="false" synchronized="false"
  9117. static="false" final="false" visibility="public"
  9118. deprecated="not deprecated">
  9119. <param name="errors" type="java.util.List"/>
  9120. <doc>
  9121. <![CDATA[Add a list of {@link TimelinePutError} instances into the existing list
  9122. @param errors
  9123. a list of {@link TimelinePutError} instances]]>
  9124. </doc>
  9125. </method>
  9126. <method name="setErrors"
  9127. abstract="false" native="false" synchronized="false"
  9128. static="false" final="false" visibility="public"
  9129. deprecated="not deprecated">
  9130. <param name="errors" type="java.util.List"/>
  9131. <doc>
  9132. <![CDATA[Set the list to the given list of {@link TimelinePutError} instances
  9133. @param errors
  9134. a list of {@link TimelinePutError} instances]]>
  9135. </doc>
  9136. </method>
  9137. <doc>
  9138. <![CDATA[A class that holds a list of put errors. This is the response returned when a
  9139. list of {@link TimelineEntity} objects is added to the timeline. If there are errors
  9140. in storing individual entity objects, they will be indicated in the list of
  9141. errors.]]>
  9142. </doc>
  9143. </class>
  9144. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
  9145. <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  9146. <class name="TimelinePutResponse.TimelinePutError" extends="java.lang.Object"
  9147. abstract="false"
  9148. static="true" final="false" visibility="public"
  9149. deprecated="not deprecated">
  9150. <constructor name="TimelinePutResponse.TimelinePutError"
  9151. static="false" final="false" visibility="public"
  9152. deprecated="not deprecated">
  9153. </constructor>
  9154. <method name="getEntityId" return="java.lang.String"
  9155. abstract="false" native="false" synchronized="false"
  9156. static="false" final="false" visibility="public"
  9157. deprecated="not deprecated">
  9158. <doc>
  9159. <![CDATA[Get the entity Id
  9160. @return the entity Id]]>
  9161. </doc>
  9162. </method>
  9163. <method name="setEntityId"
  9164. abstract="false" native="false" synchronized="false"
  9165. static="false" final="false" visibility="public"
  9166. deprecated="not deprecated">
  9167. <param name="entityId" type="java.lang.String"/>
  9168. <doc>
  9169. <![CDATA[Set the entity Id
  9170. @param entityId
  9171. the entity Id]]>
  9172. </doc>
  9173. </method>
  9174. <method name="getEntityType" return="java.lang.String"
  9175. abstract="false" native="false" synchronized="false"
  9176. static="false" final="false" visibility="public"
  9177. deprecated="not deprecated">
  9178. <doc>
  9179. <![CDATA[Get the entity type
  9180. @return the entity type]]>
  9181. </doc>
  9182. </method>
  9183. <method name="setEntityType"
  9184. abstract="false" native="false" synchronized="false"
  9185. static="false" final="false" visibility="public"
  9186. deprecated="not deprecated">
  9187. <param name="entityType" type="java.lang.String"/>
  9188. <doc>
  9189. <![CDATA[Set the entity type
  9190. @param entityType
  9191. the entity type]]>
  9192. </doc>
  9193. </method>
  9194. <method name="getErrorCode" return="int"
  9195. abstract="false" native="false" synchronized="false"
  9196. static="false" final="false" visibility="public"
  9197. deprecated="not deprecated">
  9198. <doc>
  9199. <![CDATA[Get the error code
  9200. @return an error code]]>
  9201. </doc>
  9202. </method>
  9203. <method name="setErrorCode"
  9204. abstract="false" native="false" synchronized="false"
  9205. static="false" final="false" visibility="public"
  9206. deprecated="not deprecated">
  9207. <param name="errorCode" type="int"/>
  9208. <doc>
  9209. <![CDATA[Set the error code to the given error code
  9210. @param errorCode
  9211. an error code]]>
  9212. </doc>
  9213. </method>
  9214. <field name="NO_START_TIME" type="int"
  9215. transient="false" volatile="false"
  9216. static="true" final="true" visibility="public"
  9217. deprecated="not deprecated">
  9218. <doc>
  9219. <![CDATA[Error code returned when no start time can be found when putting an
  9220. entity. This occurs when the entity does not already exist in the store
  9221. and it is put with no start time or events specified.]]>
  9222. </doc>
  9223. </field>
  9224. <field name="IO_EXCEPTION" type="int"
  9225. transient="false" volatile="false"
  9226. static="true" final="true" visibility="public"
  9227. deprecated="not deprecated">
  9228. <doc>
  9229. <![CDATA[Error code returned if an IOException is encountered when putting an
  9230. entity.]]>
  9231. </doc>
  9232. </field>
  9233. <field name="SYSTEM_FILTER_CONFLICT" type="int"
  9234. transient="false" volatile="false"
  9235. static="true" final="true" visibility="public"
  9236. deprecated="not deprecated">
  9237. <doc>
  9238. <![CDATA[Error code returned if the user specifies the timeline system reserved
  9239. filter key]]>
  9240. </doc>
  9241. </field>
  9242. <field name="ACCESS_DENIED" type="int"
  9243. transient="false" volatile="false"
  9244. static="true" final="true" visibility="public"
  9245. deprecated="not deprecated">
  9246. <doc>
  9247. <![CDATA[Error code returned if the user is denied to access the timeline data]]>
  9248. </doc>
  9249. </field>
  9250. <field name="NO_DOMAIN" type="int"
  9251. transient="false" volatile="false"
  9252. static="true" final="true" visibility="public"
  9253. deprecated="not deprecated">
  9254. <doc>
  9255. <![CDATA[Error code returned if the entity doesn't have an valid domain ID]]>
  9256. </doc>
  9257. </field>
  9258. <field name="FORBIDDEN_RELATION" type="int"
  9259. transient="false" volatile="false"
  9260. static="true" final="true" visibility="public"
  9261. deprecated="not deprecated">
  9262. <doc>
  9263. <![CDATA[Error code returned if the user is denied to relate the entity to another
  9264. one in different domain]]>
  9265. </doc>
  9266. </field>
  9267. <doc>
  9268. <![CDATA[A class that holds the error code for one entity.]]>
  9269. </doc>
  9270. </class>
  9271. <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
  9272. </package>
  9273. <package name="org.apache.hadoop.yarn.conf">
  9274. <!-- start class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  9275. <class name="YarnConfiguration" extends="org.apache.hadoop.conf.Configuration"
  9276. abstract="false"
  9277. static="false" final="false" visibility="public"
  9278. deprecated="not deprecated">
  9279. <constructor name="YarnConfiguration"
  9280. static="false" final="false" visibility="public"
  9281. deprecated="not deprecated">
  9282. </constructor>
  9283. <constructor name="YarnConfiguration" type="org.apache.hadoop.conf.Configuration"
  9284. static="false" final="false" visibility="public"
  9285. deprecated="not deprecated">
  9286. </constructor>
  9287. <method name="getSocketAddr" return="java.net.InetSocketAddress"
  9288. abstract="false" native="false" synchronized="false"
  9289. static="false" final="false" visibility="public"
  9290. deprecated="not deprecated">
  9291. <param name="name" type="java.lang.String"/>
  9292. <param name="defaultAddress" type="java.lang.String"/>
  9293. <param name="defaultPort" type="int"/>
  9294. <doc>
  9295. <![CDATA[Get the socket address for <code>name</code> property as a
  9296. <code>InetSocketAddress</code>. On a HA cluster,
  9297. this fetches the address corresponding to the RM identified by
  9298. {@link #RM_HA_ID}.
  9299. @param name property name.
  9300. @param defaultAddress the default value
  9301. @param defaultPort the default port
  9302. @return InetSocketAddress]]>
  9303. </doc>
  9304. </method>
  9305. <method name="updateConnectAddr" return="java.net.InetSocketAddress"
  9306. abstract="false" native="false" synchronized="false"
  9307. static="false" final="false" visibility="public"
  9308. deprecated="not deprecated">
  9309. <param name="name" type="java.lang.String"/>
  9310. <param name="addr" type="java.net.InetSocketAddress"/>
  9311. </method>
  9312. <method name="useHttps" return="boolean"
  9313. abstract="false" native="false" synchronized="false"
  9314. static="true" final="false" visibility="public"
  9315. deprecated="not deprecated">
  9316. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  9317. </method>
  9318. <method name="shouldRMFailFast" return="boolean"
  9319. abstract="false" native="false" synchronized="false"
  9320. static="true" final="false" visibility="public"
  9321. deprecated="not deprecated">
  9322. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  9323. </method>
  9324. <field name="CS_CONFIGURATION_FILE" type="java.lang.String"
  9325. transient="false" volatile="false"
  9326. static="true" final="true" visibility="public"
  9327. deprecated="not deprecated">
  9328. </field>
  9329. <field name="HADOOP_POLICY_CONFIGURATION_FILE" type="java.lang.String"
  9330. transient="false" volatile="false"
  9331. static="true" final="true" visibility="public"
  9332. deprecated="not deprecated">
  9333. </field>
  9334. <field name="YARN_SITE_CONFIGURATION_FILE" type="java.lang.String"
  9335. transient="false" volatile="false"
  9336. static="true" final="true" visibility="public"
  9337. deprecated="not deprecated">
  9338. </field>
  9339. <field name="CORE_SITE_CONFIGURATION_FILE" type="java.lang.String"
  9340. transient="false" volatile="false"
  9341. static="true" final="true" visibility="public"
  9342. deprecated="not deprecated">
  9343. </field>
  9344. <field name="RM_CONFIGURATION_FILES" type="java.util.List"
  9345. transient="false" volatile="false"
  9346. static="true" final="true" visibility="public"
  9347. deprecated="not deprecated">
  9348. </field>
  9349. <field name="APPLICATION_MAX_TAGS" type="int"
  9350. transient="false" volatile="false"
  9351. static="true" final="true" visibility="public"
  9352. deprecated="not deprecated">
  9353. </field>
  9354. <field name="APPLICATION_MAX_TAG_LENGTH" type="int"
  9355. transient="false" volatile="false"
  9356. static="true" final="true" visibility="public"
  9357. deprecated="not deprecated">
  9358. </field>
  9359. <field name="YARN_PREFIX" type="java.lang.String"
  9360. transient="false" volatile="false"
  9361. static="true" final="true" visibility="public"
  9362. deprecated="not deprecated">
  9363. </field>
  9364. <field name="DEBUG_NM_DELETE_DELAY_SEC" type="java.lang.String"
  9365. transient="false" volatile="false"
  9366. static="true" final="true" visibility="public"
  9367. deprecated="not deprecated">
  9368. <doc>
  9369. <![CDATA[Delay before deleting resource to ease debugging of NM issues]]>
  9370. </doc>
  9371. </field>
  9372. <field name="IPC_PREFIX" type="java.lang.String"
  9373. transient="false" volatile="false"
  9374. static="true" final="true" visibility="public"
  9375. deprecated="not deprecated">
  9376. </field>
  9377. <field name="IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  9378. transient="false" volatile="false"
  9379. static="true" final="true" visibility="public"
  9380. deprecated="not deprecated">
  9381. <doc>
  9382. <![CDATA[Factory to create client IPC classes.]]>
  9383. </doc>
  9384. </field>
  9385. <field name="DEFAULT_IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
  9386. transient="false" volatile="false"
  9387. static="true" final="true" visibility="public"
  9388. deprecated="not deprecated">
  9389. </field>
  9390. <field name="IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  9391. transient="false" volatile="false"
  9392. static="true" final="true" visibility="public"
  9393. deprecated="not deprecated">
  9394. <doc>
  9395. <![CDATA[Factory to create server IPC classes.]]>
  9396. </doc>
  9397. </field>
  9398. <field name="DEFAULT_IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
  9399. transient="false" volatile="false"
  9400. static="true" final="true" visibility="public"
  9401. deprecated="not deprecated">
  9402. </field>
  9403. <field name="IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  9404. transient="false" volatile="false"
  9405. static="true" final="true" visibility="public"
  9406. deprecated="not deprecated">
  9407. <doc>
  9408. <![CDATA[Factory to create serializeable records.]]>
  9409. </doc>
  9410. </field>
  9411. <field name="DEFAULT_IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
  9412. transient="false" volatile="false"
  9413. static="true" final="true" visibility="public"
  9414. deprecated="not deprecated">
  9415. </field>
  9416. <field name="IPC_RPC_IMPL" type="java.lang.String"
  9417. transient="false" volatile="false"
  9418. static="true" final="true" visibility="public"
  9419. deprecated="not deprecated">
  9420. <doc>
  9421. <![CDATA[RPC class implementation]]>
  9422. </doc>
  9423. </field>
  9424. <field name="DEFAULT_IPC_RPC_IMPL" type="java.lang.String"
  9425. transient="false" volatile="false"
  9426. static="true" final="true" visibility="public"
  9427. deprecated="not deprecated">
  9428. </field>
  9429. <field name="RM_PREFIX" type="java.lang.String"
  9430. transient="false" volatile="false"
  9431. static="true" final="true" visibility="public"
  9432. deprecated="not deprecated">
  9433. </field>
  9434. <field name="RM_CLUSTER_ID" type="java.lang.String"
  9435. transient="false" volatile="false"
  9436. static="true" final="true" visibility="public"
  9437. deprecated="not deprecated">
  9438. </field>
  9439. <field name="RM_HOSTNAME" type="java.lang.String"
  9440. transient="false" volatile="false"
  9441. static="true" final="true" visibility="public"
  9442. deprecated="not deprecated">
  9443. </field>
  9444. <field name="RM_ADDRESS" type="java.lang.String"
  9445. transient="false" volatile="false"
  9446. static="true" final="true" visibility="public"
  9447. deprecated="not deprecated">
  9448. <doc>
  9449. <![CDATA[The address of the applications manager interface in the RM.]]>
  9450. </doc>
  9451. </field>
  9452. <field name="DEFAULT_RM_PORT" type="int"
  9453. transient="false" volatile="false"
  9454. static="true" final="true" visibility="public"
  9455. deprecated="not deprecated">
  9456. </field>
  9457. <field name="DEFAULT_RM_ADDRESS" type="java.lang.String"
  9458. transient="false" volatile="false"
  9459. static="true" final="true" visibility="public"
  9460. deprecated="not deprecated">
  9461. </field>
  9462. <field name="RM_BIND_HOST" type="java.lang.String"
  9463. transient="false" volatile="false"
  9464. static="true" final="true" visibility="public"
  9465. deprecated="not deprecated">
  9466. <doc>
  9467. <![CDATA[The actual bind address for the RM.]]>
  9468. </doc>
  9469. </field>
  9470. <field name="RM_CLIENT_THREAD_COUNT" type="java.lang.String"
  9471. transient="false" volatile="false"
  9472. static="true" final="true" visibility="public"
  9473. deprecated="not deprecated">
  9474. <doc>
  9475. <![CDATA[The number of threads used to handle applications manager requests.]]>
  9476. </doc>
  9477. </field>
  9478. <field name="DEFAULT_RM_CLIENT_THREAD_COUNT" type="int"
  9479. transient="false" volatile="false"
  9480. static="true" final="true" visibility="public"
  9481. deprecated="not deprecated">
  9482. </field>
  9483. <field name="RM_AMLAUNCHER_THREAD_COUNT" type="java.lang.String"
  9484. transient="false" volatile="false"
  9485. static="true" final="true" visibility="public"
  9486. deprecated="not deprecated">
  9487. <doc>
  9488. <![CDATA[Number of threads used to launch/cleanup AM.]]>
  9489. </doc>
  9490. </field>
  9491. <field name="DEFAULT_RM_AMLAUNCHER_THREAD_COUNT" type="int"
  9492. transient="false" volatile="false"
  9493. static="true" final="true" visibility="public"
  9494. deprecated="not deprecated">
  9495. </field>
  9496. <field name="RM_NODEMANAGER_CONNECT_RETIRES" type="java.lang.String"
  9497. transient="false" volatile="false"
  9498. static="true" final="true" visibility="public"
  9499. deprecated="not deprecated">
  9500. <doc>
  9501. <![CDATA[Retry times to connect with NM.]]>
  9502. </doc>
  9503. </field>
  9504. <field name="DEFAULT_RM_NODEMANAGER_CONNECT_RETIRES" type="int"
  9505. transient="false" volatile="false"
  9506. static="true" final="true" visibility="public"
  9507. deprecated="not deprecated">
  9508. </field>
  9509. <field name="RM_PRINCIPAL" type="java.lang.String"
  9510. transient="false" volatile="false"
  9511. static="true" final="true" visibility="public"
  9512. deprecated="not deprecated">
  9513. <doc>
  9514. <![CDATA[The Kerberos principal for the resource manager.]]>
  9515. </doc>
  9516. </field>
  9517. <field name="RM_SCHEDULER_ADDRESS" type="java.lang.String"
  9518. transient="false" volatile="false"
  9519. static="true" final="true" visibility="public"
  9520. deprecated="not deprecated">
  9521. <doc>
  9522. <![CDATA[The address of the scheduler interface.]]>
  9523. </doc>
  9524. </field>
  9525. <field name="DEFAULT_RM_SCHEDULER_PORT" type="int"
  9526. transient="false" volatile="false"
  9527. static="true" final="true" visibility="public"
  9528. deprecated="not deprecated">
  9529. </field>
  9530. <field name="DEFAULT_RM_SCHEDULER_ADDRESS" type="java.lang.String"
  9531. transient="false" volatile="false"
  9532. static="true" final="true" visibility="public"
  9533. deprecated="not deprecated">
  9534. </field>
  9535. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="java.lang.String"
  9536. transient="false" volatile="false"
  9537. static="true" final="true" visibility="public"
  9538. deprecated="not deprecated">
  9539. <doc>
  9540. <![CDATA[Miniumum request grant-able by the RM scheduler.]]>
  9541. </doc>
  9542. </field>
  9543. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="int"
  9544. transient="false" volatile="false"
  9545. static="true" final="true" visibility="public"
  9546. deprecated="not deprecated">
  9547. </field>
  9548. <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="java.lang.String"
  9549. transient="false" volatile="false"
  9550. static="true" final="true" visibility="public"
  9551. deprecated="not deprecated">
  9552. </field>
  9553. <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="int"
  9554. transient="false" volatile="false"
  9555. static="true" final="true" visibility="public"
  9556. deprecated="not deprecated">
  9557. </field>
  9558. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="java.lang.String"
  9559. transient="false" volatile="false"
  9560. static="true" final="true" visibility="public"
  9561. deprecated="not deprecated">
  9562. <doc>
  9563. <![CDATA[Maximum request grant-able by the RM scheduler.]]>
  9564. </doc>
  9565. </field>
  9566. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="int"
  9567. transient="false" volatile="false"
  9568. static="true" final="true" visibility="public"
  9569. deprecated="not deprecated">
  9570. </field>
  9571. <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="java.lang.String"
  9572. transient="false" volatile="false"
  9573. static="true" final="true" visibility="public"
  9574. deprecated="not deprecated">
  9575. </field>
  9576. <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="int"
  9577. transient="false" volatile="false"
  9578. static="true" final="true" visibility="public"
  9579. deprecated="not deprecated">
  9580. </field>
  9581. <field name="RM_SCHEDULER_CLIENT_THREAD_COUNT" type="java.lang.String"
  9582. transient="false" volatile="false"
  9583. static="true" final="true" visibility="public"
  9584. deprecated="not deprecated">
  9585. <doc>
  9586. <![CDATA[Number of threads to handle scheduler interface.]]>
  9587. </doc>
  9588. </field>
  9589. <field name="DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT" type="int"
  9590. transient="false" volatile="false"
  9591. static="true" final="true" visibility="public"
  9592. deprecated="not deprecated">
  9593. </field>
  9594. <field name="RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME" type="java.lang.String"
  9595. transient="false" volatile="false"
  9596. static="true" final="true" visibility="public"
  9597. deprecated="not deprecated">
  9598. <doc>
  9599. <![CDATA[If the port should be included or not in the node name. The node name
  9600. is used by the scheduler for resource requests allocation location
  9601. matching. Typically this is just the hostname, using the port is needed
  9602. when using minicluster and specific NM are required.]]>
  9603. </doc>
  9604. </field>
  9605. <field name="DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME" type="boolean"
  9606. transient="false" volatile="false"
  9607. static="true" final="true" visibility="public"
  9608. deprecated="not deprecated">
  9609. </field>
  9610. <field name="RM_WEBAPP_UI_ACTIONS_ENABLED" type="java.lang.String"
  9611. transient="false" volatile="false"
  9612. static="true" final="true" visibility="public"
  9613. deprecated="not deprecated">
  9614. <doc>
  9615. <![CDATA[Enable Resource Manager webapp ui actions]]>
  9616. </doc>
  9617. </field>
  9618. <field name="DEFAULT_RM_WEBAPP_UI_ACTIONS_ENABLED" type="boolean"
  9619. transient="false" volatile="false"
  9620. static="true" final="true" visibility="public"
  9621. deprecated="not deprecated">
  9622. </field>
  9623. <field name="RM_RESERVATION_SYSTEM_ENABLE" type="java.lang.String"
  9624. transient="false" volatile="false"
  9625. static="true" final="true" visibility="public"
  9626. deprecated="not deprecated">
  9627. <doc>
  9628. <![CDATA[Whether the RM should enable Reservation System]]>
  9629. </doc>
  9630. </field>
  9631. <field name="DEFAULT_RM_RESERVATION_SYSTEM_ENABLE" type="boolean"
  9632. transient="false" volatile="false"
  9633. static="true" final="true" visibility="public"
  9634. deprecated="not deprecated">
  9635. </field>
  9636. <field name="RM_RESERVATION_SYSTEM_CLASS" type="java.lang.String"
  9637. transient="false" volatile="false"
  9638. static="true" final="true" visibility="public"
  9639. deprecated="not deprecated">
  9640. <doc>
  9641. <![CDATA[The class to use as the Reservation System.]]>
  9642. </doc>
  9643. </field>
  9644. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER" type="java.lang.String"
  9645. transient="false" volatile="false"
  9646. static="true" final="true" visibility="public"
  9647. deprecated="not deprecated">
  9648. <doc>
  9649. <![CDATA[The PlanFollower for the Reservation System.]]>
  9650. </doc>
  9651. </field>
  9652. <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="java.lang.String"
  9653. transient="false" volatile="false"
  9654. static="true" final="true" visibility="public"
  9655. deprecated="not deprecated">
  9656. <doc>
  9657. <![CDATA[The step size of the Reservation System.]]>
  9658. </doc>
  9659. </field>
  9660. <field name="DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="long"
  9661. transient="false" volatile="false"
  9662. static="true" final="true" visibility="public"
  9663. deprecated="not deprecated">
  9664. </field>
  9665. <field name="RM_SCHEDULER_ENABLE_MONITORS" type="java.lang.String"
  9666. transient="false" volatile="false"
  9667. static="true" final="true" visibility="public"
  9668. deprecated="not deprecated">
  9669. <doc>
  9670. <![CDATA[Enable periodic monitor threads.
  9671. @see #RM_SCHEDULER_MONITOR_POLICIES]]>
  9672. </doc>
  9673. </field>
  9674. <field name="DEFAULT_RM_SCHEDULER_ENABLE_MONITORS" type="boolean"
  9675. transient="false" volatile="false"
  9676. static="true" final="true" visibility="public"
  9677. deprecated="not deprecated">
  9678. </field>
  9679. <field name="RM_SCHEDULER_MONITOR_POLICIES" type="java.lang.String"
  9680. transient="false" volatile="false"
  9681. static="true" final="true" visibility="public"
  9682. deprecated="not deprecated">
  9683. <doc>
  9684. <![CDATA[List of SchedulingEditPolicy classes affecting the scheduler.]]>
  9685. </doc>
  9686. </field>
  9687. <field name="RM_WEBAPP_ADDRESS" type="java.lang.String"
  9688. transient="false" volatile="false"
  9689. static="true" final="true" visibility="public"
  9690. deprecated="not deprecated">
  9691. <doc>
  9692. <![CDATA[The address of the RM web application.]]>
  9693. </doc>
  9694. </field>
  9695. <field name="DEFAULT_RM_WEBAPP_PORT" type="int"
  9696. transient="false" volatile="false"
  9697. static="true" final="true" visibility="public"
  9698. deprecated="not deprecated">
  9699. </field>
  9700. <field name="DEFAULT_RM_WEBAPP_ADDRESS" type="java.lang.String"
  9701. transient="false" volatile="false"
  9702. static="true" final="true" visibility="public"
  9703. deprecated="not deprecated">
  9704. </field>
  9705. <field name="RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  9706. transient="false" volatile="false"
  9707. static="true" final="true" visibility="public"
  9708. deprecated="not deprecated">
  9709. <doc>
  9710. <![CDATA[The https address of the RM web application.]]>
  9711. </doc>
  9712. </field>
  9713. <field name="YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT" type="boolean"
  9714. transient="false" volatile="false"
  9715. static="true" final="true" visibility="public"
  9716. deprecated="not deprecated">
  9717. </field>
  9718. <field name="YARN_SSL_SERVER_RESOURCE_DEFAULT" type="java.lang.String"
  9719. transient="false" volatile="false"
  9720. static="true" final="true" visibility="public"
  9721. deprecated="not deprecated">
  9722. </field>
  9723. <field name="DEFAULT_RM_WEBAPP_HTTPS_PORT" type="int"
  9724. transient="false" volatile="false"
  9725. static="true" final="true" visibility="public"
  9726. deprecated="not deprecated">
  9727. </field>
  9728. <field name="DEFAULT_RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  9729. transient="false" volatile="false"
  9730. static="true" final="true" visibility="public"
  9731. deprecated="not deprecated">
  9732. </field>
  9733. <field name="RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  9734. transient="false" volatile="false"
  9735. static="true" final="true" visibility="public"
  9736. deprecated="not deprecated">
  9737. </field>
  9738. <field name="DEFAULT_RM_RESOURCE_TRACKER_PORT" type="int"
  9739. transient="false" volatile="false"
  9740. static="true" final="true" visibility="public"
  9741. deprecated="not deprecated">
  9742. </field>
  9743. <field name="DEFAULT_RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
  9744. transient="false" volatile="false"
  9745. static="true" final="true" visibility="public"
  9746. deprecated="not deprecated">
  9747. </field>
  9748. <field name="RM_AM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  9749. transient="false" volatile="false"
  9750. static="true" final="true" visibility="public"
  9751. deprecated="not deprecated">
  9752. <doc>
  9753. <![CDATA[The expiry interval for application master reporting.]]>
  9754. </doc>
  9755. </field>
  9756. <field name="DEFAULT_RM_AM_EXPIRY_INTERVAL_MS" type="int"
  9757. transient="false" volatile="false"
  9758. static="true" final="true" visibility="public"
  9759. deprecated="not deprecated">
  9760. </field>
  9761. <field name="RM_NM_EXPIRY_INTERVAL_MS" type="java.lang.String"
  9762. transient="false" volatile="false"
  9763. static="true" final="true" visibility="public"
  9764. deprecated="not deprecated">
  9765. <doc>
  9766. <![CDATA[How long to wait until a node manager is considered dead.]]>
  9767. </doc>
  9768. </field>
  9769. <field name="DEFAULT_RM_NM_EXPIRY_INTERVAL_MS" type="int"
  9770. transient="false" volatile="false"
  9771. static="true" final="true" visibility="public"
  9772. deprecated="not deprecated">
  9773. </field>
  9774. <field name="YARN_ACL_ENABLE" type="java.lang.String"
  9775. transient="false" volatile="false"
  9776. static="true" final="true" visibility="public"
  9777. deprecated="not deprecated">
  9778. <doc>
  9779. <![CDATA[Are acls enabled.]]>
  9780. </doc>
  9781. </field>
  9782. <field name="DEFAULT_YARN_ACL_ENABLE" type="boolean"
  9783. transient="false" volatile="false"
  9784. static="true" final="true" visibility="public"
  9785. deprecated="not deprecated">
  9786. </field>
  9787. <field name="YARN_ADMIN_ACL" type="java.lang.String"
  9788. transient="false" volatile="false"
  9789. static="true" final="true" visibility="public"
  9790. deprecated="not deprecated">
  9791. <doc>
  9792. <![CDATA[ACL of who can be admin of YARN cluster.]]>
  9793. </doc>
  9794. </field>
  9795. <field name="DEFAULT_YARN_ADMIN_ACL" type="java.lang.String"
  9796. transient="false" volatile="false"
  9797. static="true" final="true" visibility="public"
  9798. deprecated="not deprecated">
  9799. </field>
  9800. <field name="DEFAULT_YARN_APP_ACL" type="java.lang.String"
  9801. transient="false" volatile="false"
  9802. static="true" final="true" visibility="public"
  9803. deprecated="not deprecated">
  9804. <doc>
  9805. <![CDATA[ACL used in case none is found. Allows nothing.]]>
  9806. </doc>
  9807. </field>
  9808. <field name="YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.String"
  9809. transient="false" volatile="false"
  9810. static="true" final="true" visibility="public"
  9811. deprecated="not deprecated">
  9812. <doc>
  9813. <![CDATA[Enable/disable intermediate-data encryption at YARN level. For now, this
  9814. only is used by the FileSystemRMStateStore to setup right file-system
  9815. security attributes.]]>
  9816. </doc>
  9817. </field>
  9818. <field name="DEFAULT_YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.Boolean"
  9819. transient="false" volatile="false"
  9820. static="true" final="true" visibility="public"
  9821. deprecated="not deprecated">
  9822. </field>
  9823. <field name="RM_ADMIN_ADDRESS" type="java.lang.String"
  9824. transient="false" volatile="false"
  9825. static="true" final="true" visibility="public"
  9826. deprecated="not deprecated">
  9827. <doc>
  9828. <![CDATA[The address of the RM admin interface.]]>
  9829. </doc>
  9830. </field>
  9831. <field name="DEFAULT_RM_ADMIN_PORT" type="int"
  9832. transient="false" volatile="false"
  9833. static="true" final="true" visibility="public"
  9834. deprecated="not deprecated">
  9835. </field>
  9836. <field name="DEFAULT_RM_ADMIN_ADDRESS" type="java.lang.String"
  9837. transient="false" volatile="false"
  9838. static="true" final="true" visibility="public"
  9839. deprecated="not deprecated">
  9840. </field>
  9841. <field name="RM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  9842. transient="false" volatile="false"
  9843. static="true" final="true" visibility="public"
  9844. deprecated="not deprecated">
  9845. <doc>
  9846. <![CDATA[Number of threads used to handle RM admin interface.]]>
  9847. </doc>
  9848. </field>
  9849. <field name="DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  9850. transient="false" volatile="false"
  9851. static="true" final="true" visibility="public"
  9852. deprecated="not deprecated">
  9853. </field>
  9854. <field name="RM_AM_MAX_ATTEMPTS" type="java.lang.String"
  9855. transient="false" volatile="false"
  9856. static="true" final="true" visibility="public"
  9857. deprecated="not deprecated">
  9858. <doc>
  9859. <![CDATA[The maximum number of application attempts.
  9860. It's a global setting for all application masters.]]>
  9861. </doc>
  9862. </field>
  9863. <field name="DEFAULT_RM_AM_MAX_ATTEMPTS" type="int"
  9864. transient="false" volatile="false"
  9865. static="true" final="true" visibility="public"
  9866. deprecated="not deprecated">
  9867. </field>
  9868. <field name="RM_KEYTAB" type="java.lang.String"
  9869. transient="false" volatile="false"
  9870. static="true" final="true" visibility="public"
  9871. deprecated="not deprecated">
  9872. <doc>
  9873. <![CDATA[The keytab for the resource manager.]]>
  9874. </doc>
  9875. </field>
  9876. <field name="RM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  9877. transient="false" volatile="false"
  9878. static="true" final="true" visibility="public"
  9879. deprecated="not deprecated">
  9880. <doc>
  9881. <![CDATA[The kerberos principal to be used for spnego filter for RM.]]>
  9882. </doc>
  9883. </field>
  9884. <field name="RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  9885. transient="false" volatile="false"
  9886. static="true" final="true" visibility="public"
  9887. deprecated="not deprecated">
  9888. <doc>
  9889. <![CDATA[The kerberos keytab to be used for spnego filter for RM.]]>
  9890. </doc>
  9891. </field>
  9892. <field name="RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="java.lang.String"
  9893. transient="false" volatile="false"
  9894. static="true" final="true" visibility="public"
  9895. deprecated="not deprecated">
  9896. <doc>
  9897. <![CDATA[Flag to enable override of the default kerberos authentication filter with
  9898. the RM authentication filter to allow authentication using delegation
  9899. tokens(fallback to kerberos if the tokens are missing). Only applicable
  9900. when the http authentication type is kerberos.]]>
  9901. </doc>
  9902. </field>
  9903. <field name="DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="boolean"
  9904. transient="false" volatile="false"
  9905. static="true" final="true" visibility="public"
  9906. deprecated="not deprecated">
  9907. </field>
  9908. <field name="RM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  9909. transient="false" volatile="false"
  9910. static="true" final="true" visibility="public"
  9911. deprecated="not deprecated">
  9912. <doc>
  9913. <![CDATA[Enable cross origin (CORS) support.]]>
  9914. </doc>
  9915. </field>
  9916. <field name="DEFAULT_RM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  9917. transient="false" volatile="false"
  9918. static="true" final="true" visibility="public"
  9919. deprecated="not deprecated">
  9920. </field>
  9921. <field name="RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="java.lang.String"
  9922. transient="false" volatile="false"
  9923. static="true" final="true" visibility="public"
  9924. deprecated="not deprecated">
  9925. <doc>
  9926. <![CDATA[How long to wait until a container is considered dead.]]>
  9927. </doc>
  9928. </field>
  9929. <field name="DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="int"
  9930. transient="false" volatile="false"
  9931. static="true" final="true" visibility="public"
  9932. deprecated="not deprecated">
  9933. </field>
  9934. <field name="RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  9935. transient="false" volatile="false"
  9936. static="true" final="true" visibility="public"
  9937. deprecated="not deprecated">
  9938. <doc>
  9939. <![CDATA[Path to file with nodes to include.]]>
  9940. </doc>
  9941. </field>
  9942. <field name="DEFAULT_RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
  9943. transient="false" volatile="false"
  9944. static="true" final="true" visibility="public"
  9945. deprecated="not deprecated">
  9946. </field>
  9947. <field name="RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  9948. transient="false" volatile="false"
  9949. static="true" final="true" visibility="public"
  9950. deprecated="not deprecated">
  9951. <doc>
  9952. <![CDATA[Path to file with nodes to exclude.]]>
  9953. </doc>
  9954. </field>
  9955. <field name="DEFAULT_RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
  9956. transient="false" volatile="false"
  9957. static="true" final="true" visibility="public"
  9958. deprecated="not deprecated">
  9959. </field>
  9960. <field name="RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="java.lang.String"
  9961. transient="false" volatile="false"
  9962. static="true" final="true" visibility="public"
  9963. deprecated="not deprecated">
  9964. <doc>
  9965. <![CDATA[Number of threads to handle resource tracker calls.]]>
  9966. </doc>
  9967. </field>
  9968. <field name="DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="int"
  9969. transient="false" volatile="false"
  9970. static="true" final="true" visibility="public"
  9971. deprecated="not deprecated">
  9972. </field>
  9973. <field name="RM_SCHEDULER" type="java.lang.String"
  9974. transient="false" volatile="false"
  9975. static="true" final="true" visibility="public"
  9976. deprecated="not deprecated">
  9977. <doc>
  9978. <![CDATA[The class to use as the resource scheduler.]]>
  9979. </doc>
  9980. </field>
  9981. <field name="DEFAULT_RM_SCHEDULER" type="java.lang.String"
  9982. transient="false" volatile="false"
  9983. static="true" final="true" visibility="public"
  9984. deprecated="not deprecated">
  9985. </field>
  9986. <field name="RM_NM_HEARTBEAT_INTERVAL_MS" type="java.lang.String"
  9987. transient="false" volatile="false"
  9988. static="true" final="true" visibility="public"
  9989. deprecated="not deprecated">
  9990. <doc>
  9991. <![CDATA[RM set next Heartbeat interval for NM]]>
  9992. </doc>
  9993. </field>
  9994. <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS" type="long"
  9995. transient="false" volatile="false"
  9996. static="true" final="true" visibility="public"
  9997. deprecated="not deprecated">
  9998. </field>
  9999. <field name="RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="java.lang.String"
  10000. transient="false" volatile="false"
  10001. static="true" final="true" visibility="public"
  10002. deprecated="not deprecated">
  10003. <doc>
  10004. <![CDATA[Number of worker threads that write the history data.]]>
  10005. </doc>
  10006. </field>
  10007. <field name="DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="int"
  10008. transient="false" volatile="false"
  10009. static="true" final="true" visibility="public"
  10010. deprecated="not deprecated">
  10011. </field>
  10012. <field name="RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
  10013. transient="false" volatile="false"
  10014. static="true" final="true" visibility="public"
  10015. deprecated="not deprecated">
  10016. <doc>
  10017. <![CDATA[The setting that controls whether yarn system metrics is published on the
  10018. timeline server or not by RM.]]>
  10019. </doc>
  10020. </field>
  10021. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
  10022. transient="false" volatile="false"
  10023. static="true" final="true" visibility="public"
  10024. deprecated="not deprecated">
  10025. </field>
  10026. <field name="RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="java.lang.String"
  10027. transient="false" volatile="false"
  10028. static="true" final="true" visibility="public"
  10029. deprecated="not deprecated">
  10030. </field>
  10031. <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="int"
  10032. transient="false" volatile="false"
  10033. static="true" final="true" visibility="public"
  10034. deprecated="not deprecated">
  10035. </field>
  10036. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
  10037. transient="false" volatile="false"
  10038. static="true" final="true" visibility="public"
  10039. deprecated="not deprecated">
  10040. </field>
  10041. <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
  10042. transient="false" volatile="false"
  10043. static="true" final="true" visibility="public"
  10044. deprecated="not deprecated">
  10045. </field>
  10046. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
  10047. transient="false" volatile="false"
  10048. static="true" final="true" visibility="public"
  10049. deprecated="not deprecated">
  10050. </field>
  10051. <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
  10052. transient="false" volatile="false"
  10053. static="true" final="true" visibility="public"
  10054. deprecated="not deprecated">
  10055. </field>
  10056. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
  10057. transient="false" volatile="false"
  10058. static="true" final="true" visibility="public"
  10059. deprecated="not deprecated">
  10060. </field>
  10061. <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
  10062. transient="false" volatile="false"
  10063. static="true" final="true" visibility="public"
  10064. deprecated="not deprecated">
  10065. </field>
  10066. <field name="RECOVERY_ENABLED" type="java.lang.String"
  10067. transient="false" volatile="false"
  10068. static="true" final="true" visibility="public"
  10069. deprecated="not deprecated">
  10070. </field>
  10071. <field name="DEFAULT_RM_RECOVERY_ENABLED" type="boolean"
  10072. transient="false" volatile="false"
  10073. static="true" final="true" visibility="public"
  10074. deprecated="not deprecated">
  10075. </field>
  10076. <field name="YARN_FAIL_FAST" type="java.lang.String"
  10077. transient="false" volatile="false"
  10078. static="true" final="true" visibility="public"
  10079. deprecated="not deprecated">
  10080. </field>
  10081. <field name="DEFAULT_YARN_FAIL_FAST" type="boolean"
  10082. transient="false" volatile="false"
  10083. static="true" final="true" visibility="public"
  10084. deprecated="not deprecated">
  10085. </field>
  10086. <field name="RM_FAIL_FAST" type="java.lang.String"
  10087. transient="false" volatile="false"
  10088. static="true" final="true" visibility="public"
  10089. deprecated="not deprecated">
  10090. </field>
  10091. <field name="RM_WORK_PRESERVING_RECOVERY_ENABLED" type="java.lang.String"
  10092. transient="false" volatile="false"
  10093. static="true" final="true" visibility="public"
  10094. deprecated="not deprecated">
  10095. </field>
  10096. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED" type="boolean"
  10097. transient="false" volatile="false"
  10098. static="true" final="true" visibility="public"
  10099. deprecated="not deprecated">
  10100. </field>
  10101. <field name="RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="java.lang.String"
  10102. transient="false" volatile="false"
  10103. static="true" final="true" visibility="public"
  10104. deprecated="not deprecated">
  10105. </field>
  10106. <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="long"
  10107. transient="false" volatile="false"
  10108. static="true" final="true" visibility="public"
  10109. deprecated="not deprecated">
  10110. </field>
  10111. <field name="RM_ZK_PREFIX" type="java.lang.String"
  10112. transient="false" volatile="false"
  10113. static="true" final="true" visibility="public"
  10114. deprecated="not deprecated">
  10115. <doc>
  10116. <![CDATA[Zookeeper interaction configs]]>
  10117. </doc>
  10118. </field>
  10119. <field name="RM_ZK_ADDRESS" type="java.lang.String"
  10120. transient="false" volatile="false"
  10121. static="true" final="true" visibility="public"
  10122. deprecated="not deprecated">
  10123. </field>
  10124. <field name="RM_ZK_NUM_RETRIES" type="java.lang.String"
  10125. transient="false" volatile="false"
  10126. static="true" final="true" visibility="public"
  10127. deprecated="not deprecated">
  10128. </field>
  10129. <field name="DEFAULT_ZK_RM_NUM_RETRIES" type="int"
  10130. transient="false" volatile="false"
  10131. static="true" final="true" visibility="public"
  10132. deprecated="not deprecated">
  10133. </field>
  10134. <field name="RM_ZK_RETRY_INTERVAL_MS" type="java.lang.String"
  10135. transient="false" volatile="false"
  10136. static="true" final="true" visibility="public"
  10137. deprecated="not deprecated">
  10138. </field>
  10139. <field name="DEFAULT_RM_ZK_RETRY_INTERVAL_MS" type="long"
  10140. transient="false" volatile="false"
  10141. static="true" final="true" visibility="public"
  10142. deprecated="not deprecated">
  10143. </field>
  10144. <field name="RM_ZK_TIMEOUT_MS" type="java.lang.String"
  10145. transient="false" volatile="false"
  10146. static="true" final="true" visibility="public"
  10147. deprecated="not deprecated">
  10148. </field>
  10149. <field name="DEFAULT_RM_ZK_TIMEOUT_MS" type="int"
  10150. transient="false" volatile="false"
  10151. static="true" final="true" visibility="public"
  10152. deprecated="not deprecated">
  10153. </field>
  10154. <field name="RM_ZK_ACL" type="java.lang.String"
  10155. transient="false" volatile="false"
  10156. static="true" final="true" visibility="public"
  10157. deprecated="not deprecated">
  10158. </field>
  10159. <field name="DEFAULT_RM_ZK_ACL" type="java.lang.String"
  10160. transient="false" volatile="false"
  10161. static="true" final="true" visibility="public"
  10162. deprecated="not deprecated">
  10163. </field>
  10164. <field name="RM_ZK_AUTH" type="java.lang.String"
  10165. transient="false" volatile="false"
  10166. static="true" final="true" visibility="public"
  10167. deprecated="not deprecated">
  10168. </field>
  10169. <field name="ZK_STATE_STORE_PREFIX" type="java.lang.String"
  10170. transient="false" volatile="false"
  10171. static="true" final="true" visibility="public"
  10172. deprecated="not deprecated">
  10173. </field>
  10174. <field name="ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  10175. transient="false" volatile="false"
  10176. static="true" final="true" visibility="public"
  10177. deprecated="not deprecated">
  10178. <doc>
  10179. <![CDATA[Parent znode path under which ZKRMStateStore will create znodes]]>
  10180. </doc>
  10181. </field>
  10182. <field name="DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
  10183. transient="false" volatile="false"
  10184. static="true" final="true" visibility="public"
  10185. deprecated="not deprecated">
  10186. </field>
  10187. <field name="ZK_RM_STATE_STORE_ROOT_NODE_ACL" type="java.lang.String"
  10188. transient="false" volatile="false"
  10189. static="true" final="true" visibility="public"
  10190. deprecated="not deprecated">
  10191. <doc>
  10192. <![CDATA[Root node ACLs for fencing]]>
  10193. </doc>
  10194. </field>
  10195. <field name="RM_HA_PREFIX" type="java.lang.String"
  10196. transient="false" volatile="false"
  10197. static="true" final="true" visibility="public"
  10198. deprecated="not deprecated">
  10199. <doc>
  10200. <![CDATA[HA related configs]]>
  10201. </doc>
  10202. </field>
  10203. <field name="RM_HA_ENABLED" type="java.lang.String"
  10204. transient="false" volatile="false"
  10205. static="true" final="true" visibility="public"
  10206. deprecated="not deprecated">
  10207. </field>
  10208. <field name="DEFAULT_RM_HA_ENABLED" type="boolean"
  10209. transient="false" volatile="false"
  10210. static="true" final="true" visibility="public"
  10211. deprecated="not deprecated">
  10212. </field>
  10213. <field name="RM_HA_IDS" type="java.lang.String"
  10214. transient="false" volatile="false"
  10215. static="true" final="true" visibility="public"
  10216. deprecated="not deprecated">
  10217. </field>
  10218. <field name="RM_HA_ID" type="java.lang.String"
  10219. transient="false" volatile="false"
  10220. static="true" final="true" visibility="public"
  10221. deprecated="not deprecated">
  10222. </field>
  10223. <field name="FS_BASED_RM_CONF_STORE" type="java.lang.String"
  10224. transient="false" volatile="false"
  10225. static="true" final="true" visibility="public"
  10226. deprecated="not deprecated">
  10227. <doc>
  10228. <![CDATA[Store the related configuration files in File System]]>
  10229. </doc>
  10230. </field>
  10231. <field name="DEFAULT_FS_BASED_RM_CONF_STORE" type="java.lang.String"
  10232. transient="false" volatile="false"
  10233. static="true" final="true" visibility="public"
  10234. deprecated="not deprecated">
  10235. </field>
  10236. <field name="RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  10237. transient="false" volatile="false"
  10238. static="true" final="true" visibility="public"
  10239. deprecated="not deprecated">
  10240. </field>
  10241. <field name="DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
  10242. transient="false" volatile="false"
  10243. static="true" final="true" visibility="public"
  10244. deprecated="not deprecated">
  10245. </field>
  10246. <field name="YARN_AUTHORIZATION_PROVIDER" type="java.lang.String"
  10247. transient="false" volatile="false"
  10248. static="true" final="true" visibility="public"
  10249. deprecated="not deprecated">
  10250. </field>
  10251. <field name="AUTO_FAILOVER_PREFIX" type="java.lang.String"
  10252. transient="false" volatile="false"
  10253. static="true" final="true" visibility="public"
  10254. deprecated="not deprecated">
  10255. </field>
  10256. <field name="AUTO_FAILOVER_ENABLED" type="java.lang.String"
  10257. transient="false" volatile="false"
  10258. static="true" final="true" visibility="public"
  10259. deprecated="not deprecated">
  10260. </field>
  10261. <field name="DEFAULT_AUTO_FAILOVER_ENABLED" type="boolean"
  10262. transient="false" volatile="false"
  10263. static="true" final="true" visibility="public"
  10264. deprecated="not deprecated">
  10265. </field>
  10266. <field name="AUTO_FAILOVER_EMBEDDED" type="java.lang.String"
  10267. transient="false" volatile="false"
  10268. static="true" final="true" visibility="public"
  10269. deprecated="not deprecated">
  10270. </field>
  10271. <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
  10272. transient="false" volatile="false"
  10273. static="true" final="true" visibility="public"
  10274. deprecated="not deprecated">
  10275. </field>
  10276. <field name="AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  10277. transient="false" volatile="false"
  10278. static="true" final="true" visibility="public"
  10279. deprecated="not deprecated">
  10280. </field>
  10281. <field name="DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
  10282. transient="false" volatile="false"
  10283. static="true" final="true" visibility="public"
  10284. deprecated="not deprecated">
  10285. </field>
  10286. <field name="CLIENT_FAILOVER_PREFIX" type="java.lang.String"
  10287. transient="false" volatile="false"
  10288. static="true" final="true" visibility="public"
  10289. deprecated="not deprecated">
  10290. </field>
  10291. <field name="CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  10292. transient="false" volatile="false"
  10293. static="true" final="true" visibility="public"
  10294. deprecated="not deprecated">
  10295. </field>
  10296. <field name="DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
  10297. transient="false" volatile="false"
  10298. static="true" final="true" visibility="public"
  10299. deprecated="not deprecated">
  10300. </field>
  10301. <field name="CLIENT_FAILOVER_MAX_ATTEMPTS" type="java.lang.String"
  10302. transient="false" volatile="false"
  10303. static="true" final="true" visibility="public"
  10304. deprecated="not deprecated">
  10305. </field>
  10306. <field name="CLIENT_FAILOVER_SLEEPTIME_BASE_MS" type="java.lang.String"
  10307. transient="false" volatile="false"
  10308. static="true" final="true" visibility="public"
  10309. deprecated="not deprecated">
  10310. </field>
  10311. <field name="CLIENT_FAILOVER_SLEEPTIME_MAX_MS" type="java.lang.String"
  10312. transient="false" volatile="false"
  10313. static="true" final="true" visibility="public"
  10314. deprecated="not deprecated">
  10315. </field>
  10316. <field name="CLIENT_FAILOVER_RETRIES" type="java.lang.String"
  10317. transient="false" volatile="false"
  10318. static="true" final="true" visibility="public"
  10319. deprecated="not deprecated">
  10320. </field>
  10321. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES" type="int"
  10322. transient="false" volatile="false"
  10323. static="true" final="true" visibility="public"
  10324. deprecated="not deprecated">
  10325. </field>
  10326. <field name="CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="java.lang.String"
  10327. transient="false" volatile="false"
  10328. static="true" final="true" visibility="public"
  10329. deprecated="not deprecated">
  10330. </field>
  10331. <field name="DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="int"
  10332. transient="false" volatile="false"
  10333. static="true" final="true" visibility="public"
  10334. deprecated="not deprecated">
  10335. </field>
  10336. <field name="RM_STORE" type="java.lang.String"
  10337. transient="false" volatile="false"
  10338. static="true" final="true" visibility="public"
  10339. deprecated="not deprecated">
  10340. <doc>
  10341. <![CDATA[The class to use as the persistent store.]]>
  10342. </doc>
  10343. </field>
  10344. <field name="FS_RM_STATE_STORE_URI" type="java.lang.String"
  10345. transient="false" volatile="false"
  10346. static="true" final="true" visibility="public"
  10347. deprecated="not deprecated">
  10348. <doc>
  10349. <![CDATA[URI for FileSystemRMStateStore]]>
  10350. </doc>
  10351. </field>
  10352. <field name="FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  10353. transient="false" volatile="false"
  10354. static="true" final="true" visibility="public"
  10355. deprecated="not deprecated">
  10356. </field>
  10357. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  10358. transient="false" volatile="false"
  10359. static="true" final="true" visibility="public"
  10360. deprecated="not deprecated">
  10361. </field>
  10362. <field name="FS_RM_STATE_STORE_NUM_RETRIES" type="java.lang.String"
  10363. transient="false" volatile="false"
  10364. static="true" final="true" visibility="public"
  10365. deprecated="not deprecated">
  10366. </field>
  10367. <field name="DEFAULT_FS_RM_STATE_STORE_NUM_RETRIES" type="int"
  10368. transient="false" volatile="false"
  10369. static="true" final="true" visibility="public"
  10370. deprecated="not deprecated">
  10371. </field>
  10372. <field name="FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="java.lang.String"
  10373. transient="false" volatile="false"
  10374. static="true" final="true" visibility="public"
  10375. deprecated="not deprecated">
  10376. </field>
  10377. <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="long"
  10378. transient="false" volatile="false"
  10379. static="true" final="true" visibility="public"
  10380. deprecated="not deprecated">
  10381. </field>
  10382. <field name="RM_LEVELDB_STORE_PATH" type="java.lang.String"
  10383. transient="false" volatile="false"
  10384. static="true" final="true" visibility="public"
  10385. deprecated="not deprecated">
  10386. </field>
  10387. <field name="RM_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  10388. transient="false" volatile="false"
  10389. static="true" final="true" visibility="public"
  10390. deprecated="not deprecated">
  10391. <doc>
  10392. <![CDATA[The maximum number of completed applications RM keeps.]]>
  10393. </doc>
  10394. </field>
  10395. <field name="DEFAULT_RM_MAX_COMPLETED_APPLICATIONS" type="int"
  10396. transient="false" volatile="false"
  10397. static="true" final="true" visibility="public"
  10398. deprecated="not deprecated">
  10399. </field>
  10400. <field name="RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
  10401. transient="false" volatile="false"
  10402. static="true" final="true" visibility="public"
  10403. deprecated="not deprecated">
  10404. <doc>
  10405. <![CDATA[The maximum number of completed applications RM state store keeps, by
  10406. default equals to DEFAULT_RM_MAX_COMPLETED_APPLICATIONS]]>
  10407. </doc>
  10408. </field>
  10409. <field name="DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="int"
  10410. transient="false" volatile="false"
  10411. static="true" final="true" visibility="public"
  10412. deprecated="not deprecated">
  10413. </field>
  10414. <field name="DEFAULT_APPLICATION_NAME" type="java.lang.String"
  10415. transient="false" volatile="false"
  10416. static="true" final="true" visibility="public"
  10417. deprecated="not deprecated">
  10418. <doc>
  10419. <![CDATA[Default application name]]>
  10420. </doc>
  10421. </field>
  10422. <field name="DEFAULT_APPLICATION_TYPE" type="java.lang.String"
  10423. transient="false" volatile="false"
  10424. static="true" final="true" visibility="public"
  10425. deprecated="not deprecated">
  10426. <doc>
  10427. <![CDATA[Default application type]]>
  10428. </doc>
  10429. </field>
  10430. <field name="APPLICATION_TYPE_LENGTH" type="int"
  10431. transient="false" volatile="false"
  10432. static="true" final="true" visibility="public"
  10433. deprecated="not deprecated">
  10434. <doc>
  10435. <![CDATA[Default application type length]]>
  10436. </doc>
  10437. </field>
  10438. <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
  10439. transient="false" volatile="false"
  10440. static="true" final="true" visibility="public"
  10441. deprecated="not deprecated">
  10442. <doc>
  10443. <![CDATA[Default queue name]]>
  10444. </doc>
  10445. </field>
  10446. <field name="RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  10447. transient="false" volatile="false"
  10448. static="true" final="true" visibility="public"
  10449. deprecated="not deprecated">
  10450. <doc>
  10451. <![CDATA[Buckets (in minutes) for the number of apps running in each queue.]]>
  10452. </doc>
  10453. </field>
  10454. <field name="DEFAULT_RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
  10455. transient="false" volatile="false"
  10456. static="true" final="true" visibility="public"
  10457. deprecated="not deprecated">
  10458. <doc>
  10459. <![CDATA[Default sizes of the runtime metric buckets in minutes.]]>
  10460. </doc>
  10461. </field>
  10462. <field name="RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  10463. transient="false" volatile="false"
  10464. static="true" final="true" visibility="public"
  10465. deprecated="not deprecated">
  10466. </field>
  10467. <field name="DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  10468. transient="false" volatile="false"
  10469. static="true" final="true" visibility="public"
  10470. deprecated="not deprecated">
  10471. </field>
  10472. <field name="RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  10473. transient="false" volatile="false"
  10474. static="true" final="true" visibility="public"
  10475. deprecated="not deprecated">
  10476. </field>
  10477. <field name="DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  10478. transient="false" volatile="false"
  10479. static="true" final="true" visibility="public"
  10480. deprecated="not deprecated">
  10481. </field>
  10482. <field name="RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
  10483. transient="false" volatile="false"
  10484. static="true" final="true" visibility="public"
  10485. deprecated="not deprecated">
  10486. </field>
  10487. <field name="DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
  10488. transient="false" volatile="false"
  10489. static="true" final="true" visibility="public"
  10490. deprecated="not deprecated">
  10491. </field>
  10492. <field name="RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10493. transient="false" volatile="false"
  10494. static="true" final="true" visibility="public"
  10495. deprecated="not deprecated">
  10496. </field>
  10497. <field name="DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10498. transient="false" volatile="false"
  10499. static="true" final="true" visibility="public"
  10500. deprecated="not deprecated">
  10501. </field>
  10502. <field name="RM_PROXY_USER_PREFIX" type="java.lang.String"
  10503. transient="false" volatile="false"
  10504. static="true" final="true" visibility="public"
  10505. deprecated="not deprecated">
  10506. <doc>
  10507. <![CDATA[RM proxy users' prefix]]>
  10508. </doc>
  10509. </field>
  10510. <field name="NM_PREFIX" type="java.lang.String"
  10511. transient="false" volatile="false"
  10512. static="true" final="true" visibility="public"
  10513. deprecated="not deprecated">
  10514. <doc>
  10515. <![CDATA[Prefix for all node manager configs.]]>
  10516. </doc>
  10517. </field>
  10518. <field name="NM_ADMIN_USER_ENV" type="java.lang.String"
  10519. transient="false" volatile="false"
  10520. static="true" final="true" visibility="public"
  10521. deprecated="not deprecated">
  10522. <doc>
  10523. <![CDATA[Environment variables that will be sent to containers.]]>
  10524. </doc>
  10525. </field>
  10526. <field name="DEFAULT_NM_ADMIN_USER_ENV" type="java.lang.String"
  10527. transient="false" volatile="false"
  10528. static="true" final="true" visibility="public"
  10529. deprecated="not deprecated">
  10530. </field>
  10531. <field name="NM_ENV_WHITELIST" type="java.lang.String"
  10532. transient="false" volatile="false"
  10533. static="true" final="true" visibility="public"
  10534. deprecated="not deprecated">
  10535. <doc>
  10536. <![CDATA[Environment variables that containers may override rather than use NodeManager's default.]]>
  10537. </doc>
  10538. </field>
  10539. <field name="DEFAULT_NM_ENV_WHITELIST" type="java.lang.String"
  10540. transient="false" volatile="false"
  10541. static="true" final="true" visibility="public"
  10542. deprecated="not deprecated">
  10543. </field>
  10544. <field name="NM_ADDRESS" type="java.lang.String"
  10545. transient="false" volatile="false"
  10546. static="true" final="true" visibility="public"
  10547. deprecated="not deprecated">
  10548. <doc>
  10549. <![CDATA[address of node manager IPC.]]>
  10550. </doc>
  10551. </field>
  10552. <field name="DEFAULT_NM_PORT" type="int"
  10553. transient="false" volatile="false"
  10554. static="true" final="true" visibility="public"
  10555. deprecated="not deprecated">
  10556. </field>
  10557. <field name="DEFAULT_NM_ADDRESS" type="java.lang.String"
  10558. transient="false" volatile="false"
  10559. static="true" final="true" visibility="public"
  10560. deprecated="not deprecated">
  10561. </field>
  10562. <field name="NM_BIND_HOST" type="java.lang.String"
  10563. transient="false" volatile="false"
  10564. static="true" final="true" visibility="public"
  10565. deprecated="not deprecated">
  10566. <doc>
  10567. <![CDATA[The actual bind address or the NM.]]>
  10568. </doc>
  10569. </field>
  10570. <field name="NM_CONTAINER_EXECUTOR" type="java.lang.String"
  10571. transient="false" volatile="false"
  10572. static="true" final="true" visibility="public"
  10573. deprecated="not deprecated">
  10574. <doc>
  10575. <![CDATA[who will execute(launch) the containers.]]>
  10576. </doc>
  10577. </field>
  10578. <field name="NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="java.lang.String"
  10579. transient="false" volatile="false"
  10580. static="true" final="true" visibility="public"
  10581. deprecated="not deprecated">
  10582. <doc>
  10583. <![CDATA[Adjustment to make to the container os scheduling priority.
  10584. The valid values for this could vary depending on the platform.
  10585. On Linux, higher values mean run the containers at a less
  10586. favorable priority than the NM.
  10587. The value specified is an int.]]>
  10588. </doc>
  10589. </field>
  10590. <field name="DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="int"
  10591. transient="false" volatile="false"
  10592. static="true" final="true" visibility="public"
  10593. deprecated="not deprecated">
  10594. </field>
  10595. <field name="NM_CONTAINER_MGR_THREAD_COUNT" type="java.lang.String"
  10596. transient="false" volatile="false"
  10597. static="true" final="true" visibility="public"
  10598. deprecated="not deprecated">
  10599. <doc>
  10600. <![CDATA[Number of threads container manager uses.]]>
  10601. </doc>
  10602. </field>
  10603. <field name="DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT" type="int"
  10604. transient="false" volatile="false"
  10605. static="true" final="true" visibility="public"
  10606. deprecated="not deprecated">
  10607. </field>
  10608. <field name="NM_DELETE_THREAD_COUNT" type="java.lang.String"
  10609. transient="false" volatile="false"
  10610. static="true" final="true" visibility="public"
  10611. deprecated="not deprecated">
  10612. <doc>
  10613. <![CDATA[Number of threads used in cleanup.]]>
  10614. </doc>
  10615. </field>
  10616. <field name="DEFAULT_NM_DELETE_THREAD_COUNT" type="int"
  10617. transient="false" volatile="false"
  10618. static="true" final="true" visibility="public"
  10619. deprecated="not deprecated">
  10620. </field>
  10621. <field name="NM_KEYTAB" type="java.lang.String"
  10622. transient="false" volatile="false"
  10623. static="true" final="true" visibility="public"
  10624. deprecated="not deprecated">
  10625. <doc>
  10626. <![CDATA[Keytab for NM.]]>
  10627. </doc>
  10628. </field>
  10629. <field name="NM_LOCAL_DIRS" type="java.lang.String"
  10630. transient="false" volatile="false"
  10631. static="true" final="true" visibility="public"
  10632. deprecated="not deprecated">
  10633. <doc>
  10634. <![CDATA[List of directories to store localized files in.]]>
  10635. </doc>
  10636. </field>
  10637. <field name="DEFAULT_NM_LOCAL_DIRS" type="java.lang.String"
  10638. transient="false" volatile="false"
  10639. static="true" final="true" visibility="public"
  10640. deprecated="not deprecated">
  10641. </field>
  10642. <field name="NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="java.lang.String"
  10643. transient="false" volatile="false"
  10644. static="true" final="true" visibility="public"
  10645. deprecated="not deprecated">
  10646. <doc>
  10647. <![CDATA[Number of files in each localized directories
  10648. Avoid tuning this too low.]]>
  10649. </doc>
  10650. </field>
  10651. <field name="DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="int"
  10652. transient="false" volatile="false"
  10653. static="true" final="true" visibility="public"
  10654. deprecated="not deprecated">
  10655. </field>
  10656. <field name="NM_LOCALIZER_ADDRESS" type="java.lang.String"
  10657. transient="false" volatile="false"
  10658. static="true" final="true" visibility="public"
  10659. deprecated="not deprecated">
  10660. <doc>
  10661. <![CDATA[Address where the localizer IPC is.]]>
  10662. </doc>
  10663. </field>
  10664. <field name="DEFAULT_NM_LOCALIZER_PORT" type="int"
  10665. transient="false" volatile="false"
  10666. static="true" final="true" visibility="public"
  10667. deprecated="not deprecated">
  10668. </field>
  10669. <field name="DEFAULT_NM_LOCALIZER_ADDRESS" type="java.lang.String"
  10670. transient="false" volatile="false"
  10671. static="true" final="true" visibility="public"
  10672. deprecated="not deprecated">
  10673. </field>
  10674. <field name="NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="java.lang.String"
  10675. transient="false" volatile="false"
  10676. static="true" final="true" visibility="public"
  10677. deprecated="not deprecated">
  10678. <doc>
  10679. <![CDATA[Interval in between cache cleanups.]]>
  10680. </doc>
  10681. </field>
  10682. <field name="DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="long"
  10683. transient="false" volatile="false"
  10684. static="true" final="true" visibility="public"
  10685. deprecated="not deprecated">
  10686. </field>
  10687. <field name="NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="java.lang.String"
  10688. transient="false" volatile="false"
  10689. static="true" final="true" visibility="public"
  10690. deprecated="not deprecated">
  10691. <doc>
  10692. <![CDATA[Target size of localizer cache in MB, per nodemanager. It is a target
  10693. retention size that only includes resources with PUBLIC and PRIVATE
  10694. visibility and excludes resources with APPLICATION visibility]]>
  10695. </doc>
  10696. </field>
  10697. <field name="DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="long"
  10698. transient="false" volatile="false"
  10699. static="true" final="true" visibility="public"
  10700. deprecated="not deprecated">
  10701. </field>
  10702. <field name="NM_LOCALIZER_CLIENT_THREAD_COUNT" type="java.lang.String"
  10703. transient="false" volatile="false"
  10704. static="true" final="true" visibility="public"
  10705. deprecated="not deprecated">
  10706. <doc>
  10707. <![CDATA[Number of threads to handle localization requests.]]>
  10708. </doc>
  10709. </field>
  10710. <field name="DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT" type="int"
  10711. transient="false" volatile="false"
  10712. static="true" final="true" visibility="public"
  10713. deprecated="not deprecated">
  10714. </field>
  10715. <field name="NM_LOCALIZER_FETCH_THREAD_COUNT" type="java.lang.String"
  10716. transient="false" volatile="false"
  10717. static="true" final="true" visibility="public"
  10718. deprecated="not deprecated">
  10719. <doc>
  10720. <![CDATA[Number of threads to use for localization fetching.]]>
  10721. </doc>
  10722. </field>
  10723. <field name="DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT" type="int"
  10724. transient="false" volatile="false"
  10725. static="true" final="true" visibility="public"
  10726. deprecated="not deprecated">
  10727. </field>
  10728. <field name="NM_LOG_DIRS" type="java.lang.String"
  10729. transient="false" volatile="false"
  10730. static="true" final="true" visibility="public"
  10731. deprecated="not deprecated">
  10732. <doc>
  10733. <![CDATA[Where to store container logs.]]>
  10734. </doc>
  10735. </field>
  10736. <field name="DEFAULT_NM_LOG_DIRS" type="java.lang.String"
  10737. transient="false" volatile="false"
  10738. static="true" final="true" visibility="public"
  10739. deprecated="not deprecated">
  10740. </field>
  10741. <field name="NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10742. transient="false" volatile="false"
  10743. static="true" final="true" visibility="public"
  10744. deprecated="not deprecated">
  10745. </field>
  10746. <field name="DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
  10747. transient="false" volatile="false"
  10748. static="true" final="true" visibility="public"
  10749. deprecated="not deprecated">
  10750. </field>
  10751. <field name="RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="java.lang.String"
  10752. transient="false" volatile="false"
  10753. static="true" final="true" visibility="public"
  10754. deprecated="not deprecated">
  10755. <doc>
  10756. <![CDATA[Interval at which the delayed token removal thread runs]]>
  10757. </doc>
  10758. </field>
  10759. <field name="DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="long"
  10760. transient="false" volatile="false"
  10761. static="true" final="true" visibility="public"
  10762. deprecated="not deprecated">
  10763. </field>
  10764. <field name="RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="java.lang.String"
  10765. transient="false" volatile="false"
  10766. static="true" final="true" visibility="public"
  10767. deprecated="not deprecated">
  10768. <doc>
  10769. <![CDATA[Delegation Token renewer thread count]]>
  10770. </doc>
  10771. </field>
  10772. <field name="DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="int"
  10773. transient="false" volatile="false"
  10774. static="true" final="true" visibility="public"
  10775. deprecated="not deprecated">
  10776. </field>
  10777. <field name="RM_PROXY_USER_PRIVILEGES_ENABLED" type="java.lang.String"
  10778. transient="false" volatile="false"
  10779. static="true" final="true" visibility="public"
  10780. deprecated="not deprecated">
  10781. </field>
  10782. <field name="DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED" type="boolean"
  10783. transient="false" volatile="false"
  10784. static="true" final="false" visibility="public"
  10785. deprecated="not deprecated">
  10786. </field>
  10787. <field name="LOG_AGGREGATION_ENABLED" type="java.lang.String"
  10788. transient="false" volatile="false"
  10789. static="true" final="true" visibility="public"
  10790. deprecated="not deprecated">
  10791. <doc>
  10792. <![CDATA[Whether to enable log aggregation]]>
  10793. </doc>
  10794. </field>
  10795. <field name="DEFAULT_LOG_AGGREGATION_ENABLED" type="boolean"
  10796. transient="false" volatile="false"
  10797. static="true" final="true" visibility="public"
  10798. deprecated="not deprecated">
  10799. </field>
  10800. <field name="LOG_AGGREGATION_RETAIN_SECONDS" type="java.lang.String"
  10801. transient="false" volatile="false"
  10802. static="true" final="true" visibility="public"
  10803. deprecated="not deprecated">
  10804. <doc>
  10805. <![CDATA[How long to wait before deleting aggregated logs, -1 disables.
  10806. Be careful set this too small and you will spam the name node.]]>
  10807. </doc>
  10808. </field>
  10809. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS" type="long"
  10810. transient="false" volatile="false"
  10811. static="true" final="true" visibility="public"
  10812. deprecated="not deprecated">
  10813. </field>
  10814. <field name="LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="java.lang.String"
  10815. transient="false" volatile="false"
  10816. static="true" final="true" visibility="public"
  10817. deprecated="not deprecated">
  10818. <doc>
  10819. <![CDATA[How long to wait between aggregated log retention checks. If set to
  10820. a value {@literal <=} 0 then the value is computed as one-tenth of the
  10821. log retention setting. Be careful set this too small and you will spam
  10822. the name node.]]>
  10823. </doc>
  10824. </field>
  10825. <field name="DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="long"
  10826. transient="false" volatile="false"
  10827. static="true" final="true" visibility="public"
  10828. deprecated="not deprecated">
  10829. </field>
  10830. <field name="NM_LOG_RETAIN_SECONDS" type="java.lang.String"
  10831. transient="false" volatile="false"
  10832. static="true" final="true" visibility="public"
  10833. deprecated="not deprecated">
  10834. <doc>
  10835. <![CDATA[Number of seconds to retain logs on the NodeManager. Only applicable if Log
  10836. aggregation is disabled]]>
  10837. </doc>
  10838. </field>
  10839. <field name="DEFAULT_NM_LOG_RETAIN_SECONDS" type="long"
  10840. transient="false" volatile="false"
  10841. static="true" final="true" visibility="public"
  10842. deprecated="not deprecated">
  10843. </field>
  10844. <field name="NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="java.lang.String"
  10845. transient="false" volatile="false"
  10846. static="true" final="true" visibility="public"
  10847. deprecated="not deprecated">
  10848. <doc>
  10849. <![CDATA[Define how often NMs wake up and upload log files]]>
  10850. </doc>
  10851. </field>
  10852. <field name="DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="long"
  10853. transient="false" volatile="false"
  10854. static="true" final="true" visibility="public"
  10855. deprecated="not deprecated">
  10856. </field>
  10857. <field name="NM_LOG_DELETION_THREADS_COUNT" type="java.lang.String"
  10858. transient="false" volatile="false"
  10859. static="true" final="true" visibility="public"
  10860. deprecated="not deprecated">
  10861. <doc>
  10862. <![CDATA[Number of threads used in log cleanup. Only applicable if Log aggregation
  10863. is disabled]]>
  10864. </doc>
  10865. </field>
  10866. <field name="DEFAULT_NM_LOG_DELETE_THREAD_COUNT" type="int"
  10867. transient="false" volatile="false"
  10868. static="true" final="true" visibility="public"
  10869. deprecated="not deprecated">
  10870. </field>
  10871. <field name="NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  10872. transient="false" volatile="false"
  10873. static="true" final="true" visibility="public"
  10874. deprecated="not deprecated">
  10875. <doc>
  10876. <![CDATA[Where to aggregate logs to.]]>
  10877. </doc>
  10878. </field>
  10879. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
  10880. transient="false" volatile="false"
  10881. static="true" final="true" visibility="public"
  10882. deprecated="not deprecated">
  10883. </field>
  10884. <field name="NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  10885. transient="false" volatile="false"
  10886. static="true" final="true" visibility="public"
  10887. deprecated="not deprecated">
  10888. <doc>
  10889. <![CDATA[The remote log dir will be created at
  10890. NM_REMOTE_APP_LOG_DIR/${user}/NM_REMOTE_APP_LOG_DIR_SUFFIX/${appId}]]>
  10891. </doc>
  10892. </field>
  10893. <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
  10894. transient="false" volatile="false"
  10895. static="true" final="true" visibility="public"
  10896. deprecated="not deprecated">
  10897. </field>
  10898. <field name="YARN_LOG_SERVER_URL" type="java.lang.String"
  10899. transient="false" volatile="false"
  10900. static="true" final="true" visibility="public"
  10901. deprecated="not deprecated">
  10902. </field>
  10903. <field name="YARN_TRACKING_URL_GENERATOR" type="java.lang.String"
  10904. transient="false" volatile="false"
  10905. static="true" final="true" visibility="public"
  10906. deprecated="not deprecated">
  10907. </field>
  10908. <field name="NM_PMEM_MB" type="java.lang.String"
  10909. transient="false" volatile="false"
  10910. static="true" final="true" visibility="public"
  10911. deprecated="not deprecated">
  10912. <doc>
  10913. <![CDATA[Amount of memory in GB that can be allocated for containers.]]>
  10914. </doc>
  10915. </field>
  10916. <field name="DEFAULT_NM_PMEM_MB" type="int"
  10917. transient="false" volatile="false"
  10918. static="true" final="true" visibility="public"
  10919. deprecated="not deprecated">
  10920. </field>
  10921. <field name="NM_PMEM_CHECK_ENABLED" type="java.lang.String"
  10922. transient="false" volatile="false"
  10923. static="true" final="true" visibility="public"
  10924. deprecated="not deprecated">
  10925. <doc>
  10926. <![CDATA[Specifies whether physical memory check is enabled.]]>
  10927. </doc>
  10928. </field>
  10929. <field name="DEFAULT_NM_PMEM_CHECK_ENABLED" type="boolean"
  10930. transient="false" volatile="false"
  10931. static="true" final="true" visibility="public"
  10932. deprecated="not deprecated">
  10933. </field>
  10934. <field name="NM_VMEM_CHECK_ENABLED" type="java.lang.String"
  10935. transient="false" volatile="false"
  10936. static="true" final="true" visibility="public"
  10937. deprecated="not deprecated">
  10938. <doc>
  10939. <![CDATA[Specifies whether physical memory check is enabled.]]>
  10940. </doc>
  10941. </field>
  10942. <field name="DEFAULT_NM_VMEM_CHECK_ENABLED" type="boolean"
  10943. transient="false" volatile="false"
  10944. static="true" final="true" visibility="public"
  10945. deprecated="not deprecated">
  10946. </field>
  10947. <field name="NM_VMEM_PMEM_RATIO" type="java.lang.String"
  10948. transient="false" volatile="false"
  10949. static="true" final="true" visibility="public"
  10950. deprecated="not deprecated">
  10951. <doc>
  10952. <![CDATA[Conversion ratio for physical memory to virtual memory.]]>
  10953. </doc>
  10954. </field>
  10955. <field name="DEFAULT_NM_VMEM_PMEM_RATIO" type="float"
  10956. transient="false" volatile="false"
  10957. static="true" final="true" visibility="public"
  10958. deprecated="not deprecated">
  10959. </field>
  10960. <field name="NM_VCORES" type="java.lang.String"
  10961. transient="false" volatile="false"
  10962. static="true" final="true" visibility="public"
  10963. deprecated="not deprecated">
  10964. <doc>
  10965. <![CDATA[Number of Virtual CPU Cores which can be allocated for containers.]]>
  10966. </doc>
  10967. </field>
  10968. <field name="DEFAULT_NM_VCORES" type="int"
  10969. transient="false" volatile="false"
  10970. static="true" final="true" visibility="public"
  10971. deprecated="not deprecated">
  10972. </field>
  10973. <field name="NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="java.lang.String"
  10974. transient="false" volatile="false"
  10975. static="true" final="true" visibility="public"
  10976. deprecated="not deprecated">
  10977. <doc>
  10978. <![CDATA[Percentage of overall CPU which can be allocated for containers.]]>
  10979. </doc>
  10980. </field>
  10981. <field name="DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="int"
  10982. transient="false" volatile="false"
  10983. static="true" final="true" visibility="public"
  10984. deprecated="not deprecated">
  10985. </field>
  10986. <field name="NM_WEBAPP_ADDRESS" type="java.lang.String"
  10987. transient="false" volatile="false"
  10988. static="true" final="true" visibility="public"
  10989. deprecated="not deprecated">
  10990. <doc>
  10991. <![CDATA[NM Webapp address.]]>
  10992. </doc>
  10993. </field>
  10994. <field name="DEFAULT_NM_WEBAPP_PORT" type="int"
  10995. transient="false" volatile="false"
  10996. static="true" final="true" visibility="public"
  10997. deprecated="not deprecated">
  10998. </field>
  10999. <field name="DEFAULT_NM_WEBAPP_ADDRESS" type="java.lang.String"
  11000. transient="false" volatile="false"
  11001. static="true" final="true" visibility="public"
  11002. deprecated="not deprecated">
  11003. </field>
  11004. <field name="NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  11005. transient="false" volatile="false"
  11006. static="true" final="true" visibility="public"
  11007. deprecated="not deprecated">
  11008. <doc>
  11009. <![CDATA[NM Webapp https address.]]>
  11010. </doc>
  11011. </field>
  11012. <field name="DEFAULT_NM_WEBAPP_HTTPS_PORT" type="int"
  11013. transient="false" volatile="false"
  11014. static="true" final="true" visibility="public"
  11015. deprecated="not deprecated">
  11016. </field>
  11017. <field name="DEFAULT_NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  11018. transient="false" volatile="false"
  11019. static="true" final="true" visibility="public"
  11020. deprecated="not deprecated">
  11021. </field>
  11022. <field name="NM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
  11023. transient="false" volatile="false"
  11024. static="true" final="true" visibility="public"
  11025. deprecated="not deprecated">
  11026. <doc>
  11027. <![CDATA[Enable/disable CORS filter.]]>
  11028. </doc>
  11029. </field>
  11030. <field name="DEFAULT_NM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
  11031. transient="false" volatile="false"
  11032. static="true" final="true" visibility="public"
  11033. deprecated="not deprecated">
  11034. </field>
  11035. <field name="NM_CONTAINER_MON_INTERVAL_MS" type="java.lang.String"
  11036. transient="false" volatile="false"
  11037. static="true" final="true" visibility="public"
  11038. deprecated="not deprecated">
  11039. <doc>
  11040. <![CDATA[How often to monitor containers.]]>
  11041. </doc>
  11042. </field>
  11043. <field name="DEFAULT_NM_CONTAINER_MON_INTERVAL_MS" type="int"
  11044. transient="false" volatile="false"
  11045. static="true" final="true" visibility="public"
  11046. deprecated="not deprecated">
  11047. </field>
  11048. <field name="NM_CONTAINER_MON_RESOURCE_CALCULATOR" type="java.lang.String"
  11049. transient="false" volatile="false"
  11050. static="true" final="true" visibility="public"
  11051. deprecated="not deprecated">
  11052. <doc>
  11053. <![CDATA[Class that calculates containers current resource utilization.]]>
  11054. </doc>
  11055. </field>
  11056. <field name="NM_CONTAINER_MON_PROCESS_TREE" type="java.lang.String"
  11057. transient="false" volatile="false"
  11058. static="true" final="true" visibility="public"
  11059. deprecated="not deprecated">
  11060. <doc>
  11061. <![CDATA[Class that calculates process tree resource utilization.]]>
  11062. </doc>
  11063. </field>
  11064. <field name="PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="java.lang.String"
  11065. transient="false" volatile="false"
  11066. static="true" final="true" visibility="public"
  11067. deprecated="not deprecated">
  11068. </field>
  11069. <field name="DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="boolean"
  11070. transient="false" volatile="false"
  11071. static="true" final="true" visibility="public"
  11072. deprecated="not deprecated">
  11073. </field>
  11074. <field name="NM_CONTAINER_METRICS_ENABLE" type="java.lang.String"
  11075. transient="false" volatile="false"
  11076. static="true" final="true" visibility="public"
  11077. deprecated="not deprecated">
  11078. <doc>
  11079. <![CDATA[Enable/disable container metrics.]]>
  11080. </doc>
  11081. </field>
  11082. <field name="DEFAULT_NM_CONTAINER_METRICS_ENABLE" type="boolean"
  11083. transient="false" volatile="false"
  11084. static="true" final="true" visibility="public"
  11085. deprecated="not deprecated">
  11086. </field>
  11087. <field name="NM_CONTAINER_METRICS_PERIOD_MS" type="java.lang.String"
  11088. transient="false" volatile="false"
  11089. static="true" final="true" visibility="public"
  11090. deprecated="not deprecated">
  11091. <doc>
  11092. <![CDATA[Container metrics flush period. -1 for flush on completion.]]>
  11093. </doc>
  11094. </field>
  11095. <field name="DEFAULT_NM_CONTAINER_METRICS_PERIOD_MS" type="int"
  11096. transient="false" volatile="false"
  11097. static="true" final="true" visibility="public"
  11098. deprecated="not deprecated">
  11099. </field>
  11100. <field name="NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="java.lang.String"
  11101. transient="false" volatile="false"
  11102. static="true" final="true" visibility="public"
  11103. deprecated="not deprecated">
  11104. <doc>
  11105. <![CDATA[The delay time ms to unregister container metrics after completion.]]>
  11106. </doc>
  11107. </field>
  11108. <field name="DEFAULT_NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="int"
  11109. transient="false" volatile="false"
  11110. static="true" final="true" visibility="public"
  11111. deprecated="not deprecated">
  11112. </field>
  11113. <field name="NM_DISK_HEALTH_CHECK_ENABLE" type="java.lang.String"
  11114. transient="false" volatile="false"
  11115. static="true" final="true" visibility="public"
  11116. deprecated="not deprecated">
  11117. <doc>
  11118. <![CDATA[Enable/Disable disks' health checker. Default is true. An expert level
  11119. configuration property.]]>
  11120. </doc>
  11121. </field>
  11122. <field name="NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  11123. transient="false" volatile="false"
  11124. static="true" final="true" visibility="public"
  11125. deprecated="not deprecated">
  11126. <doc>
  11127. <![CDATA[Frequency of running disks' health checker.]]>
  11128. </doc>
  11129. </field>
  11130. <field name="DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="long"
  11131. transient="false" volatile="false"
  11132. static="true" final="true" visibility="public"
  11133. deprecated="not deprecated">
  11134. <doc>
  11135. <![CDATA[By default, disks' health is checked every 2 minutes.]]>
  11136. </doc>
  11137. </field>
  11138. <field name="NM_MIN_HEALTHY_DISKS_FRACTION" type="java.lang.String"
  11139. transient="false" volatile="false"
  11140. static="true" final="true" visibility="public"
  11141. deprecated="not deprecated">
  11142. <doc>
  11143. <![CDATA[The minimum fraction of number of disks to be healthy for the nodemanager
  11144. to launch new containers. This applies to nm-local-dirs and nm-log-dirs.]]>
  11145. </doc>
  11146. </field>
  11147. <field name="DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION" type="float"
  11148. transient="false" volatile="false"
  11149. static="true" final="true" visibility="public"
  11150. deprecated="not deprecated">
  11151. <doc>
  11152. <![CDATA[By default, at least 25% of disks are to be healthy to say that the node is
  11153. healthy in terms of disks.]]>
  11154. </doc>
  11155. </field>
  11156. <field name="NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
  11157. transient="false" volatile="false"
  11158. static="true" final="true" visibility="public"
  11159. deprecated="not deprecated">
  11160. <doc>
  11161. <![CDATA[The maximum percentage of disk space that can be used after which a disk is
  11162. marked as offline. Values can range from 0.0 to 100.0. If the value is
  11163. greater than or equal to 100, NM will check for full disk. This applies to
  11164. nm-local-dirs and nm-log-dirs.]]>
  11165. </doc>
  11166. </field>
  11167. <field name="DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="float"
  11168. transient="false" volatile="false"
  11169. static="true" final="true" visibility="public"
  11170. deprecated="not deprecated">
  11171. <doc>
  11172. <![CDATA[By default, 90% of the disk can be used before it is marked as offline.]]>
  11173. </doc>
  11174. </field>
  11175. <field name="NM_MIN_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
  11176. transient="false" volatile="false"
  11177. static="true" final="true" visibility="public"
  11178. deprecated="not deprecated">
  11179. <doc>
  11180. <![CDATA[The minimum space that must be available on a local dir for it to be used.
  11181. This applies to nm-local-dirs and nm-log-dirs.]]>
  11182. </doc>
  11183. </field>
  11184. <field name="DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB" type="long"
  11185. transient="false" volatile="false"
  11186. static="true" final="true" visibility="public"
  11187. deprecated="not deprecated">
  11188. <doc>
  11189. <![CDATA[By default, all of the disk can be used before it is marked as offline.]]>
  11190. </doc>
  11191. </field>
  11192. <field name="NM_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
  11193. transient="false" volatile="false"
  11194. static="true" final="true" visibility="public"
  11195. deprecated="not deprecated">
  11196. <doc>
  11197. <![CDATA[Frequency of running node health script.]]>
  11198. </doc>
  11199. </field>
  11200. <field name="DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS" type="long"
  11201. transient="false" volatile="false"
  11202. static="true" final="true" visibility="public"
  11203. deprecated="not deprecated">
  11204. </field>
  11205. <field name="NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="java.lang.String"
  11206. transient="false" volatile="false"
  11207. static="true" final="true" visibility="public"
  11208. deprecated="not deprecated">
  11209. <doc>
  11210. <![CDATA[Health check script time out period.]]>
  11211. </doc>
  11212. </field>
  11213. <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="long"
  11214. transient="false" volatile="false"
  11215. static="true" final="true" visibility="public"
  11216. deprecated="not deprecated">
  11217. </field>
  11218. <field name="NM_HEALTH_CHECK_SCRIPT_PATH" type="java.lang.String"
  11219. transient="false" volatile="false"
  11220. static="true" final="true" visibility="public"
  11221. deprecated="not deprecated">
  11222. <doc>
  11223. <![CDATA[The health check script to run.]]>
  11224. </doc>
  11225. </field>
  11226. <field name="NM_HEALTH_CHECK_SCRIPT_OPTS" type="java.lang.String"
  11227. transient="false" volatile="false"
  11228. static="true" final="true" visibility="public"
  11229. deprecated="not deprecated">
  11230. <doc>
  11231. <![CDATA[The arguments to pass to the health check script.]]>
  11232. </doc>
  11233. </field>
  11234. <field name="NM_DOCKER_CONTAINER_EXECUTOR_IMAGE_NAME" type="java.lang.String"
  11235. transient="false" volatile="false"
  11236. static="true" final="true" visibility="public"
  11237. deprecated="not deprecated">
  11238. <doc>
  11239. <![CDATA[The Docker image name(For DockerContainerExecutor).]]>
  11240. </doc>
  11241. </field>
  11242. <field name="NM_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  11243. transient="false" volatile="false"
  11244. static="true" final="true" visibility="public"
  11245. deprecated="not deprecated">
  11246. <doc>
  11247. <![CDATA[The name of the docker executor (For DockerContainerExecutor).]]>
  11248. </doc>
  11249. </field>
  11250. <field name="NM_DEFAULT_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
  11251. transient="false" volatile="false"
  11252. static="true" final="true" visibility="public"
  11253. deprecated="not deprecated">
  11254. <doc>
  11255. <![CDATA[The default docker executor (For DockerContainerExecutor).]]>
  11256. </doc>
  11257. </field>
  11258. <field name="NM_LINUX_CONTAINER_EXECUTOR_PATH" type="java.lang.String"
  11259. transient="false" volatile="false"
  11260. static="true" final="true" visibility="public"
  11261. deprecated="not deprecated">
  11262. <doc>
  11263. <![CDATA[The path to the Linux container executor.]]>
  11264. </doc>
  11265. </field>
  11266. <field name="NM_LINUX_CONTAINER_GROUP" type="java.lang.String"
  11267. transient="false" volatile="false"
  11268. static="true" final="true" visibility="public"
  11269. deprecated="not deprecated">
  11270. <doc>
  11271. <![CDATA[The UNIX group that the linux-container-executor should run as.
  11272. This is intended to be set as part of container-executor.cfg.]]>
  11273. </doc>
  11274. </field>
  11275. <field name="NM_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
  11276. transient="false" volatile="false"
  11277. static="true" final="true" visibility="public"
  11278. deprecated="not deprecated">
  11279. <doc>
  11280. <![CDATA[If linux-container-executor should limit itself to one user
  11281. when running in non-secure mode.]]>
  11282. </doc>
  11283. </field>
  11284. <field name="DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS" type="boolean"
  11285. transient="false" volatile="false"
  11286. static="true" final="true" visibility="public"
  11287. deprecated="not deprecated">
  11288. </field>
  11289. <field name="NM_NONSECURE_MODE_LOCAL_USER_KEY" type="java.lang.String"
  11290. transient="false" volatile="false"
  11291. static="true" final="true" visibility="public"
  11292. deprecated="not deprecated">
  11293. <doc>
  11294. <![CDATA[The UNIX user that containers will run as when Linux-container-executor
  11295. is used in nonsecure mode (a use case for this is using cgroups).]]>
  11296. </doc>
  11297. </field>
  11298. <field name="DEFAULT_NM_NONSECURE_MODE_LOCAL_USER" type="java.lang.String"
  11299. transient="false" volatile="false"
  11300. static="true" final="true" visibility="public"
  11301. deprecated="not deprecated">
  11302. </field>
  11303. <field name="NM_NONSECURE_MODE_USER_PATTERN_KEY" type="java.lang.String"
  11304. transient="false" volatile="false"
  11305. static="true" final="true" visibility="public"
  11306. deprecated="not deprecated">
  11307. <doc>
  11308. <![CDATA[The allowed pattern for UNIX user names enforced by
  11309. Linux-container-executor when used in nonsecure mode (use case for this
  11310. is using cgroups). The default value is taken from /usr/sbin/adduser]]>
  11311. </doc>
  11312. </field>
  11313. <field name="DEFAULT_NM_NONSECURE_MODE_USER_PATTERN" type="java.lang.String"
  11314. transient="false" volatile="false"
  11315. static="true" final="true" visibility="public"
  11316. deprecated="not deprecated">
  11317. </field>
  11318. <field name="NM_LINUX_CONTAINER_RESOURCES_HANDLER" type="java.lang.String"
  11319. transient="false" volatile="false"
  11320. static="true" final="true" visibility="public"
  11321. deprecated="not deprecated">
  11322. <doc>
  11323. <![CDATA[The type of resource enforcement to use with the
  11324. linux container executor.]]>
  11325. </doc>
  11326. </field>
  11327. <field name="NM_LINUX_CONTAINER_CGROUPS_HIERARCHY" type="java.lang.String"
  11328. transient="false" volatile="false"
  11329. static="true" final="true" visibility="public"
  11330. deprecated="not deprecated">
  11331. <doc>
  11332. <![CDATA[The path the linux container executor should use for cgroups]]>
  11333. </doc>
  11334. </field>
  11335. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT" type="java.lang.String"
  11336. transient="false" volatile="false"
  11337. static="true" final="true" visibility="public"
  11338. deprecated="not deprecated">
  11339. <doc>
  11340. <![CDATA[Whether the linux container executor should mount cgroups if not found]]>
  11341. </doc>
  11342. </field>
  11343. <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH" type="java.lang.String"
  11344. transient="false" volatile="false"
  11345. static="true" final="true" visibility="public"
  11346. deprecated="not deprecated">
  11347. <doc>
  11348. <![CDATA[Where the linux container executor should mount cgroups if not found]]>
  11349. </doc>
  11350. </field>
  11351. <field name="NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="java.lang.String"
  11352. transient="false" volatile="false"
  11353. static="true" final="true" visibility="public"
  11354. deprecated="not deprecated">
  11355. <doc>
  11356. <![CDATA[Whether the apps should run in strict resource usage mode(not allowed to
  11357. use spare CPU)]]>
  11358. </doc>
  11359. </field>
  11360. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="boolean"
  11361. transient="false" volatile="false"
  11362. static="true" final="true" visibility="public"
  11363. deprecated="not deprecated">
  11364. </field>
  11365. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="java.lang.String"
  11366. transient="false" volatile="false"
  11367. static="true" final="true" visibility="public"
  11368. deprecated="not deprecated">
  11369. <doc>
  11370. <![CDATA[Interval of time the linux container executor should try cleaning up
  11371. cgroups entry when cleaning up a container. This is required due to what
  11372. it seems a race condition because the SIGTERM/SIGKILL is asynch.]]>
  11373. </doc>
  11374. </field>
  11375. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="long"
  11376. transient="false" volatile="false"
  11377. static="true" final="true" visibility="public"
  11378. deprecated="not deprecated">
  11379. </field>
  11380. <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="java.lang.String"
  11381. transient="false" volatile="false"
  11382. static="true" final="true" visibility="public"
  11383. deprecated="not deprecated">
  11384. <doc>
  11385. <![CDATA[Delay between attempts to remove linux cgroup.]]>
  11386. </doc>
  11387. </field>
  11388. <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="long"
  11389. transient="false" volatile="false"
  11390. static="true" final="true" visibility="public"
  11391. deprecated="not deprecated">
  11392. </field>
  11393. <field name="NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="java.lang.String"
  11394. transient="false" volatile="false"
  11395. static="true" final="true" visibility="public"
  11396. deprecated="not deprecated">
  11397. <doc>
  11398. <![CDATA[Indicates if memory and CPU limits will be set for the Windows Job
  11399. Object for the containers launched by the default container executor.]]>
  11400. </doc>
  11401. </field>
  11402. <field name="DEFAULT_NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="boolean"
  11403. transient="false" volatile="false"
  11404. static="true" final="true" visibility="public"
  11405. deprecated="not deprecated">
  11406. </field>
  11407. <field name="NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="java.lang.String"
  11408. transient="false" volatile="false"
  11409. static="true" final="true" visibility="public"
  11410. deprecated="not deprecated">
  11411. </field>
  11412. <field name="DEFAULT_NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="boolean"
  11413. transient="false" volatile="false"
  11414. static="true" final="true" visibility="public"
  11415. deprecated="not deprecated">
  11416. </field>
  11417. <field name="NM_WINDOWS_SECURE_CONTAINER_GROUP" type="java.lang.String"
  11418. transient="false" volatile="false"
  11419. static="true" final="true" visibility="public"
  11420. deprecated="not deprecated">
  11421. <doc>
  11422. <![CDATA[/* The Windows group that the windows-secure-container-executor should run as.]]>
  11423. </doc>
  11424. </field>
  11425. <field name="NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  11426. transient="false" volatile="false"
  11427. static="true" final="true" visibility="public"
  11428. deprecated="not deprecated">
  11429. <doc>
  11430. <![CDATA[T-file compression types used to compress aggregated logs.]]>
  11431. </doc>
  11432. </field>
  11433. <field name="DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
  11434. transient="false" volatile="false"
  11435. static="true" final="true" visibility="public"
  11436. deprecated="not deprecated">
  11437. </field>
  11438. <field name="NM_PRINCIPAL" type="java.lang.String"
  11439. transient="false" volatile="false"
  11440. static="true" final="true" visibility="public"
  11441. deprecated="not deprecated">
  11442. <doc>
  11443. <![CDATA[The kerberos principal for the node manager.]]>
  11444. </doc>
  11445. </field>
  11446. <field name="NM_AUX_SERVICES" type="java.lang.String"
  11447. transient="false" volatile="false"
  11448. static="true" final="true" visibility="public"
  11449. deprecated="not deprecated">
  11450. </field>
  11451. <field name="NM_AUX_SERVICE_FMT" type="java.lang.String"
  11452. transient="false" volatile="false"
  11453. static="true" final="true" visibility="public"
  11454. deprecated="not deprecated">
  11455. </field>
  11456. <field name="NM_USER_HOME_DIR" type="java.lang.String"
  11457. transient="false" volatile="false"
  11458. static="true" final="true" visibility="public"
  11459. deprecated="not deprecated">
  11460. </field>
  11461. <field name="NM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
  11462. transient="false" volatile="false"
  11463. static="true" final="true" visibility="public"
  11464. deprecated="not deprecated">
  11465. <doc>
  11466. <![CDATA[The kerberos principal to be used for spnego filter for NM.]]>
  11467. </doc>
  11468. </field>
  11469. <field name="NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
  11470. transient="false" volatile="false"
  11471. static="true" final="true" visibility="public"
  11472. deprecated="not deprecated">
  11473. <doc>
  11474. <![CDATA[The kerberos keytab to be used for spnego filter for NM.]]>
  11475. </doc>
  11476. </field>
  11477. <field name="DEFAULT_NM_USER_HOME_DIR" type="java.lang.String"
  11478. transient="false" volatile="false"
  11479. static="true" final="true" visibility="public"
  11480. deprecated="not deprecated">
  11481. </field>
  11482. <field name="NM_RECOVERY_PREFIX" type="java.lang.String"
  11483. transient="false" volatile="false"
  11484. static="true" final="true" visibility="public"
  11485. deprecated="not deprecated">
  11486. </field>
  11487. <field name="NM_RECOVERY_ENABLED" type="java.lang.String"
  11488. transient="false" volatile="false"
  11489. static="true" final="true" visibility="public"
  11490. deprecated="not deprecated">
  11491. </field>
  11492. <field name="DEFAULT_NM_RECOVERY_ENABLED" type="boolean"
  11493. transient="false" volatile="false"
  11494. static="true" final="true" visibility="public"
  11495. deprecated="not deprecated">
  11496. </field>
  11497. <field name="NM_RECOVERY_DIR" type="java.lang.String"
  11498. transient="false" volatile="false"
  11499. static="true" final="true" visibility="public"
  11500. deprecated="not deprecated">
  11501. </field>
  11502. <field name="PROXY_PREFIX" type="java.lang.String"
  11503. transient="false" volatile="false"
  11504. static="true" final="true" visibility="public"
  11505. deprecated="not deprecated">
  11506. </field>
  11507. <field name="PROXY_PRINCIPAL" type="java.lang.String"
  11508. transient="false" volatile="false"
  11509. static="true" final="true" visibility="public"
  11510. deprecated="not deprecated">
  11511. <doc>
  11512. <![CDATA[The kerberos principal for the proxy.]]>
  11513. </doc>
  11514. </field>
  11515. <field name="PROXY_KEYTAB" type="java.lang.String"
  11516. transient="false" volatile="false"
  11517. static="true" final="true" visibility="public"
  11518. deprecated="not deprecated">
  11519. <doc>
  11520. <![CDATA[Keytab for Proxy.]]>
  11521. </doc>
  11522. </field>
  11523. <field name="PROXY_ADDRESS" type="java.lang.String"
  11524. transient="false" volatile="false"
  11525. static="true" final="true" visibility="public"
  11526. deprecated="not deprecated">
  11527. <doc>
  11528. <![CDATA[The address for the web proxy.]]>
  11529. </doc>
  11530. </field>
  11531. <field name="DEFAULT_PROXY_PORT" type="int"
  11532. transient="false" volatile="false"
  11533. static="true" final="true" visibility="public"
  11534. deprecated="not deprecated">
  11535. </field>
  11536. <field name="DEFAULT_PROXY_ADDRESS" type="java.lang.String"
  11537. transient="false" volatile="false"
  11538. static="true" final="true" visibility="public"
  11539. deprecated="not deprecated">
  11540. </field>
  11541. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL" type="java.lang.String"
  11542. transient="false" volatile="false"
  11543. static="true" final="true" visibility="public"
  11544. deprecated="not deprecated">
  11545. <doc>
  11546. <![CDATA[YARN Service Level Authorization]]>
  11547. </doc>
  11548. </field>
  11549. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL" type="java.lang.String"
  11550. transient="false" volatile="false"
  11551. static="true" final="true" visibility="public"
  11552. deprecated="not deprecated">
  11553. </field>
  11554. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL" type="java.lang.String"
  11555. transient="false" volatile="false"
  11556. static="true" final="true" visibility="public"
  11557. deprecated="not deprecated">
  11558. </field>
  11559. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL" type="java.lang.String"
  11560. transient="false" volatile="false"
  11561. static="true" final="true" visibility="public"
  11562. deprecated="not deprecated">
  11563. </field>
  11564. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL" type="java.lang.String"
  11565. transient="false" volatile="false"
  11566. static="true" final="true" visibility="public"
  11567. deprecated="not deprecated">
  11568. </field>
  11569. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER" type="java.lang.String"
  11570. transient="false" volatile="false"
  11571. static="true" final="true" visibility="public"
  11572. deprecated="not deprecated">
  11573. </field>
  11574. <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL" type="java.lang.String"
  11575. transient="false" volatile="false"
  11576. static="true" final="true" visibility="public"
  11577. deprecated="not deprecated">
  11578. </field>
  11579. <field name="NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="java.lang.String"
  11580. transient="false" volatile="false"
  11581. static="true" final="true" visibility="public"
  11582. deprecated="not deprecated">
  11583. <doc>
  11584. <![CDATA[No. of milliseconds to wait between sending a SIGTERM and SIGKILL
  11585. to a running container]]>
  11586. </doc>
  11587. </field>
  11588. <field name="DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="long"
  11589. transient="false" volatile="false"
  11590. static="true" final="true" visibility="public"
  11591. deprecated="not deprecated">
  11592. </field>
  11593. <field name="NM_PROCESS_KILL_WAIT_MS" type="java.lang.String"
  11594. transient="false" volatile="false"
  11595. static="true" final="true" visibility="public"
  11596. deprecated="not deprecated">
  11597. <doc>
  11598. <![CDATA[Max time to wait for a process to come up when trying to cleanup
  11599. container resources]]>
  11600. </doc>
  11601. </field>
  11602. <field name="DEFAULT_NM_PROCESS_KILL_WAIT_MS" type="long"
  11603. transient="false" volatile="false"
  11604. static="true" final="true" visibility="public"
  11605. deprecated="not deprecated">
  11606. </field>
  11607. <field name="RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  11608. transient="false" volatile="false"
  11609. static="true" final="true" visibility="public"
  11610. deprecated="not deprecated">
  11611. <doc>
  11612. <![CDATA[Max time to wait to establish a connection to RM]]>
  11613. </doc>
  11614. </field>
  11615. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="long"
  11616. transient="false" volatile="false"
  11617. static="true" final="true" visibility="public"
  11618. deprecated="not deprecated">
  11619. </field>
  11620. <field name="RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  11621. transient="false" volatile="false"
  11622. static="true" final="true" visibility="public"
  11623. deprecated="not deprecated">
  11624. <doc>
  11625. <![CDATA[Time interval between each attempt to connect to RM]]>
  11626. </doc>
  11627. </field>
  11628. <field name="DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="long"
  11629. transient="false" volatile="false"
  11630. static="true" final="true" visibility="public"
  11631. deprecated="not deprecated">
  11632. </field>
  11633. <field name="DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="java.lang.String"
  11634. transient="false" volatile="false"
  11635. static="true" final="true" visibility="public"
  11636. deprecated="not deprecated">
  11637. </field>
  11638. <field name="DEFAULT_DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="long"
  11639. transient="false" volatile="false"
  11640. static="true" final="true" visibility="public"
  11641. deprecated="not deprecated">
  11642. </field>
  11643. <field name="YARN_APPLICATION_CLASSPATH" type="java.lang.String"
  11644. transient="false" volatile="false"
  11645. static="true" final="true" visibility="public"
  11646. deprecated="not deprecated">
  11647. <doc>
  11648. <![CDATA[CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
  11649. entries]]>
  11650. </doc>
  11651. </field>
  11652. <field name="DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH" type="java.lang.String[]"
  11653. transient="false" volatile="false"
  11654. static="true" final="true" visibility="public"
  11655. deprecated="not deprecated">
  11656. <doc>
  11657. <![CDATA[Default platform-agnostic CLASSPATH for YARN applications. A
  11658. comma-separated list of CLASSPATH entries. The parameter expansion marker
  11659. will be replaced with real parameter expansion marker ('%' for Windows and
  11660. '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
  11661. will be replaced as $VAR on Linux, and %VAR% on Windows.]]>
  11662. </doc>
  11663. </field>
  11664. <field name="DEFAULT_YARN_APPLICATION_CLASSPATH" type="java.lang.String[]"
  11665. transient="false" volatile="false"
  11666. static="true" final="true" visibility="public"
  11667. deprecated="not deprecated">
  11668. <doc>
  11669. <![CDATA[<p>
  11670. Default platform-specific CLASSPATH for YARN applications. A
  11671. comma-separated list of CLASSPATH entries constructed based on the client
  11672. OS environment expansion syntax.
  11673. </p>
  11674. <p>
  11675. Note: Use {@link #DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
  11676. cross-platform practice i.e. submit an application from a Windows client to
  11677. a Linux/Unix server or vice versa.
  11678. </p>]]>
  11679. </doc>
  11680. </field>
  11681. <field name="DEFAULT_CONTAINER_TEMP_DIR" type="java.lang.String"
  11682. transient="false" volatile="false"
  11683. static="true" final="true" visibility="public"
  11684. deprecated="not deprecated">
  11685. <doc>
  11686. <![CDATA[Container temp directory]]>
  11687. </doc>
  11688. </field>
  11689. <field name="IS_MINI_YARN_CLUSTER" type="java.lang.String"
  11690. transient="false" volatile="false"
  11691. static="true" final="true" visibility="public"
  11692. deprecated="not deprecated">
  11693. </field>
  11694. <field name="YARN_MC_PREFIX" type="java.lang.String"
  11695. transient="false" volatile="false"
  11696. static="true" final="true" visibility="public"
  11697. deprecated="not deprecated">
  11698. </field>
  11699. <field name="YARN_MINICLUSTER_FIXED_PORTS" type="java.lang.String"
  11700. transient="false" volatile="false"
  11701. static="true" final="true" visibility="public"
  11702. deprecated="not deprecated">
  11703. <doc>
  11704. <![CDATA[Whether to use fixed ports with the minicluster.]]>
  11705. </doc>
  11706. </field>
  11707. <field name="DEFAULT_YARN_MINICLUSTER_FIXED_PORTS" type="boolean"
  11708. transient="false" volatile="false"
  11709. static="true" final="true" visibility="public"
  11710. deprecated="not deprecated">
  11711. <doc>
  11712. <![CDATA[Default is false to be able to run tests concurrently without port
  11713. conflicts.]]>
  11714. </doc>
  11715. </field>
  11716. <field name="YARN_MINICLUSTER_USE_RPC" type="java.lang.String"
  11717. transient="false" volatile="false"
  11718. static="true" final="true" visibility="public"
  11719. deprecated="not deprecated">
  11720. <doc>
  11721. <![CDATA[Whether the NM should use RPC to connect to the RM. Default is false.
  11722. Can be set to true only when using fixed ports.]]>
  11723. </doc>
  11724. </field>
  11725. <field name="DEFAULT_YARN_MINICLUSTER_USE_RPC" type="boolean"
  11726. transient="false" volatile="false"
  11727. static="true" final="true" visibility="public"
  11728. deprecated="not deprecated">
  11729. </field>
  11730. <field name="YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="java.lang.String"
  11731. transient="false" volatile="false"
  11732. static="true" final="true" visibility="public"
  11733. deprecated="not deprecated">
  11734. <doc>
  11735. <![CDATA[Whether users are explicitly trying to control resource monitoring
  11736. configuration for the MiniYARNCluster. Disabled by default.]]>
  11737. </doc>
  11738. </field>
  11739. <field name="DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="boolean"
  11740. transient="false" volatile="false"
  11741. static="true" final="true" visibility="public"
  11742. deprecated="not deprecated">
  11743. </field>
  11744. <field name="YARN_MINICLUSTER_NM_PMEM_MB" type="java.lang.String"
  11745. transient="false" volatile="false"
  11746. static="true" final="true" visibility="public"
  11747. deprecated="not deprecated">
  11748. <doc>
  11749. <![CDATA[Allow changing the memory for the NodeManager in the MiniYARNCluster]]>
  11750. </doc>
  11751. </field>
  11752. <field name="DEFAULT_YARN_MINICLUSTER_NM_PMEM_MB" type="int"
  11753. transient="false" volatile="false"
  11754. static="true" final="true" visibility="public"
  11755. deprecated="not deprecated">
  11756. </field>
  11757. <field name="YARN_APP_CONTAINER_LOG_DIR" type="java.lang.String"
  11758. transient="false" volatile="false"
  11759. static="true" final="true" visibility="public"
  11760. deprecated="not deprecated">
  11761. <doc>
  11762. <![CDATA[The log directory for the containers]]>
  11763. </doc>
  11764. </field>
  11765. <field name="YARN_APP_CONTAINER_LOG_SIZE" type="java.lang.String"
  11766. transient="false" volatile="false"
  11767. static="true" final="true" visibility="public"
  11768. deprecated="not deprecated">
  11769. </field>
  11770. <field name="YARN_APP_CONTAINER_LOG_BACKUPS" type="java.lang.String"
  11771. transient="false" volatile="false"
  11772. static="true" final="true" visibility="public"
  11773. deprecated="not deprecated">
  11774. </field>
  11775. <field name="TIMELINE_SERVICE_PREFIX" type="java.lang.String"
  11776. transient="false" volatile="false"
  11777. static="true" final="true" visibility="public"
  11778. deprecated="not deprecated">
  11779. </field>
  11780. <field name="TIMELINE_SERVICE_UI_NAMES" type="java.lang.String"
  11781. transient="false" volatile="false"
  11782. static="true" final="true" visibility="public"
  11783. deprecated="not deprecated">
  11784. <doc>
  11785. <![CDATA[Comma seperated list of names for UIs hosted in the timeline server
  11786. (For pluggable UIs).]]>
  11787. </doc>
  11788. </field>
  11789. <field name="TIMELINE_SERVICE_UI_WEB_PATH_PREFIX" type="java.lang.String"
  11790. transient="false" volatile="false"
  11791. static="true" final="true" visibility="public"
  11792. deprecated="not deprecated">
  11793. <doc>
  11794. <![CDATA[Relative web path that will serve up this UI (For pluggable UIs).]]>
  11795. </doc>
  11796. </field>
  11797. <field name="TIMELINE_SERVICE_UI_ON_DISK_PATH_PREFIX" type="java.lang.String"
  11798. transient="false" volatile="false"
  11799. static="true" final="true" visibility="public"
  11800. deprecated="not deprecated">
  11801. <doc>
  11802. <![CDATA[Path to war file or static content directory for this UI
  11803. (For pluggable UIs).]]>
  11804. </doc>
  11805. </field>
  11806. <field name="APPLICATION_HISTORY_PREFIX" type="java.lang.String"
  11807. transient="false" volatile="false"
  11808. static="true" final="true" visibility="public"
  11809. deprecated="not deprecated">
  11810. </field>
  11811. <field name="APPLICATION_HISTORY_ENABLED" type="java.lang.String"
  11812. transient="false" volatile="false"
  11813. static="true" final="true" visibility="public"
  11814. deprecated="not deprecated">
  11815. <doc>
  11816. <![CDATA[The setting that controls whether application history service is
  11817. enabled or not.]]>
  11818. </doc>
  11819. </field>
  11820. <field name="DEFAULT_APPLICATION_HISTORY_ENABLED" type="boolean"
  11821. transient="false" volatile="false"
  11822. static="true" final="true" visibility="public"
  11823. deprecated="not deprecated">
  11824. </field>
  11825. <field name="APPLICATION_HISTORY_STORE" type="java.lang.String"
  11826. transient="false" volatile="false"
  11827. static="true" final="true" visibility="public"
  11828. deprecated="not deprecated">
  11829. <doc>
  11830. <![CDATA[Application history store class]]>
  11831. </doc>
  11832. </field>
  11833. <field name="APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="java.lang.String"
  11834. transient="false" volatile="false"
  11835. static="true" final="true" visibility="public"
  11836. deprecated="not deprecated">
  11837. <doc>
  11838. <![CDATA[Save container meta-info in the application history store.]]>
  11839. </doc>
  11840. </field>
  11841. <field name="DEFAULT_APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="boolean"
  11842. transient="false" volatile="false"
  11843. static="true" final="true" visibility="public"
  11844. deprecated="not deprecated">
  11845. </field>
  11846. <field name="FS_APPLICATION_HISTORY_STORE_URI" type="java.lang.String"
  11847. transient="false" volatile="false"
  11848. static="true" final="true" visibility="public"
  11849. deprecated="not deprecated">
  11850. <doc>
  11851. <![CDATA[URI for FileSystemApplicationHistoryStore]]>
  11852. </doc>
  11853. </field>
  11854. <field name="FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  11855. transient="false" volatile="false"
  11856. static="true" final="true" visibility="public"
  11857. deprecated="not deprecated">
  11858. <doc>
  11859. <![CDATA[T-file compression types used to compress history data.]]>
  11860. </doc>
  11861. </field>
  11862. <field name="DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
  11863. transient="false" volatile="false"
  11864. static="true" final="true" visibility="public"
  11865. deprecated="not deprecated">
  11866. </field>
  11867. <field name="TIMELINE_SERVICE_ENABLED" type="java.lang.String"
  11868. transient="false" volatile="false"
  11869. static="true" final="true" visibility="public"
  11870. deprecated="not deprecated">
  11871. <doc>
  11872. <![CDATA[The setting that controls whether timeline service is enabled or not.]]>
  11873. </doc>
  11874. </field>
  11875. <field name="DEFAULT_TIMELINE_SERVICE_ENABLED" type="boolean"
  11876. transient="false" volatile="false"
  11877. static="true" final="true" visibility="public"
  11878. deprecated="not deprecated">
  11879. </field>
  11880. <field name="TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  11881. transient="false" volatile="false"
  11882. static="true" final="true" visibility="public"
  11883. deprecated="not deprecated">
  11884. <doc>
  11885. <![CDATA[host:port address for timeline service RPC APIs.]]>
  11886. </doc>
  11887. </field>
  11888. <field name="DEFAULT_TIMELINE_SERVICE_PORT" type="int"
  11889. transient="false" volatile="false"
  11890. static="true" final="true" visibility="public"
  11891. deprecated="not deprecated">
  11892. </field>
  11893. <field name="DEFAULT_TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
  11894. transient="false" volatile="false"
  11895. static="true" final="true" visibility="public"
  11896. deprecated="not deprecated">
  11897. </field>
  11898. <field name="TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
  11899. transient="false" volatile="false"
  11900. static="true" final="true" visibility="public"
  11901. deprecated="not deprecated">
  11902. <doc>
  11903. <![CDATA[The listening endpoint for the timeline service application.]]>
  11904. </doc>
  11905. </field>
  11906. <field name="TIMELINE_SERVICE_HANDLER_THREAD_COUNT" type="java.lang.String"
  11907. transient="false" volatile="false"
  11908. static="true" final="true" visibility="public"
  11909. deprecated="not deprecated">
  11910. <doc>
  11911. <![CDATA[The number of threads to handle client RPC API requests.]]>
  11912. </doc>
  11913. </field>
  11914. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT" type="int"
  11915. transient="false" volatile="false"
  11916. static="true" final="true" visibility="public"
  11917. deprecated="not deprecated">
  11918. </field>
  11919. <field name="TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  11920. transient="false" volatile="false"
  11921. static="true" final="true" visibility="public"
  11922. deprecated="not deprecated">
  11923. <doc>
  11924. <![CDATA[The address of the timeline service web application.]]>
  11925. </doc>
  11926. </field>
  11927. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT" type="int"
  11928. transient="false" volatile="false"
  11929. static="true" final="true" visibility="public"
  11930. deprecated="not deprecated">
  11931. </field>
  11932. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
  11933. transient="false" volatile="false"
  11934. static="true" final="true" visibility="public"
  11935. deprecated="not deprecated">
  11936. </field>
  11937. <field name="TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  11938. transient="false" volatile="false"
  11939. static="true" final="true" visibility="public"
  11940. deprecated="not deprecated">
  11941. <doc>
  11942. <![CDATA[The https address of the timeline service web application.]]>
  11943. </doc>
  11944. </field>
  11945. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT" type="int"
  11946. transient="false" volatile="false"
  11947. static="true" final="true" visibility="public"
  11948. deprecated="not deprecated">
  11949. </field>
  11950. <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
  11951. transient="false" volatile="false"
  11952. static="true" final="true" visibility="public"
  11953. deprecated="not deprecated">
  11954. </field>
  11955. <field name="APPLICATION_HISTORY_MAX_APPS" type="java.lang.String"
  11956. transient="false" volatile="false"
  11957. static="true" final="true" visibility="public"
  11958. deprecated="not deprecated">
  11959. <doc>
  11960. <![CDATA[Defines the max number of applications could be fetched using
  11961. REST API or application history protocol and shown in timeline
  11962. server web ui.]]>
  11963. </doc>
  11964. </field>
  11965. <field name="DEFAULT_APPLICATION_HISTORY_MAX_APPS" type="long"
  11966. transient="false" volatile="false"
  11967. static="true" final="true" visibility="public"
  11968. deprecated="not deprecated">
  11969. </field>
  11970. <field name="TIMELINE_SERVICE_STORE" type="java.lang.String"
  11971. transient="false" volatile="false"
  11972. static="true" final="true" visibility="public"
  11973. deprecated="not deprecated">
  11974. <doc>
  11975. <![CDATA[Timeline service store class]]>
  11976. </doc>
  11977. </field>
  11978. <field name="TIMELINE_SERVICE_TTL_ENABLE" type="java.lang.String"
  11979. transient="false" volatile="false"
  11980. static="true" final="true" visibility="public"
  11981. deprecated="not deprecated">
  11982. <doc>
  11983. <![CDATA[Timeline service enable data age off]]>
  11984. </doc>
  11985. </field>
  11986. <field name="TIMELINE_SERVICE_TTL_MS" type="java.lang.String"
  11987. transient="false" volatile="false"
  11988. static="true" final="true" visibility="public"
  11989. deprecated="not deprecated">
  11990. <doc>
  11991. <![CDATA[Timeline service length of time to retain data]]>
  11992. </doc>
  11993. </field>
  11994. <field name="DEFAULT_TIMELINE_SERVICE_TTL_MS" type="long"
  11995. transient="false" volatile="false"
  11996. static="true" final="true" visibility="public"
  11997. deprecated="not deprecated">
  11998. </field>
  11999. <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
  12000. transient="false" volatile="false"
  12001. static="true" final="true" visibility="public"
  12002. deprecated="not deprecated">
  12003. </field>
  12004. <field name="TIMELINE_SERVICE_LEVELDB_PATH" type="java.lang.String"
  12005. transient="false" volatile="false"
  12006. static="true" final="true" visibility="public"
  12007. deprecated="not deprecated">
  12008. <doc>
  12009. <![CDATA[Timeline service leveldb path]]>
  12010. </doc>
  12011. </field>
  12012. <field name="TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="java.lang.String"
  12013. transient="false" volatile="false"
  12014. static="true" final="true" visibility="public"
  12015. deprecated="not deprecated">
  12016. <doc>
  12017. <![CDATA[Timeline service leveldb read cache (uncompressed blocks)]]>
  12018. </doc>
  12019. </field>
  12020. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="long"
  12021. transient="false" volatile="false"
  12022. static="true" final="true" visibility="public"
  12023. deprecated="not deprecated">
  12024. </field>
  12025. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="java.lang.String"
  12026. transient="false" volatile="false"
  12027. static="true" final="true" visibility="public"
  12028. deprecated="not deprecated">
  12029. <doc>
  12030. <![CDATA[Timeline service leveldb start time read cache (number of entities)]]>
  12031. </doc>
  12032. </field>
  12033. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="int"
  12034. transient="false" volatile="false"
  12035. static="true" final="true" visibility="public"
  12036. deprecated="not deprecated">
  12037. </field>
  12038. <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="java.lang.String"
  12039. transient="false" volatile="false"
  12040. static="true" final="true" visibility="public"
  12041. deprecated="not deprecated">
  12042. <doc>
  12043. <![CDATA[Timeline service leveldb start time write cache (number of entities)]]>
  12044. </doc>
  12045. </field>
  12046. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="int"
  12047. transient="false" volatile="false"
  12048. static="true" final="true" visibility="public"
  12049. deprecated="not deprecated">
  12050. </field>
  12051. <field name="TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="java.lang.String"
  12052. transient="false" volatile="false"
  12053. static="true" final="true" visibility="public"
  12054. deprecated="not deprecated">
  12055. <doc>
  12056. <![CDATA[Timeline service leveldb interval to wait between deletion rounds]]>
  12057. </doc>
  12058. </field>
  12059. <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="long"
  12060. transient="false" volatile="false"
  12061. static="true" final="true" visibility="public"
  12062. deprecated="not deprecated">
  12063. </field>
  12064. <field name="TIMELINE_SERVICE_PRINCIPAL" type="java.lang.String"
  12065. transient="false" volatile="false"
  12066. static="true" final="true" visibility="public"
  12067. deprecated="not deprecated">
  12068. <doc>
  12069. <![CDATA[The Kerberos principal for the timeline server.]]>
  12070. </doc>
  12071. </field>
  12072. <field name="TIMELINE_SERVICE_KEYTAB" type="java.lang.String"
  12073. transient="false" volatile="false"
  12074. static="true" final="true" visibility="public"
  12075. deprecated="not deprecated">
  12076. <doc>
  12077. <![CDATA[The Kerberos keytab for the timeline server.]]>
  12078. </doc>
  12079. </field>
  12080. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED" type="java.lang.String"
  12081. transient="false" volatile="false"
  12082. static="true" final="true" visibility="public"
  12083. deprecated="not deprecated">
  12084. <doc>
  12085. <![CDATA[Enables cross origin support for timeline server.]]>
  12086. </doc>
  12087. </field>
  12088. <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT" type="boolean"
  12089. transient="false" volatile="false"
  12090. static="true" final="true" visibility="public"
  12091. deprecated="not deprecated">
  12092. <doc>
  12093. <![CDATA[Default value for cross origin support for timeline server.]]>
  12094. </doc>
  12095. </field>
  12096. <field name="TIMELINE_SERVICE_CLIENT_PREFIX" type="java.lang.String"
  12097. transient="false" volatile="false"
  12098. static="true" final="true" visibility="public"
  12099. deprecated="not deprecated">
  12100. <doc>
  12101. <![CDATA[Timeline client settings]]>
  12102. </doc>
  12103. </field>
  12104. <field name="TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="java.lang.String"
  12105. transient="false" volatile="false"
  12106. static="true" final="true" visibility="public"
  12107. deprecated="not deprecated">
  12108. <doc>
  12109. <![CDATA[Timeline client call, max retries (-1 means no limit)]]>
  12110. </doc>
  12111. </field>
  12112. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="int"
  12113. transient="false" volatile="false"
  12114. static="true" final="true" visibility="public"
  12115. deprecated="not deprecated">
  12116. </field>
  12117. <field name="TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="java.lang.String"
  12118. transient="false" volatile="false"
  12119. static="true" final="true" visibility="public"
  12120. deprecated="not deprecated">
  12121. <doc>
  12122. <![CDATA[Timeline client call, retry interval]]>
  12123. </doc>
  12124. </field>
  12125. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="long"
  12126. transient="false" volatile="false"
  12127. static="true" final="true" visibility="public"
  12128. deprecated="not deprecated">
  12129. </field>
  12130. <field name="TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="java.lang.String"
  12131. transient="false" volatile="false"
  12132. static="true" final="true" visibility="public"
  12133. deprecated="not deprecated">
  12134. <doc>
  12135. <![CDATA[Timeline client policy for whether connections are fatal]]>
  12136. </doc>
  12137. </field>
  12138. <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="boolean"
  12139. transient="false" volatile="false"
  12140. static="true" final="true" visibility="public"
  12141. deprecated="not deprecated">
  12142. </field>
  12143. <field name="TIMELINE_SERVICE_RECOVERY_ENABLED" type="java.lang.String"
  12144. transient="false" volatile="false"
  12145. static="true" final="true" visibility="public"
  12146. deprecated="not deprecated">
  12147. <doc>
  12148. <![CDATA[Flag to enable recovery of timeline service]]>
  12149. </doc>
  12150. </field>
  12151. <field name="DEFAULT_TIMELINE_SERVICE_RECOVERY_ENABLED" type="boolean"
  12152. transient="false" volatile="false"
  12153. static="true" final="true" visibility="public"
  12154. deprecated="not deprecated">
  12155. </field>
  12156. <field name="TIMELINE_SERVICE_STATE_STORE_CLASS" type="java.lang.String"
  12157. transient="false" volatile="false"
  12158. static="true" final="true" visibility="public"
  12159. deprecated="not deprecated">
  12160. <doc>
  12161. <![CDATA[Timeline service state store class]]>
  12162. </doc>
  12163. </field>
  12164. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX" type="java.lang.String"
  12165. transient="false" volatile="false"
  12166. static="true" final="true" visibility="public"
  12167. deprecated="not deprecated">
  12168. </field>
  12169. <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PATH" type="java.lang.String"
  12170. transient="false" volatile="false"
  12171. static="true" final="true" visibility="public"
  12172. deprecated="not deprecated">
  12173. <doc>
  12174. <![CDATA[Timeline service state store leveldb path]]>
  12175. </doc>
  12176. </field>
  12177. <field name="TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="java.lang.String"
  12178. transient="false" volatile="false"
  12179. static="true" final="true" visibility="public"
  12180. deprecated="not deprecated">
  12181. </field>
  12182. <field name="DEFAULT_TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="long"
  12183. transient="false" volatile="false"
  12184. static="true" final="true" visibility="public"
  12185. deprecated="not deprecated">
  12186. </field>
  12187. <field name="TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="java.lang.String"
  12188. transient="false" volatile="false"
  12189. static="true" final="true" visibility="public"
  12190. deprecated="not deprecated">
  12191. </field>
  12192. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="long"
  12193. transient="false" volatile="false"
  12194. static="true" final="true" visibility="public"
  12195. deprecated="not deprecated">
  12196. </field>
  12197. <field name="TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="java.lang.String"
  12198. transient="false" volatile="false"
  12199. static="true" final="true" visibility="public"
  12200. deprecated="not deprecated">
  12201. </field>
  12202. <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="long"
  12203. transient="false" volatile="false"
  12204. static="true" final="true" visibility="public"
  12205. deprecated="not deprecated">
  12206. </field>
  12207. <field name="SHARED_CACHE_PREFIX" type="java.lang.String"
  12208. transient="false" volatile="false"
  12209. static="true" final="true" visibility="public"
  12210. deprecated="not deprecated">
  12211. </field>
  12212. <field name="SHARED_CACHE_ENABLED" type="java.lang.String"
  12213. transient="false" volatile="false"
  12214. static="true" final="true" visibility="public"
  12215. deprecated="not deprecated">
  12216. <doc>
  12217. <![CDATA[whether the shared cache is enabled/disabled]]>
  12218. </doc>
  12219. </field>
  12220. <field name="DEFAULT_SHARED_CACHE_ENABLED" type="boolean"
  12221. transient="false" volatile="false"
  12222. static="true" final="true" visibility="public"
  12223. deprecated="not deprecated">
  12224. </field>
  12225. <field name="SHARED_CACHE_ROOT" type="java.lang.String"
  12226. transient="false" volatile="false"
  12227. static="true" final="true" visibility="public"
  12228. deprecated="not deprecated">
  12229. <doc>
  12230. <![CDATA[The config key for the shared cache root directory.]]>
  12231. </doc>
  12232. </field>
  12233. <field name="DEFAULT_SHARED_CACHE_ROOT" type="java.lang.String"
  12234. transient="false" volatile="false"
  12235. static="true" final="true" visibility="public"
  12236. deprecated="not deprecated">
  12237. </field>
  12238. <field name="SHARED_CACHE_NESTED_LEVEL" type="java.lang.String"
  12239. transient="false" volatile="false"
  12240. static="true" final="true" visibility="public"
  12241. deprecated="not deprecated">
  12242. <doc>
  12243. <![CDATA[The config key for the level of nested directories before getting to the
  12244. checksum directory.]]>
  12245. </doc>
  12246. </field>
  12247. <field name="DEFAULT_SHARED_CACHE_NESTED_LEVEL" type="int"
  12248. transient="false" volatile="false"
  12249. static="true" final="true" visibility="public"
  12250. deprecated="not deprecated">
  12251. </field>
  12252. <field name="SCM_STORE_PREFIX" type="java.lang.String"
  12253. transient="false" volatile="false"
  12254. static="true" final="true" visibility="public"
  12255. deprecated="not deprecated">
  12256. </field>
  12257. <field name="SCM_STORE_CLASS" type="java.lang.String"
  12258. transient="false" volatile="false"
  12259. static="true" final="true" visibility="public"
  12260. deprecated="not deprecated">
  12261. </field>
  12262. <field name="DEFAULT_SCM_STORE_CLASS" type="java.lang.String"
  12263. transient="false" volatile="false"
  12264. static="true" final="true" visibility="public"
  12265. deprecated="not deprecated">
  12266. </field>
  12267. <field name="SCM_APP_CHECKER_CLASS" type="java.lang.String"
  12268. transient="false" volatile="false"
  12269. static="true" final="true" visibility="public"
  12270. deprecated="not deprecated">
  12271. </field>
  12272. <field name="DEFAULT_SCM_APP_CHECKER_CLASS" type="java.lang.String"
  12273. transient="false" volatile="false"
  12274. static="true" final="true" visibility="public"
  12275. deprecated="not deprecated">
  12276. </field>
  12277. <field name="SCM_ADMIN_ADDRESS" type="java.lang.String"
  12278. transient="false" volatile="false"
  12279. static="true" final="true" visibility="public"
  12280. deprecated="not deprecated">
  12281. <doc>
  12282. <![CDATA[The address of the SCM admin interface.]]>
  12283. </doc>
  12284. </field>
  12285. <field name="DEFAULT_SCM_ADMIN_PORT" type="int"
  12286. transient="false" volatile="false"
  12287. static="true" final="true" visibility="public"
  12288. deprecated="not deprecated">
  12289. </field>
  12290. <field name="DEFAULT_SCM_ADMIN_ADDRESS" type="java.lang.String"
  12291. transient="false" volatile="false"
  12292. static="true" final="true" visibility="public"
  12293. deprecated="not deprecated">
  12294. </field>
  12295. <field name="SCM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
  12296. transient="false" volatile="false"
  12297. static="true" final="true" visibility="public"
  12298. deprecated="not deprecated">
  12299. <doc>
  12300. <![CDATA[Number of threads used to handle SCM admin interface.]]>
  12301. </doc>
  12302. </field>
  12303. <field name="DEFAULT_SCM_ADMIN_CLIENT_THREAD_COUNT" type="int"
  12304. transient="false" volatile="false"
  12305. static="true" final="true" visibility="public"
  12306. deprecated="not deprecated">
  12307. </field>
  12308. <field name="SCM_WEBAPP_ADDRESS" type="java.lang.String"
  12309. transient="false" volatile="false"
  12310. static="true" final="true" visibility="public"
  12311. deprecated="not deprecated">
  12312. <doc>
  12313. <![CDATA[The address of the SCM web application.]]>
  12314. </doc>
  12315. </field>
  12316. <field name="DEFAULT_SCM_WEBAPP_PORT" type="int"
  12317. transient="false" volatile="false"
  12318. static="true" final="true" visibility="public"
  12319. deprecated="not deprecated">
  12320. </field>
  12321. <field name="DEFAULT_SCM_WEBAPP_ADDRESS" type="java.lang.String"
  12322. transient="false" volatile="false"
  12323. static="true" final="true" visibility="public"
  12324. deprecated="not deprecated">
  12325. </field>
  12326. <field name="IN_MEMORY_STORE_PREFIX" type="java.lang.String"
  12327. transient="false" volatile="false"
  12328. static="true" final="true" visibility="public"
  12329. deprecated="not deprecated">
  12330. </field>
  12331. <field name="IN_MEMORY_STALENESS_PERIOD_MINS" type="java.lang.String"
  12332. transient="false" volatile="false"
  12333. static="true" final="true" visibility="public"
  12334. deprecated="not deprecated">
  12335. <doc>
  12336. <![CDATA[A resource in the InMemorySCMStore is considered stale if the time since
  12337. the last reference exceeds the staleness period. This value is specified in
  12338. minutes.]]>
  12339. </doc>
  12340. </field>
  12341. <field name="DEFAULT_IN_MEMORY_STALENESS_PERIOD_MINS" type="int"
  12342. transient="false" volatile="false"
  12343. static="true" final="true" visibility="public"
  12344. deprecated="not deprecated">
  12345. </field>
  12346. <field name="IN_MEMORY_INITIAL_DELAY_MINS" type="java.lang.String"
  12347. transient="false" volatile="false"
  12348. static="true" final="true" visibility="public"
  12349. deprecated="not deprecated">
  12350. <doc>
  12351. <![CDATA[Initial delay before the in-memory store runs its first check to remove
  12352. dead initial applications. Specified in minutes.]]>
  12353. </doc>
  12354. </field>
  12355. <field name="DEFAULT_IN_MEMORY_INITIAL_DELAY_MINS" type="int"
  12356. transient="false" volatile="false"
  12357. static="true" final="true" visibility="public"
  12358. deprecated="not deprecated">
  12359. </field>
  12360. <field name="IN_MEMORY_CHECK_PERIOD_MINS" type="java.lang.String"
  12361. transient="false" volatile="false"
  12362. static="true" final="true" visibility="public"
  12363. deprecated="not deprecated">
  12364. <doc>
  12365. <![CDATA[The frequency at which the in-memory store checks to remove dead initial
  12366. applications. Specified in minutes.]]>
  12367. </doc>
  12368. </field>
  12369. <field name="DEFAULT_IN_MEMORY_CHECK_PERIOD_MINS" type="int"
  12370. transient="false" volatile="false"
  12371. static="true" final="true" visibility="public"
  12372. deprecated="not deprecated">
  12373. </field>
  12374. <field name="SCM_CLEANER_PERIOD_MINS" type="java.lang.String"
  12375. transient="false" volatile="false"
  12376. static="true" final="true" visibility="public"
  12377. deprecated="not deprecated">
  12378. <doc>
  12379. <![CDATA[The frequency at which a cleaner task runs. Specified in minutes.]]>
  12380. </doc>
  12381. </field>
  12382. <field name="DEFAULT_SCM_CLEANER_PERIOD_MINS" type="int"
  12383. transient="false" volatile="false"
  12384. static="true" final="true" visibility="public"
  12385. deprecated="not deprecated">
  12386. </field>
  12387. <field name="SCM_CLEANER_INITIAL_DELAY_MINS" type="java.lang.String"
  12388. transient="false" volatile="false"
  12389. static="true" final="true" visibility="public"
  12390. deprecated="not deprecated">
  12391. <doc>
  12392. <![CDATA[Initial delay before the first cleaner task is scheduled. Specified in
  12393. minutes.]]>
  12394. </doc>
  12395. </field>
  12396. <field name="DEFAULT_SCM_CLEANER_INITIAL_DELAY_MINS" type="int"
  12397. transient="false" volatile="false"
  12398. static="true" final="true" visibility="public"
  12399. deprecated="not deprecated">
  12400. </field>
  12401. <field name="SCM_CLEANER_RESOURCE_SLEEP_MS" type="java.lang.String"
  12402. transient="false" volatile="false"
  12403. static="true" final="true" visibility="public"
  12404. deprecated="not deprecated">
  12405. <doc>
  12406. <![CDATA[The time to sleep between processing each shared cache resource. Specified
  12407. in milliseconds.]]>
  12408. </doc>
  12409. </field>
  12410. <field name="DEFAULT_SCM_CLEANER_RESOURCE_SLEEP_MS" type="long"
  12411. transient="false" volatile="false"
  12412. static="true" final="true" visibility="public"
  12413. deprecated="not deprecated">
  12414. </field>
  12415. <field name="SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  12416. transient="false" volatile="false"
  12417. static="true" final="true" visibility="public"
  12418. deprecated="not deprecated">
  12419. <doc>
  12420. <![CDATA[The address of the node manager interface in the SCM.]]>
  12421. </doc>
  12422. </field>
  12423. <field name="DEFAULT_SCM_UPLOADER_SERVER_PORT" type="int"
  12424. transient="false" volatile="false"
  12425. static="true" final="true" visibility="public"
  12426. deprecated="not deprecated">
  12427. </field>
  12428. <field name="DEFAULT_SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
  12429. transient="false" volatile="false"
  12430. static="true" final="true" visibility="public"
  12431. deprecated="not deprecated">
  12432. </field>
  12433. <field name="SCM_UPLOADER_SERVER_THREAD_COUNT" type="java.lang.String"
  12434. transient="false" volatile="false"
  12435. static="true" final="true" visibility="public"
  12436. deprecated="not deprecated">
  12437. <doc>
  12438. <![CDATA[The number of SCM threads used to handle notify requests from the node
  12439. manager.]]>
  12440. </doc>
  12441. </field>
  12442. <field name="DEFAULT_SCM_UPLOADER_SERVER_THREAD_COUNT" type="int"
  12443. transient="false" volatile="false"
  12444. static="true" final="true" visibility="public"
  12445. deprecated="not deprecated">
  12446. </field>
  12447. <field name="SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  12448. transient="false" volatile="false"
  12449. static="true" final="true" visibility="public"
  12450. deprecated="not deprecated">
  12451. <doc>
  12452. <![CDATA[The address of the client interface in the SCM.]]>
  12453. </doc>
  12454. </field>
  12455. <field name="DEFAULT_SCM_CLIENT_SERVER_PORT" type="int"
  12456. transient="false" volatile="false"
  12457. static="true" final="true" visibility="public"
  12458. deprecated="not deprecated">
  12459. </field>
  12460. <field name="DEFAULT_SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
  12461. transient="false" volatile="false"
  12462. static="true" final="true" visibility="public"
  12463. deprecated="not deprecated">
  12464. </field>
  12465. <field name="SCM_CLIENT_SERVER_THREAD_COUNT" type="java.lang.String"
  12466. transient="false" volatile="false"
  12467. static="true" final="true" visibility="public"
  12468. deprecated="not deprecated">
  12469. <doc>
  12470. <![CDATA[The number of threads used to handle shared cache manager requests.]]>
  12471. </doc>
  12472. </field>
  12473. <field name="DEFAULT_SCM_CLIENT_SERVER_THREAD_COUNT" type="int"
  12474. transient="false" volatile="false"
  12475. static="true" final="true" visibility="public"
  12476. deprecated="not deprecated">
  12477. </field>
  12478. <field name="SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  12479. transient="false" volatile="false"
  12480. static="true" final="true" visibility="public"
  12481. deprecated="not deprecated">
  12482. <doc>
  12483. <![CDATA[the checksum algorithm implementation]]>
  12484. </doc>
  12485. </field>
  12486. <field name="DEFAULT_SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
  12487. transient="false" volatile="false"
  12488. static="true" final="true" visibility="public"
  12489. deprecated="not deprecated">
  12490. </field>
  12491. <field name="SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="java.lang.String"
  12492. transient="false" volatile="false"
  12493. static="true" final="true" visibility="public"
  12494. deprecated="not deprecated">
  12495. <doc>
  12496. <![CDATA[The replication factor for the node manager uploader for the shared cache.]]>
  12497. </doc>
  12498. </field>
  12499. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="int"
  12500. transient="false" volatile="false"
  12501. static="true" final="true" visibility="public"
  12502. deprecated="not deprecated">
  12503. </field>
  12504. <field name="SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="java.lang.String"
  12505. transient="false" volatile="false"
  12506. static="true" final="true" visibility="public"
  12507. deprecated="not deprecated">
  12508. </field>
  12509. <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="int"
  12510. transient="false" volatile="false"
  12511. static="true" final="true" visibility="public"
  12512. deprecated="not deprecated">
  12513. </field>
  12514. <field name="YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS" type="java.lang.String"
  12515. transient="false" volatile="false"
  12516. static="true" final="true" visibility="public"
  12517. deprecated="not deprecated">
  12518. <doc>
  12519. <![CDATA[Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
  12520. The interval of the yarn client's querying application state after
  12521. application submission. The unit is millisecond.]]>
  12522. </doc>
  12523. </field>
  12524. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="java.lang.String"
  12525. transient="false" volatile="false"
  12526. static="true" final="true" visibility="public"
  12527. deprecated="not deprecated">
  12528. <doc>
  12529. <![CDATA[The interval that the yarn client library uses to poll the completion
  12530. status of the asynchronous API of application client protocol.]]>
  12531. </doc>
  12532. </field>
  12533. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="long"
  12534. transient="false" volatile="false"
  12535. static="true" final="true" visibility="public"
  12536. deprecated="not deprecated">
  12537. </field>
  12538. <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="java.lang.String"
  12539. transient="false" volatile="false"
  12540. static="true" final="true" visibility="public"
  12541. deprecated="not deprecated">
  12542. <doc>
  12543. <![CDATA[The duration that the yarn client library waits, cumulatively across polls,
  12544. for an expected state change to occur. Defaults to -1, which indicates no
  12545. limit.]]>
  12546. </doc>
  12547. </field>
  12548. <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="long"
  12549. transient="false" volatile="false"
  12550. static="true" final="true" visibility="public"
  12551. deprecated="not deprecated">
  12552. </field>
  12553. <field name="NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="java.lang.String"
  12554. transient="false" volatile="false"
  12555. static="true" final="true" visibility="public"
  12556. deprecated="not deprecated">
  12557. <doc>
  12558. <![CDATA[Max number of threads in NMClientAsync to process container management
  12559. events]]>
  12560. </doc>
  12561. </field>
  12562. <field name="DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="int"
  12563. transient="false" volatile="false"
  12564. static="true" final="true" visibility="public"
  12565. deprecated="not deprecated">
  12566. </field>
  12567. <field name="NM_CLIENT_MAX_NM_PROXIES" type="java.lang.String"
  12568. transient="false" volatile="false"
  12569. static="true" final="true" visibility="public"
  12570. deprecated="not deprecated">
  12571. <doc>
  12572. <![CDATA[Maximum number of proxy connections to cache for node managers. If set
  12573. to a value greater than zero then the cache is enabled and the NMClient
  12574. and MRAppMaster will cache the specified number of node manager proxies.
  12575. There will be at max one proxy per node manager. Ex. configuring it to a
  12576. value of 5 will make sure that client will at max have 5 proxies cached
  12577. with 5 different node managers. These connections for these proxies will
  12578. be timed out if idle for more than the system wide idle timeout period.
  12579. Note that this could cause issues on large clusters as many connections
  12580. could linger simultaneously and lead to a large number of connection
  12581. threads. The token used for authentication will be used only at
  12582. connection creation time. If a new token is received then the earlier
  12583. connection should be closed in order to use the new token. This and
  12584. {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
  12585. and should be in sync (no need for them to be equal).
  12586. If the value of this property is zero then the connection cache is
  12587. disabled and connections will use a zero idle timeout to prevent too
  12588. many connection threads on large clusters.]]>
  12589. </doc>
  12590. </field>
  12591. <field name="DEFAULT_NM_CLIENT_MAX_NM_PROXIES" type="int"
  12592. transient="false" volatile="false"
  12593. static="true" final="true" visibility="public"
  12594. deprecated="not deprecated">
  12595. </field>
  12596. <field name="CLIENT_NM_CONNECT_MAX_WAIT_MS" type="java.lang.String"
  12597. transient="false" volatile="false"
  12598. static="true" final="true" visibility="public"
  12599. deprecated="not deprecated">
  12600. <doc>
  12601. <![CDATA[Max time to wait to establish a connection to NM]]>
  12602. </doc>
  12603. </field>
  12604. <field name="DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS" type="long"
  12605. transient="false" volatile="false"
  12606. static="true" final="true" visibility="public"
  12607. deprecated="not deprecated">
  12608. </field>
  12609. <field name="CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
  12610. transient="false" volatile="false"
  12611. static="true" final="true" visibility="public"
  12612. deprecated="not deprecated">
  12613. <doc>
  12614. <![CDATA[Time interval between each attempt to connect to NM]]>
  12615. </doc>
  12616. </field>
  12617. <field name="DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="long"
  12618. transient="false" volatile="false"
  12619. static="true" final="true" visibility="public"
  12620. deprecated="not deprecated">
  12621. </field>
  12622. <field name="YARN_HTTP_POLICY_KEY" type="java.lang.String"
  12623. transient="false" volatile="false"
  12624. static="true" final="true" visibility="public"
  12625. deprecated="not deprecated">
  12626. </field>
  12627. <field name="YARN_HTTP_POLICY_DEFAULT" type="java.lang.String"
  12628. transient="false" volatile="false"
  12629. static="true" final="true" visibility="public"
  12630. deprecated="not deprecated">
  12631. </field>
  12632. <field name="NODE_LABELS_PREFIX" type="java.lang.String"
  12633. transient="false" volatile="false"
  12634. static="true" final="true" visibility="public"
  12635. deprecated="not deprecated">
  12636. <doc>
  12637. <![CDATA[Node-labels configurations]]>
  12638. </doc>
  12639. </field>
  12640. <field name="FS_NODE_LABELS_STORE_ROOT_DIR" type="java.lang.String"
  12641. transient="false" volatile="false"
  12642. static="true" final="true" visibility="public"
  12643. deprecated="not deprecated">
  12644. <doc>
  12645. <![CDATA[URI for NodeLabelManager]]>
  12646. </doc>
  12647. </field>
  12648. <field name="FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  12649. transient="false" volatile="false"
  12650. static="true" final="true" visibility="public"
  12651. deprecated="not deprecated">
  12652. </field>
  12653. <field name="DEFAULT_FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
  12654. transient="false" volatile="false"
  12655. static="true" final="true" visibility="public"
  12656. deprecated="not deprecated">
  12657. </field>
  12658. <field name="NODE_LABELS_ENABLED" type="java.lang.String"
  12659. transient="false" volatile="false"
  12660. static="true" final="true" visibility="public"
  12661. deprecated="not deprecated">
  12662. <doc>
  12663. <![CDATA[Flag to indicate if the node labels feature enabled, by default it's
  12664. disabled]]>
  12665. </doc>
  12666. </field>
  12667. <field name="DEFAULT_NODE_LABELS_ENABLED" type="boolean"
  12668. transient="false" volatile="false"
  12669. static="true" final="true" visibility="public"
  12670. deprecated="not deprecated">
  12671. </field>
  12672. </class>
  12673. <!-- end class org.apache.hadoop.yarn.conf.YarnConfiguration -->
  12674. </package>
  12675. <package name="org.apache.hadoop.yarn.exceptions">
  12676. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  12677. <class name="ApplicationAttemptNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12678. abstract="false"
  12679. static="false" final="false" visibility="public"
  12680. deprecated="not deprecated">
  12681. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.Throwable"
  12682. static="false" final="false" visibility="public"
  12683. deprecated="not deprecated">
  12684. </constructor>
  12685. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String"
  12686. static="false" final="false" visibility="public"
  12687. deprecated="not deprecated">
  12688. </constructor>
  12689. <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String, java.lang.Throwable"
  12690. static="false" final="false" visibility="public"
  12691. deprecated="not deprecated">
  12692. </constructor>
  12693. <doc>
  12694. <![CDATA[This exception is thrown on
  12695. {@link ApplicationHistoryProtocol#getApplicationAttemptReport (GetApplicationAttemptReportRequest)}
  12696. API when the Application Attempt doesn't exist in Application History Server or
  12697. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} if application
  12698. doesn't exist in RM.]]>
  12699. </doc>
  12700. </class>
  12701. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
  12702. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  12703. <class name="ApplicationIdNotProvidedException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12704. abstract="false"
  12705. static="false" final="false" visibility="public"
  12706. deprecated="not deprecated">
  12707. <constructor name="ApplicationIdNotProvidedException" type="java.lang.Throwable"
  12708. static="false" final="false" visibility="public"
  12709. deprecated="not deprecated">
  12710. </constructor>
  12711. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String"
  12712. static="false" final="false" visibility="public"
  12713. deprecated="not deprecated">
  12714. </constructor>
  12715. <constructor name="ApplicationIdNotProvidedException" type="java.lang.String, java.lang.Throwable"
  12716. static="false" final="false" visibility="public"
  12717. deprecated="not deprecated">
  12718. </constructor>
  12719. <doc>
  12720. <![CDATA[Exception to be thrown when Client submit an application without
  12721. providing {@link ApplicationId} in {@link ApplicationSubmissionContext}.]]>
  12722. </doc>
  12723. </class>
  12724. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
  12725. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationMasterNotRegisteredException -->
  12726. <class name="ApplicationMasterNotRegisteredException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12727. abstract="false"
  12728. static="false" final="false" visibility="public"
  12729. deprecated="not deprecated">
  12730. <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.Throwable"
  12731. static="false" final="false" visibility="public"
  12732. deprecated="not deprecated">
  12733. </constructor>
  12734. <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.String"
  12735. static="false" final="false" visibility="public"
  12736. deprecated="not deprecated">
  12737. </constructor>
  12738. <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.String, java.lang.Throwable"
  12739. static="false" final="false" visibility="public"
  12740. deprecated="not deprecated">
  12741. </constructor>
  12742. <doc>
  12743. <![CDATA[This exception is thrown when an Application Master tries to unregister by calling
  12744. {@link ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)}
  12745. API without first registering by calling
  12746. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
  12747. or after an RM restart. The ApplicationMaster is expected to call
  12748. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
  12749. and retry.]]>
  12750. </doc>
  12751. </class>
  12752. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationMasterNotRegisteredException -->
  12753. <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  12754. <class name="ApplicationNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12755. abstract="false"
  12756. static="false" final="false" visibility="public"
  12757. deprecated="not deprecated">
  12758. <constructor name="ApplicationNotFoundException" type="java.lang.Throwable"
  12759. static="false" final="false" visibility="public"
  12760. deprecated="not deprecated">
  12761. </constructor>
  12762. <constructor name="ApplicationNotFoundException" type="java.lang.String"
  12763. static="false" final="false" visibility="public"
  12764. deprecated="not deprecated">
  12765. </constructor>
  12766. <constructor name="ApplicationNotFoundException" type="java.lang.String, java.lang.Throwable"
  12767. static="false" final="false" visibility="public"
  12768. deprecated="not deprecated">
  12769. </constructor>
  12770. <doc>
  12771. <![CDATA[This exception is thrown on
  12772. {@link ApplicationClientProtocol#getApplicationReport
  12773. (GetApplicationReportRequest)} API
  12774. when the Application doesn't exist in RM and AHS]]>
  12775. </doc>
  12776. </class>
  12777. <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
  12778. <!-- start class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  12779. <class name="ContainerNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12780. abstract="false"
  12781. static="false" final="false" visibility="public"
  12782. deprecated="not deprecated">
  12783. <constructor name="ContainerNotFoundException" type="java.lang.Throwable"
  12784. static="false" final="false" visibility="public"
  12785. deprecated="not deprecated">
  12786. </constructor>
  12787. <constructor name="ContainerNotFoundException" type="java.lang.String"
  12788. static="false" final="false" visibility="public"
  12789. deprecated="not deprecated">
  12790. </constructor>
  12791. <constructor name="ContainerNotFoundException" type="java.lang.String, java.lang.Throwable"
  12792. static="false" final="false" visibility="public"
  12793. deprecated="not deprecated">
  12794. </constructor>
  12795. <doc>
  12796. <![CDATA[This exception is thrown on
  12797. {@link ApplicationHistoryProtocol#getContainerReport (GetContainerReportRequest)}
  12798. API when the container doesn't exist in AHS]]>
  12799. </doc>
  12800. </class>
  12801. <!-- end class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
  12802. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidApplicationMasterRequestException -->
  12803. <class name="InvalidApplicationMasterRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12804. abstract="false"
  12805. static="false" final="false" visibility="public"
  12806. deprecated="not deprecated">
  12807. <constructor name="InvalidApplicationMasterRequestException" type="java.lang.Throwable"
  12808. static="false" final="false" visibility="public"
  12809. deprecated="not deprecated">
  12810. </constructor>
  12811. <constructor name="InvalidApplicationMasterRequestException" type="java.lang.String"
  12812. static="false" final="false" visibility="public"
  12813. deprecated="not deprecated">
  12814. </constructor>
  12815. <constructor name="InvalidApplicationMasterRequestException" type="java.lang.String, java.lang.Throwable"
  12816. static="false" final="false" visibility="public"
  12817. deprecated="not deprecated">
  12818. </constructor>
  12819. <doc>
  12820. <![CDATA[This exception is thrown when an ApplicationMaster asks for resources by
  12821. calling {@link ApplicationMasterProtocol#allocate(AllocateRequest)}
  12822. without first registering by calling
  12823. {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
  12824. or if it tries to register more than once.]]>
  12825. </doc>
  12826. </class>
  12827. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidApplicationMasterRequestException -->
  12828. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidAuxServiceException -->
  12829. <class name="InvalidAuxServiceException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12830. abstract="false"
  12831. static="false" final="false" visibility="public"
  12832. deprecated="not deprecated">
  12833. <constructor name="InvalidAuxServiceException" type="java.lang.String"
  12834. static="false" final="false" visibility="public"
  12835. deprecated="not deprecated">
  12836. </constructor>
  12837. <doc>
  12838. <![CDATA[This exception is thrown by a NodeManager that is rejecting start-container
  12839. requests via
  12840. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  12841. for auxservices does not exist.]]>
  12842. </doc>
  12843. </class>
  12844. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidAuxServiceException -->
  12845. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidContainerException -->
  12846. <class name="InvalidContainerException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12847. abstract="false"
  12848. static="false" final="false" visibility="public"
  12849. deprecated="not deprecated">
  12850. <constructor name="InvalidContainerException" type="java.lang.String"
  12851. static="false" final="false" visibility="public"
  12852. deprecated="not deprecated">
  12853. </constructor>
  12854. <doc>
  12855. <![CDATA[This exception is thrown by a NodeManager that is rejecting start-container
  12856. requests via
  12857. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  12858. for containers allocated by a previous instance of the RM.]]>
  12859. </doc>
  12860. </class>
  12861. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidContainerException -->
  12862. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidContainerReleaseException -->
  12863. <class name="InvalidContainerReleaseException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12864. abstract="false"
  12865. static="false" final="false" visibility="public"
  12866. deprecated="not deprecated">
  12867. <constructor name="InvalidContainerReleaseException" type="java.lang.Throwable"
  12868. static="false" final="false" visibility="public"
  12869. deprecated="not deprecated">
  12870. </constructor>
  12871. <constructor name="InvalidContainerReleaseException" type="java.lang.String"
  12872. static="false" final="false" visibility="public"
  12873. deprecated="not deprecated">
  12874. </constructor>
  12875. <constructor name="InvalidContainerReleaseException" type="java.lang.String, java.lang.Throwable"
  12876. static="false" final="false" visibility="public"
  12877. deprecated="not deprecated">
  12878. </constructor>
  12879. <doc>
  12880. <![CDATA[This exception is thrown when an Application Master tries to release
  12881. containers not belonging to it using
  12882. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API.]]>
  12883. </doc>
  12884. </class>
  12885. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidContainerReleaseException -->
  12886. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidResourceBlacklistRequestException -->
  12887. <class name="InvalidResourceBlacklistRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12888. abstract="false"
  12889. static="false" final="false" visibility="public"
  12890. deprecated="not deprecated">
  12891. <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.Throwable"
  12892. static="false" final="false" visibility="public"
  12893. deprecated="not deprecated">
  12894. </constructor>
  12895. <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.String"
  12896. static="false" final="false" visibility="public"
  12897. deprecated="not deprecated">
  12898. </constructor>
  12899. <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.String, java.lang.Throwable"
  12900. static="false" final="false" visibility="public"
  12901. deprecated="not deprecated">
  12902. </constructor>
  12903. <doc>
  12904. <![CDATA[This exception is thrown when an application provides an invalid
  12905. {@link ResourceBlacklistRequest} specification for blacklisting of resources
  12906. in {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API.
  12907. Currently this exceptions is thrown when an application tries to
  12908. blacklist {@link ResourceRequest#ANY}.]]>
  12909. </doc>
  12910. </class>
  12911. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidResourceBlacklistRequestException -->
  12912. <!-- start class org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException -->
  12913. <class name="InvalidResourceRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12914. abstract="false"
  12915. static="false" final="false" visibility="public"
  12916. deprecated="not deprecated">
  12917. <constructor name="InvalidResourceRequestException" type="java.lang.Throwable"
  12918. static="false" final="false" visibility="public"
  12919. deprecated="not deprecated">
  12920. </constructor>
  12921. <constructor name="InvalidResourceRequestException" type="java.lang.String"
  12922. static="false" final="false" visibility="public"
  12923. deprecated="not deprecated">
  12924. </constructor>
  12925. <constructor name="InvalidResourceRequestException" type="java.lang.String, java.lang.Throwable"
  12926. static="false" final="false" visibility="public"
  12927. deprecated="not deprecated">
  12928. </constructor>
  12929. <doc>
  12930. <![CDATA[This exception is thrown when a resource requested via
  12931. {@link ResourceRequest} in the
  12932. {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API is out of the
  12933. range of the configured lower and upper limits on resources.]]>
  12934. </doc>
  12935. </class>
  12936. <!-- end class org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException -->
  12937. <!-- start class org.apache.hadoop.yarn.exceptions.NMNotYetReadyException -->
  12938. <class name="NMNotYetReadyException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
  12939. abstract="false"
  12940. static="false" final="false" visibility="public"
  12941. deprecated="not deprecated">
  12942. <constructor name="NMNotYetReadyException" type="java.lang.String"
  12943. static="false" final="false" visibility="public"
  12944. deprecated="not deprecated">
  12945. </constructor>
  12946. <doc>
  12947. <![CDATA[This exception is thrown on
  12948. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)} API
  12949. when an NM starts from scratch but has not yet connected with RM.]]>
  12950. </doc>
  12951. </class>
  12952. <!-- end class org.apache.hadoop.yarn.exceptions.NMNotYetReadyException -->
  12953. <!-- start class org.apache.hadoop.yarn.exceptions.YarnException -->
  12954. <class name="YarnException" extends="java.lang.Exception"
  12955. abstract="false"
  12956. static="false" final="false" visibility="public"
  12957. deprecated="not deprecated">
  12958. <constructor name="YarnException"
  12959. static="false" final="false" visibility="public"
  12960. deprecated="not deprecated">
  12961. </constructor>
  12962. <constructor name="YarnException" type="java.lang.String"
  12963. static="false" final="false" visibility="public"
  12964. deprecated="not deprecated">
  12965. </constructor>
  12966. <constructor name="YarnException" type="java.lang.Throwable"
  12967. static="false" final="false" visibility="public"
  12968. deprecated="not deprecated">
  12969. </constructor>
  12970. <constructor name="YarnException" type="java.lang.String, java.lang.Throwable"
  12971. static="false" final="false" visibility="public"
  12972. deprecated="not deprecated">
  12973. </constructor>
  12974. <doc>
  12975. <![CDATA[YarnException indicates exceptions from yarn servers. On the other hand,
  12976. IOExceptions indicates exceptions from RPC layer.]]>
  12977. </doc>
  12978. </class>
  12979. <!-- end class org.apache.hadoop.yarn.exceptions.YarnException -->
  12980. </package>
  12981. <package name="org.apache.hadoop.yarn.server.api">
  12982. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  12983. <class name="ApplicationInitializationContext" extends="java.lang.Object"
  12984. abstract="false"
  12985. static="false" final="false" visibility="public"
  12986. deprecated="not deprecated">
  12987. <constructor name="ApplicationInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ApplicationId, java.nio.ByteBuffer"
  12988. static="false" final="false" visibility="public"
  12989. deprecated="not deprecated">
  12990. </constructor>
  12991. <method name="getUser" return="java.lang.String"
  12992. abstract="false" native="false" synchronized="false"
  12993. static="false" final="false" visibility="public"
  12994. deprecated="not deprecated">
  12995. <doc>
  12996. <![CDATA[Get the user-name of the application-submitter
  12997. @return user-name]]>
  12998. </doc>
  12999. </method>
  13000. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  13001. abstract="false" native="false" synchronized="false"
  13002. static="false" final="false" visibility="public"
  13003. deprecated="not deprecated">
  13004. <doc>
  13005. <![CDATA[Get {@link ApplicationId} of the application
  13006. @return applications ID]]>
  13007. </doc>
  13008. </method>
  13009. <method name="getApplicationDataForService" return="java.nio.ByteBuffer"
  13010. abstract="false" native="false" synchronized="false"
  13011. static="false" final="false" visibility="public"
  13012. deprecated="not deprecated">
  13013. <doc>
  13014. <![CDATA[Get the data sent to the NodeManager via
  13015. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  13016. as part of {@link ContainerLaunchContext#getServiceData()}
  13017. @return the servicesData for this application.]]>
  13018. </doc>
  13019. </method>
  13020. <doc>
  13021. <![CDATA[Initialization context for {@link AuxiliaryService} when starting an
  13022. application.]]>
  13023. </doc>
  13024. </class>
  13025. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
  13026. <!-- start class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  13027. <class name="ApplicationTerminationContext" extends="java.lang.Object"
  13028. abstract="false"
  13029. static="false" final="false" visibility="public"
  13030. deprecated="not deprecated">
  13031. <constructor name="ApplicationTerminationContext" type="org.apache.hadoop.yarn.api.records.ApplicationId"
  13032. static="false" final="false" visibility="public"
  13033. deprecated="not deprecated">
  13034. </constructor>
  13035. <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  13036. abstract="false" native="false" synchronized="false"
  13037. static="false" final="false" visibility="public"
  13038. deprecated="not deprecated">
  13039. <doc>
  13040. <![CDATA[Get {@link ApplicationId} of the application being stopped.
  13041. @return applications ID]]>
  13042. </doc>
  13043. </method>
  13044. <doc>
  13045. <![CDATA[Initialization context for {@link AuxiliaryService} when stopping an
  13046. application.]]>
  13047. </doc>
  13048. </class>
  13049. <!-- end class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
  13050. <!-- start class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  13051. <class name="AuxiliaryService" extends="org.apache.hadoop.service.AbstractService"
  13052. abstract="true"
  13053. static="false" final="false" visibility="public"
  13054. deprecated="not deprecated">
  13055. <constructor name="AuxiliaryService" type="java.lang.String"
  13056. static="false" final="false" visibility="protected"
  13057. deprecated="not deprecated">
  13058. </constructor>
  13059. <method name="getRecoveryPath" return="org.apache.hadoop.fs.Path"
  13060. abstract="false" native="false" synchronized="false"
  13061. static="false" final="false" visibility="protected"
  13062. deprecated="not deprecated">
  13063. <doc>
  13064. <![CDATA[Get the path specific to this auxiliary service to use for recovery.
  13065. @return state storage path or null if recovery is not enabled]]>
  13066. </doc>
  13067. </method>
  13068. <method name="initializeApplication"
  13069. abstract="true" native="false" synchronized="false"
  13070. static="false" final="false" visibility="public"
  13071. deprecated="not deprecated">
  13072. <param name="initAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationInitializationContext"/>
  13073. <doc>
  13074. <![CDATA[A new application is started on this NodeManager. This is a signal to
  13075. this {@link AuxiliaryService} about the application initialization.
  13076. @param initAppContext context for the application's initialization]]>
  13077. </doc>
  13078. </method>
  13079. <method name="stopApplication"
  13080. abstract="true" native="false" synchronized="false"
  13081. static="false" final="false" visibility="public"
  13082. deprecated="not deprecated">
  13083. <param name="stopAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationTerminationContext"/>
  13084. <doc>
  13085. <![CDATA[An application is finishing on this NodeManager. This is a signal to this
  13086. {@link AuxiliaryService} about the same.
  13087. @param stopAppContext context for the application termination]]>
  13088. </doc>
  13089. </method>
  13090. <method name="getMetaData" return="java.nio.ByteBuffer"
  13091. abstract="true" native="false" synchronized="false"
  13092. static="false" final="false" visibility="public"
  13093. deprecated="not deprecated">
  13094. <doc>
  13095. <![CDATA[Retrieve meta-data for this {@link AuxiliaryService}. Applications using
  13096. this {@link AuxiliaryService} SHOULD know the format of the meta-data -
  13097. ideally each service should provide a method to parse out the information
  13098. to the applications. One example of meta-data is contact information so
  13099. that applications can access the service remotely. This will only be called
  13100. after the service's {@link #start()} method has finished. the result may be
  13101. cached.
  13102. <p>
  13103. The information is passed along to applications via
  13104. {@link StartContainersResponse#getAllServicesMetaData()} that is returned by
  13105. {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
  13106. </p>
  13107. @return meta-data for this service that should be made available to
  13108. applications.]]>
  13109. </doc>
  13110. </method>
  13111. <method name="initializeContainer"
  13112. abstract="false" native="false" synchronized="false"
  13113. static="false" final="false" visibility="public"
  13114. deprecated="not deprecated">
  13115. <param name="initContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerInitializationContext"/>
  13116. <doc>
  13117. <![CDATA[A new container is started on this NodeManager. This is a signal to
  13118. this {@link AuxiliaryService} about the container initialization.
  13119. This method is called when the NodeManager receives the container launch
  13120. command from the ApplicationMaster and before the container process is
  13121. launched.
  13122. @param initContainerContext context for the container's initialization]]>
  13123. </doc>
  13124. </method>
  13125. <method name="stopContainer"
  13126. abstract="false" native="false" synchronized="false"
  13127. static="false" final="false" visibility="public"
  13128. deprecated="not deprecated">
  13129. <param name="stopContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerTerminationContext"/>
  13130. <doc>
  13131. <![CDATA[A container is finishing on this NodeManager. This is a signal to this
  13132. {@link AuxiliaryService} about the same.
  13133. @param stopContainerContext context for the container termination]]>
  13134. </doc>
  13135. </method>
  13136. <method name="setRecoveryPath"
  13137. abstract="false" native="false" synchronized="false"
  13138. static="false" final="false" visibility="public"
  13139. deprecated="not deprecated">
  13140. <param name="recoveryPath" type="org.apache.hadoop.fs.Path"/>
  13141. <doc>
  13142. <![CDATA[Set the path for this auxiliary service to use for storing state
  13143. that will be used during recovery.
  13144. @param recoveryPath where recoverable state should be stored]]>
  13145. </doc>
  13146. </method>
  13147. <doc>
  13148. <![CDATA[A generic service that will be started by the NodeManager. This is a service
  13149. that administrators have to configure on each node by setting
  13150. {@link YarnConfiguration#NM_AUX_SERVICES}.]]>
  13151. </doc>
  13152. </class>
  13153. <!-- end class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
  13154. <!-- start class org.apache.hadoop.yarn.server.api.ContainerContext -->
  13155. <class name="ContainerContext" extends="java.lang.Object"
  13156. abstract="false"
  13157. static="false" final="false" visibility="public"
  13158. deprecated="not deprecated">
  13159. <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  13160. static="false" final="false" visibility="public"
  13161. deprecated="not deprecated">
  13162. </constructor>
  13163. <method name="getUser" return="java.lang.String"
  13164. abstract="false" native="false" synchronized="false"
  13165. static="false" final="false" visibility="public"
  13166. deprecated="not deprecated">
  13167. <doc>
  13168. <![CDATA[Get user of the container being initialized or stopped.
  13169. @return the user]]>
  13170. </doc>
  13171. </method>
  13172. <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  13173. abstract="false" native="false" synchronized="false"
  13174. static="false" final="false" visibility="public"
  13175. deprecated="not deprecated">
  13176. <doc>
  13177. <![CDATA[Get {@link ContainerId} of the container being initialized or stopped.
  13178. @return the container ID]]>
  13179. </doc>
  13180. </method>
  13181. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  13182. abstract="false" native="false" synchronized="false"
  13183. static="false" final="false" visibility="public"
  13184. deprecated="not deprecated">
  13185. <doc>
  13186. <![CDATA[Get {@link Resource} the resource capability allocated to the container
  13187. being initialized or stopped.
  13188. @return the resource capability.]]>
  13189. </doc>
  13190. </method>
  13191. <doc>
  13192. <![CDATA[Base context class for {@link AuxiliaryService} initializing and stopping a
  13193. container.]]>
  13194. </doc>
  13195. </class>
  13196. <!-- end class org.apache.hadoop.yarn.server.api.ContainerContext -->
  13197. <!-- start class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  13198. <class name="ContainerInitializationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  13199. abstract="false"
  13200. static="false" final="false" visibility="public"
  13201. deprecated="not deprecated">
  13202. <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  13203. static="false" final="false" visibility="public"
  13204. deprecated="not deprecated">
  13205. </constructor>
  13206. <doc>
  13207. <![CDATA[Initialization context for {@link AuxiliaryService} when starting a
  13208. container.]]>
  13209. </doc>
  13210. </class>
  13211. <!-- end class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
  13212. <!-- start class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  13213. <class name="ContainerTerminationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
  13214. abstract="false"
  13215. static="false" final="false" visibility="public"
  13216. deprecated="not deprecated">
  13217. <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
  13218. static="false" final="false" visibility="public"
  13219. deprecated="not deprecated">
  13220. </constructor>
  13221. <doc>
  13222. <![CDATA[Termination context for {@link AuxiliaryService} when stopping a
  13223. container.]]>
  13224. </doc>
  13225. </class>
  13226. <!-- end class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
  13227. <!-- start interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  13228. <interface name="SCMAdminProtocol" abstract="true"
  13229. static="false" final="false" visibility="public"
  13230. deprecated="not deprecated">
  13231. <method name="runCleanerTask" return="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskResponse"
  13232. abstract="false" native="false" synchronized="false"
  13233. static="false" final="false" visibility="public"
  13234. deprecated="not deprecated">
  13235. <param name="request" type="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskRequest"/>
  13236. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  13237. <exception name="IOException" type="java.io.IOException"/>
  13238. <doc>
  13239. <![CDATA[<p>
  13240. The method used by administrators to ask SCM to run cleaner task right away
  13241. </p>
  13242. @param request request <code>SharedCacheManager</code> to run a cleaner task
  13243. @return <code>SharedCacheManager</code> returns an empty response
  13244. on success and throws an exception on rejecting the request
  13245. @throws YarnException
  13246. @throws IOException]]>
  13247. </doc>
  13248. </method>
  13249. <doc>
  13250. <![CDATA[<p>
  13251. The protocol between administrators and the <code>SharedCacheManager</code>
  13252. </p>]]>
  13253. </doc>
  13254. </interface>
  13255. <!-- end interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
  13256. </package>
  13257. <package name="org.apache.hadoop.yarn.util">
  13258. </package>
  13259. </api>