123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692 |
- <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
- <!-- Generated by the JDiff Javadoc doclet -->
- <!-- (http://www.jdiff.org) -->
- <!-- on Thu May 12 17:47:18 PDT 2016 -->
- <api
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:noNamespaceSchemaLocation='api.xsd'
- name="hadoop-yarn-api 2.7.2"
- jdversion="1.0.9">
- <!-- 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 -->
- <package name="org.apache.hadoop.yarn.api">
- <!-- start interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
- <interface name="ApplicationClientProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
- <method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to obtain a new {@link ApplicationId} for
- submitting new applications.</p>
- <p>The <code>ResourceManager</code> responds with a new, monotonically
- increasing, {@link ApplicationId} which is used by the client to submit
- a new application.</p>
- <p>The <code>ResourceManager</code> also responds with details such
- as maximum resource capabilities in the cluster as specified in
- {@link GetNewApplicationResponse}.</p>
- @param request request to get a new <code>ApplicationId</code>
- @return response containing the new <code>ApplicationId</code> to be used
- to submit an application
- @throws YarnException
- @throws IOException
- @see #submitApplication(SubmitApplicationRequest)]]>
- </doc>
- </method>
- <method name="submitApplication" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to submit a new application to the
- <code>ResourceManager.</code></p>
- <p>The client is required to provide details such as queue,
- {@link Resource} required to run the <code>ApplicationMaster</code>,
- the equivalent of {@link ContainerLaunchContext} for launching
- the <code>ApplicationMaster</code> etc. via the
- {@link SubmitApplicationRequest}.</p>
- <p>Currently the <code>ResourceManager</code> sends an immediate (empty)
- {@link SubmitApplicationResponse} on accepting the submission and throws
- an exception if it rejects the submission. However, this call needs to be
- followed by {@link #getApplicationReport(GetApplicationReportRequest)}
- to make sure that the application gets properly submitted - obtaining a
- {@link SubmitApplicationResponse} from ResourceManager doesn't guarantee
- that RM 'remembers' this application beyond failover or restart. If RM
- failover or RM restart happens before ResourceManager saves the
- application's state successfully, the subsequent
- {@link #getApplicationReport(GetApplicationReportRequest)} will throw
- a {@link ApplicationNotFoundException}. The Clients need to re-submit
- the application with the same {@link ApplicationSubmissionContext} when
- it encounters the {@link ApplicationNotFoundException} on the
- {@link #getApplicationReport(GetApplicationReportRequest)} call.</p>
- <p>During the submission process, it checks whether the application
- already exists. If the application exists, it will simply return
- SubmitApplicationResponse</p>
- <p> In secure mode,the <code>ResourceManager</code> verifies access to
- queues etc. before accepting the application submission.</p>
- @param request request to submit a new application
- @return (empty) response on accepting the submission
- @throws YarnException
- @throws IOException
- @see #getNewApplication(GetNewApplicationRequest)]]>
- </doc>
- </method>
- <method name="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to request the
- <code>ResourceManager</code> to abort submitted application.</p>
- <p>The client, via {@link KillApplicationRequest} provides the
- {@link ApplicationId} of the application to be aborted.</p>
- <p> In secure mode,the <code>ResourceManager</code> verifies access to the
- application, queue etc. before terminating the application.</p>
- <p>Currently, the <code>ResourceManager</code> returns an empty response
- on success and throws an exception on rejecting the request.</p>
- @param request request to abort a submitted application
- @return <code>ResourceManager</code> returns an empty response
- on success and throws an exception on rejecting the request
- @throws YarnException
- @throws IOException
- @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
- </doc>
- </method>
- <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get metrics about the cluster from
- the <code>ResourceManager</code>.</p>
- <p>The <code>ResourceManager</code> responds with a
- {@link GetClusterMetricsResponse} which includes the
- {@link YarnClusterMetrics} with details such as number of current
- nodes in the cluster.</p>
- @param request request for cluster metrics
- @return cluster metrics
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get a report of all nodes
- in the cluster from the <code>ResourceManager</code>.</p>
- <p>The <code>ResourceManager</code> responds with a
- {@link GetClusterNodesResponse} which includes the
- {@link NodeReport} for all the nodes in the cluster.</p>
- @param request request for report on all nodes
- @return report on all nodes
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get information about <em>queues</em>
- from the <code>ResourceManager</code>.</p>
- <p>The client, via {@link GetQueueInfoRequest}, can ask for details such
- as used/total resources, child queues, running applications etc.</p>
- <p> In secure mode,the <code>ResourceManager</code> verifies access before
- providing the information.</p>
- @param request request to get queue information
- @return queue information
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getQueueUserAcls" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get information about <em>queue
- acls</em> for <em>current user</em> from the <code>ResourceManager</code>.
- </p>
- <p>The <code>ResourceManager</code> responds with queue acls for all
- existing queues.</p>
- @param request request to get queue acls for <em>current user</em>
- @return queue acls for <em>current user</em>
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move an application to a new queue.
- @param request the application ID and the target queue
- @return an empty response
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to submit a new reservation to the
- {@code ResourceManager}.
- </p>
- <p>
- The client packages all details of its request in a
- {@link ReservationSubmissionRequest} object. This contains information
- about the amount of capacity, temporal constraints, and concurrency needs.
- Furthermore, the reservation might be composed of multiple stages, with
- ordering dependencies among them.
- </p>
- <p>
- In order to respond, a new admission control component in the
- {@code ResourceManager} performs an analysis of the resources that have
- been committed over the period of time the user is requesting, verify that
- the user requests can be fulfilled, and that it respect a sharing policy
- (e.g., {@code CapacityOverTimePolicy}). Once it has positively determined
- that the ReservationSubmissionRequest is satisfiable the
- {@code ResourceManager} answers with a
- {@link ReservationSubmissionResponse} that include a non-null
- {@link ReservationId}. Upon failure to find a valid allocation the response
- is an exception with the reason.
- On application submission the client can use this {@link ReservationId} to
- obtain access to the reserved resources.
- </p>
- <p>
- The system guarantees that during the time-range specified by the user, the
- reservationID will be corresponding to a valid reservation. The amount of
- capacity dedicated to such queue can vary overtime, depending of the
- allocation that has been determined. But it is guaranteed to satisfy all
- the constraint expressed by the user in the
- {@link ReservationSubmissionRequest}.
- </p>
- @param request the request to submit a new Reservation
- @return response the {@link ReservationId} on accepting the submission
- @throws YarnException if the request is invalid or reservation cannot be
- created successfully
- @throws IOException]]>
- </doc>
- </method>
- <method name="updateReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to update an existing Reservation. This is
- referred to as a re-negotiation process, in which a user that has
- previously submitted a Reservation.
- </p>
- <p>
- The allocation is attempted by virtually substituting all previous
- allocations related to this Reservation with new ones, that satisfy the new
- {@link ReservationUpdateRequest}. Upon success the previous allocation is
- substituted by the new one, and on failure (i.e., if the system cannot find
- a valid allocation for the updated request), the previous allocation
- remains valid.
- The {@link ReservationId} is not changed, and applications currently
- running within this reservation will automatically receive the resources
- based on the new allocation.
- </p>
- @param request to update an existing Reservation (the ReservationRequest
- should refer to an existing valid {@link ReservationId})
- @return response empty on successfully updating the existing reservation
- @throws YarnException if the request is invalid or reservation cannot be
- updated successfully
- @throws IOException]]>
- </doc>
- </method>
- <method name="deleteReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to remove an existing Reservation.
- Upon deletion of a reservation applications running with this reservation,
- are automatically downgraded to normal jobs running without any dedicated
- reservation.
- </p>
- @param request to remove an existing Reservation (the ReservationRequest
- should refer to an existing valid {@link ReservationId})
- @return response empty on successfully deleting the existing reservation
- @throws YarnException if the request is invalid or reservation cannot be
- deleted successfully
- @throws IOException]]>
- </doc>
- </method>
- <method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by client to get node to labels mappings in existing cluster
- </p>
- @param request
- @return node to labels mappings
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getLabelsToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by client to get labels to nodes mappings
- in existing cluster
- </p>
- @param request
- @return labels to nodes mappings
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by client to get node labels in the cluster
- </p>
- @param request to get node labels collection of this cluster
- @return node labels collection of this cluster
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The protocol between clients and the <code>ResourceManager</code>
- to submit/abort jobs and to get information on applications, cluster metrics,
- nodes, queues and ACLs.</p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
- <!-- start interface org.apache.hadoop.yarn.api.ApplicationConstants -->
- <interface name="ApplicationConstants" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="APP_SUBMIT_TIME_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment
- only]]>
- </doc>
- </field>
- <field name="CONTAINER_TOKEN_FILE_ENV_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The cache file into which container token is written]]>
- </doc>
- </field>
- <field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
- ApplicationMaster's environment only. This states that for all non-relative
- web URLs in the app masters web UI what base should they have.]]>
- </doc>
- </field>
- <field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The temporary environmental variable for container log directory. This
- should be replaced by real container log directory on container launch.]]>
- </doc>
- </field>
- <field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is used to construct class path and it will be replaced with
- real class path separator(':' for Linux and ';' for Windows) by
- NodeManager on container launch. User has to use this constant to construct
- class path if user wants cross-platform practice i.e. submit an application
- from a Windows client to a Linux/Unix server or vice versa.]]>
- </doc>
- </field>
- <field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The following two constants are used to expand parameter and it will be
- replaced with real parameter expansion marker ('%' for Windows and '$' for
- Linux) by NodeManager on container launch. For example: {{VAR}} will be
- replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
- constant to construct class path if user wants cross-platform practice i.e.
- submit an application from a Windows client to a Linux/Unix server or vice
- versa.]]>
- </doc>
- </field>
- <field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[User has to use this constant to construct class path if user wants
- cross-platform practice i.e. submit an application from a Windows client to
- a Linux/Unix server or vice versa.]]>
- </doc>
- </field>
- <field name="STDERR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STDOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAX_APP_ATTEMPTS_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The environment variable for MAX_APP_ATTEMPTS. Set in AppMaster environment
- only]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This is the API for the applications comprising of constants that YARN sets
- up for the applications and the containers.
- TODO: Investigate the semantics and security of each cross-boundary refs.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
- <!-- start class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
- <class name="ApplicationConstants.Environment" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="key" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="$" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Expand the environment variable based on client OS environment variable
- expansion syntax (e.g. $VAR for Linux and %VAR% for Windows).
- <p>
- Note: Use $$() method for cross-platform practice i.e. submit an
- application from a Windows client to a Linux/Unix server or vice versa.
- </p>]]>
- </doc>
- </method>
- <method name="$$" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Expand the environment variable in platform-agnostic syntax. The
- parameter expansion marker "{{VAR}}" will be replaced with real parameter
- expansion marker ('%' for Windows and '$' for Linux) by NodeManager on
- container launch. For example: {{VAR}} will be replaced as $VAR on Linux,
- and %VAR% on Windows.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Environment for Applications.
- Some of the environment variables for applications are <em>final</em>
- i.e. they cannot be modified by the applications.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
- <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
- <interface name="ApplicationHistoryProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
- <doc>
- <![CDATA[<p>
- The protocol between clients and the <code>ApplicationHistoryServer</code> to
- get the information of completed applications etc.
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
- <!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
- <interface name="ApplicationMasterProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by a new <code>ApplicationMaster</code> to register with
- the <code>ResourceManager</code>.
- </p>
- <p>
- The <code>ApplicationMaster</code> needs to provide details such as RPC
- Port, HTTP tracking url etc. as specified in
- {@link RegisterApplicationMasterRequest}.
- </p>
- <p>
- The <code>ResourceManager</code> responds with critical details such as
- maximum resource capabilities in the cluster as specified in
- {@link RegisterApplicationMasterResponse}.
- </p>
- @param request
- registration request
- @return registration respose
- @throws YarnException
- @throws IOException
- @throws InvalidApplicationMasterRequestException
- The exception is thrown when an ApplicationMaster tries to
- register more then once.
- @see RegisterApplicationMasterRequest
- @see RegisterApplicationMasterResponse]]>
- </doc>
- </method>
- <method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
- <code>ResourceManager</code> about its completion (success or failed).</p>
- <p>The <code>ApplicationMaster</code> has to provide details such as
- final state, diagnostics (in case of failures) etc. as specified in
- {@link FinishApplicationMasterRequest}.</p>
- <p>The <code>ResourceManager</code> responds with
- {@link FinishApplicationMasterResponse}.</p>
- @param request completion request
- @return completion response
- @throws YarnException
- @throws IOException
- @see FinishApplicationMasterRequest
- @see FinishApplicationMasterResponse]]>
- </doc>
- </method>
- <method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The main interface between an <code>ApplicationMaster</code> and the
- <code>ResourceManager</code>.
- </p>
- <p>
- The <code>ApplicationMaster</code> uses this interface to provide a list of
- {@link ResourceRequest} and returns unused {@link Container} allocated to
- it via {@link AllocateRequest}. Optionally, the
- <code>ApplicationMaster</code> can also <em>blacklist</em> resources which
- it doesn't want to use.
- </p>
- <p>
- This also doubles up as a <em>heartbeat</em> to let the
- <code>ResourceManager</code> know that the <code>ApplicationMaster</code>
- is alive. Thus, applications should periodically make this call to be kept
- alive. The frequency depends on
- {@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
- {@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
- </p>
- <p>
- The <code>ResourceManager</code> responds with list of allocated
- {@link Container}, status of completed containers and headroom information
- for the application.
- </p>
- <p>
- The <code>ApplicationMaster</code> can use the available headroom
- (resources) to decide how to utilized allocated resources and make informed
- decisions about future resource requests.
- </p>
- @param request
- allocation request
- @return allocation response
- @throws YarnException
- @throws IOException
- @throws InvalidApplicationMasterRequestException
- This exception is thrown when an ApplicationMaster calls allocate
- without registering first.
- @throws InvalidResourceBlacklistRequestException
- This exception is thrown when an application provides an invalid
- specification for blacklist of resources.
- @throws InvalidResourceRequestException
- This exception is thrown when a {@link ResourceRequest} is out of
- the range of the configured lower and upper limits on the
- resources.
- @see AllocateRequest
- @see AllocateResponse]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
- and the <code>ResourceManager</code>.</p>
- <p>This is used by the <code>ApplicationMaster</code> to register/unregister
- and to request and obtain resources in the cluster from the
- <code>ResourceManager</code>.</p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
- <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
- <interface name="ClientSCMProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="use" return="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to claim a resource with the
- <code>SharedCacheManager.</code> The client uses a checksum to identify the
- resource and an {@link ApplicationId} to identify which application will be
- using the resource.
- </p>
- <p>
- The <code>SharedCacheManager</code> responds with whether or not the
- resource exists in the cache. If the resource exists, a <code>Path</code>
- to the resource in the shared cache is returned. If the resource does not
- exist, the response is empty.
- </p>
- @param request request to claim a resource in the shared cache
- @return response indicating if the resource is already in the cache
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="release" return="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to release a resource with the
- <code>SharedCacheManager.</code> This method is called once an application
- is no longer using a claimed resource in the shared cache. The client uses
- a checksum to identify the resource and an {@link ApplicationId} to
- identify which application is releasing the resource.
- </p>
- <p>
- Note: This method is an optimization and the client is not required to call
- it for correctness.
- </p>
- <p>
- Currently the <code>SharedCacheManager</code> sends an empty response.
- </p>
- @param request request to release a resource in the shared cache
- @return (empty) response on releasing the resource
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The protocol between clients and the <code>SharedCacheManager</code> to claim
- and release resources in the shared cache.
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
- <!-- start interface org.apache.hadoop.yarn.api.ClientSCMProtocolPB -->
- <interface name="ClientSCMProtocolPB" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.yarn.proto.ClientSCMProtocol.ClientSCMProtocolService.BlockingInterface"/>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocolPB -->
- <!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
- <interface name="ContainerManagementProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The <code>ApplicationMaster</code> provides a list of
- {@link StartContainerRequest}s to a <code>NodeManager</code> to
- <em>start</em> {@link Container}s allocated to it using this interface.
- </p>
- <p>
- The <code>ApplicationMaster</code> has to provide details such as allocated
- resource capability, security tokens (if enabled), command to be executed
- to start the container, environment for the process, necessary
- binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
- the {@link StartContainerRequest}.
- </p>
- <p>
- The <code>NodeManager</code> sends a response via
- {@link StartContainersResponse} which includes a list of
- {@link Container}s of successfully launched {@link Container}s, a
- containerId-to-exception map for each failed {@link StartContainerRequest} in
- which the exception indicates errors from per container and a
- allServicesMetaData map between the names of auxiliary services and their
- corresponding meta-data. Note: None-container-specific exceptions will
- still be thrown by the API method itself.
- </p>
- <p>
- The <code>ApplicationMaster</code> can use
- {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
- statuses of the to-be-launched or launched containers.
- </p>
- @param request
- request to start a list of containers
- @return response including conatinerIds of all successfully launched
- containers, a containerId-to-exception map for failed requests and
- a allServicesMetaData map.
- @throws YarnException
- @throws IOException
- @throws NMNotYetReadyException
- This exception is thrown when NM starts from scratch but has not
- yet connected with RM.]]>
- </doc>
- </method>
- <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
- <em>stop</em> a list of {@link Container}s allocated to it using this
- interface.
- </p>
- <p>
- The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
- which includes the {@link ContainerId}s of the containers to be stopped.
- </p>
- <p>
- The <code>NodeManager</code> sends a response via
- {@link StopContainersResponse} which includes a list of {@link ContainerId}
- s of successfully stopped containers, a containerId-to-exception map for
- each failed request in which the exception indicates errors from per
- container. Note: None-container-specific exceptions will still be thrown by
- the API method itself. <code>ApplicationMaster</code> can use
- {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
- statuses of the containers.
- </p>
- @param request
- request to stop a list of containers
- @return response which includes a list of containerIds of successfully
- stopped containers, a containerId-to-exception map for failed
- requests.
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The API used by the <code>ApplicationMaster</code> to request for current
- statuses of <code>Container</code>s from the <code>NodeManager</code>.
- </p>
- <p>
- The <code>ApplicationMaster</code> sends a
- {@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
- of all containers whose statuses are needed.
- </p>
- <p>
- The <code>NodeManager</code> responds with
- {@link GetContainerStatusesResponse} which includes a list of
- {@link ContainerStatus} of the successfully queried containers and a
- containerId-to-exception map for each failed request in which the exception
- indicates errors from per container. Note: None-container-specific
- exceptions will still be thrown by the API method itself.
- </p>
- @param request
- request to get <code>ContainerStatus</code>es of containers with
- the specified <code>ContainerId</code>s
- @return response containing the list of <code>ContainerStatus</code> of the
- successfully queried containers and a containerId-to-exception map
- for failed requests.
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
- <code>NodeManager</code> to start/stop containers and to get status
- of running containers.</p>
- <p>If security is enabled the <code>NodeManager</code> verifies that the
- <code>ApplicationMaster</code> has truly been allocated the container
- by the <code>ResourceManager</code> and also verifies all interactions such
- as stopping the container or obtaining status information for the container.
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
- </package>
- <package name="org.apache.hadoop.yarn.api.protocolrecords">
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
- <class name="AllocateRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AllocateRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="responseID" type="int"/>
- <param name="appProgress" type="float"/>
- <param name="resourceAsk" type="java.util.List"/>
- <param name="containersToBeReleased" type="java.util.List"/>
- <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="responseID" type="int"/>
- <param name="appProgress" type="float"/>
- <param name="resourceAsk" type="java.util.List"/>
- <param name="containersToBeReleased" type="java.util.List"/>
- <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
- <param name="increaseRequests" type="java.util.List"/>
- </method>
- <method name="getResponseId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>response id</em> used to track duplicate responses.
- @return <em>response id</em>]]>
- </doc>
- </method>
- <method name="setResponseId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="int"/>
- <doc>
- <![CDATA[Set the <em>response id</em> used to track duplicate responses.
- @param id <em>response id</em>]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>current progress</em> of application.
- @return <em>current progress</em> of application]]>
- </doc>
- </method>
- <method name="setProgress"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="progress" type="float"/>
- <doc>
- <![CDATA[Set the <em>current progress</em> of application
- @param progress <em>current progress</em> of application]]>
- </doc>
- </method>
- <method name="getAskList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>ResourceRequest</code> to update the
- <code>ResourceManager</code> about the application's resource requirements.
- @return the list of <code>ResourceRequest</code>
- @see ResourceRequest]]>
- </doc>
- </method>
- <method name="setAskList"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceRequests" type="java.util.List"/>
- <doc>
- <![CDATA[Set list of <code>ResourceRequest</code> to update the
- <code>ResourceManager</code> about the application's resource requirements.
- @param resourceRequests list of <code>ResourceRequest</code> to update the
- <code>ResourceManager</code> about the application's
- resource requirements
- @see ResourceRequest]]>
- </doc>
- </method>
- <method name="getReleaseList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>ContainerId</code> of containers being
- released by the <code>ApplicationMaster</code>.
- @return list of <code>ContainerId</code> of containers being
- released by the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setReleaseList"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="releaseContainers" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list of <code>ContainerId</code> of containers being
- released by the <code>ApplicationMaster</code>
- @param releaseContainers list of <code>ContainerId</code> of
- containers being released by the
- <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
- <code>ApplicationMaster</code>.
- @return the <code>ResourceBlacklistRequest</code> being sent by the
- <code>ApplicationMaster</code>
- @see ResourceBlacklistRequest]]>
- </doc>
- </method>
- <method name="setResourceBlacklistRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
- <doc>
- <![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
- <code>ResourceManager</code> about the blacklist additions and removals
- per the <code>ApplicationMaster</code>.
- @param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
- to inform the <code>ResourceManager</code> about
- the blacklist additions and removals
- per the <code>ApplicationMaster</code>
- @see ResourceBlacklistRequest]]>
- </doc>
- </method>
- <method name="getIncreaseRequests" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerResourceIncreaseRequest</code> being sent by the
- <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setIncreaseRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="increaseRequests" type="java.util.List"/>
- <doc>
- <![CDATA[Set the <code>ContainerResourceIncreaseRequest</code> to inform the
- <code>ResourceManager</code> about some container's resources need to be
- increased]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
- <code>ResourceManager</code> to obtain resources in the cluster.</p>
- <p>The request includes:
- <ul>
- <li>A response id to track duplicate responses.</li>
- <li>Progress information.</li>
- <li>
- A list of {@link ResourceRequest} to inform the
- <code>ResourceManager</code> about the application's
- resource requirements.
- </li>
- <li>
- A list of unused {@link Container} which are being returned.
- </li>
- </ul>
- @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
- <class name="AllocateResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AllocateResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="responseId" type="int"/>
- <param name="completedContainers" type="java.util.List"/>
- <param name="allocatedContainers" type="java.util.List"/>
- <param name="updatedNodes" type="java.util.List"/>
- <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
- <param name="numClusterNodes" type="int"/>
- <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
- <param name="nmTokens" type="java.util.List"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="responseId" type="int"/>
- <param name="completedContainers" type="java.util.List"/>
- <param name="allocatedContainers" type="java.util.List"/>
- <param name="updatedNodes" type="java.util.List"/>
- <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
- <param name="numClusterNodes" type="int"/>
- <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
- <param name="nmTokens" type="java.util.List"/>
- <param name="increasedContainers" type="java.util.List"/>
- <param name="decreasedContainers" type="java.util.List"/>
- </method>
- <method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If the <code>ResourceManager</code> needs the
- <code>ApplicationMaster</code> to take some action then it will send an
- AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
- for details on commands and actions for them.
- @return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
- take action, <code>null</code> otherwise
- @see AMCommand]]>
- </doc>
- </method>
- <method name="getResponseId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>last response id</em>.
- @return <em>last response id</em>]]>
- </doc>
- </method>
- <method name="getAllocatedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
- <code>ResourceManager</code>.
- @return list of <em>newly allocated</em> <code>Container</code>]]>
- </doc>
- </method>
- <method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
- application.
- @return limit of available headroom for resources in the cluster for the
- application]]>
- </doc>
- </method>
- <method name="getCompletedContainersStatuses" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <em>completed containers' statuses</em>.
- @return the list of <em>completed containers' statuses</em>]]>
- </doc>
- </method>
- <method name="getUpdatedNodes" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
- be changes in health, availability etc of the nodes.
- @return The delta of updated nodes since the last response]]>
- </doc>
- </method>
- <method name="getNumClusterNodes" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of hosts available on the cluster.
- @return the available host count.]]>
- </doc>
- </method>
- <method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the description of containers owned by the AM, but requested back by
- the cluster. Note that the RM may have an inconsistent view of the
- resources owned by the AM. These messages are advisory, and the AM may
- elect to ignore them.
- <p>
- The message is a snapshot of the resources the RM wants back from the AM.
- While demand persists, the RM will repeat its request; applications should
- not interpret each message as a request for <em>additional</em>
- resources on top of previous messages. Resources requested consistently
- over some duration may be forcibly killed by the RM.
- @return A specification of the resources to reclaim from this AM.]]>
- </doc>
- </method>
- <method name="getNMTokens" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of NMTokens required for communicating with NM. New NMTokens
- issued only if
- <p>
- 1) AM is receiving first container on underlying NodeManager.<br>
- OR<br>
- 2) NMToken master key rolled over in ResourceManager and AM is getting new
- container on the same underlying NodeManager.
- <p>
- AM will receive one NMToken per NM irrespective of the number of containers
- issued on same NM. AM is expected to store these tokens until issued a
- new token for the same NM.]]>
- </doc>
- </method>
- <method name="getIncreasedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of newly increased containers by <code>ResourceManager</code>]]>
- </doc>
- </method>
- <method name="getDecreasedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of newly decreased containers by <code>NodeManager</code>]]>
- </doc>
- </method>
- <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The AMRMToken that belong to this attempt
- @return The AMRMToken that belong to this attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the <code>ResourceManager</code> the
- <code>ApplicationMaster</code> during resource negotiation.
- <p>
- The response, includes:
- <ul>
- <li>Response ID to track duplicate responses.</li>
- <li>
- An AMCommand sent by ResourceManager to let the
- {@code ApplicationMaster} take some actions (resync, shutdown etc.).
- </li>
- <li>A list of newly allocated {@link Container}.</li>
- <li>A list of completed {@link Container}s' statuses.</li>
- <li>
- The available headroom for resources in the cluster for the
- application.
- </li>
- <li>A list of nodes whose status has been updated.</li>
- <li>The number of available nodes in a cluster.</li>
- <li>A description of resources requested back by the cluster</li>
- <li>AMRMToken, if AMRMToken has been rolled over</li>
- </ul>
- @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
- <class name="ApplicationsRequestScope" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration that controls the scope of applications fetched]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
- <class name="FinishApplicationMasterRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FinishApplicationMasterRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
- <param name="diagnostics" type="java.lang.String"/>
- <param name="url" type="java.lang.String"/>
- </method>
- <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
- @return <em>final state</em> of the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setFinalApplicationStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
- <doc>
- <![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
- @param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getDiagnostics" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>diagnostic information</em> on application failure.
- @return <em>diagnostic information</em> on application failure]]>
- </doc>
- </method>
- <method name="setDiagnostics"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="diagnostics" type="java.lang.String"/>
- <doc>
- <![CDATA[Set <em>diagnostic information</em> on application failure.
- @param diagnostics <em>diagnostic information</em> on application failure]]>
- </doc>
- </method>
- <method name="getTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
- This url if contains scheme then that will be used by resource manager
- web application proxy otherwise it will default to http.
- @return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setTrackingUrl"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
- This is the web-URL to which ResourceManager or web-application proxy will
- redirect client/users once the application is finished and the
- <code>ApplicationMaster</code> is gone.
- <p>
- If the passed url has a scheme then that will be used by the
- ResourceManager and web-application proxy, otherwise the scheme will
- default to http.
- </p>
- <p>
- Empty, null, "N/A" strings are all valid besides a real URL. In case an url
- isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
- <p>
- @param url
- <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The finalization request sent by the {@code ApplicationMaster} to
- inform the {@code ResourceManager} about its completion.
- <p>
- The final request includes details such:
- <ul>
- <li>Final state of the {@code ApplicationMaster}</li>
- <li>
- Diagnostic information in case of failure of the
- {@code ApplicationMaster}
- </li>
- <li>Tracking URL</li>
- </ul>
- @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
- <class name="FinishApplicationMasterResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FinishApplicationMasterResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getIsUnregistered" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the flag which indicates that the application has successfully
- unregistered with the RM and the application can safely stop.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the <code>ResourceManager</code> to a
- <code>ApplicationMaster</code> on it's completion.
- <p>
- The response, includes:
- <ul>
- <li>A flag which indicates that the application has successfully unregistered
- with the RM and the application can safely stop.</li>
- </ul>
- <p>
- Note: The flag indicates whether the application has successfully
- unregistered and is safe to stop. The application may stop after the flag is
- true. If the application stops before the flag is true then the RM may retry
- the application.
- @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
- <class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationAttemptReportRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- </method>
- <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
- @return <code>ApplicationAttemptId</code> of an application attempt]]>
- </doc>
- </method>
- <method name="setApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
- @param applicationAttemptId
- <code>ApplicationAttemptId</code> of an application attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request sent by a client to the <code>ResourceManager</code> to get an
- {@link ApplicationAttemptReport} for an application attempt.
- </p>
- <p>
- The request should include the {@link ApplicationAttemptId} of the
- application attempt.
- </p>
- @see ApplicationAttemptReport
- @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
- <class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationAttemptReportResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
- </method>
- <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
- @return <code>ApplicationAttemptReport</code> for the application attempt]]>
- </doc>
- </method>
- <method name="setApplicationAttemptReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
- @param applicationAttemptReport
- <code>ApplicationAttemptReport</code> for the application attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- an application attempt report.
- </p>
- <p>
- The response includes an {@link ApplicationAttemptReport} which has the
- details about the particular application attempt
- </p>
- @see ApplicationAttemptReport
- @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
- <class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationAttemptsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of an application
- @return <code>ApplicationId</code> of an application]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of an application
- @param applicationId
- <code>ApplicationId</code> of an application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request from clients to get a list of application attempt reports of an
- application from the <code>ResourceManager</code>.
- </p>
- @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
- <class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationAttemptsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttempts" type="java.util.List"/>
- </method>
- <method name="getApplicationAttemptList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
- @return a list of <code>ApplicationReport</code> of an application]]>
- </doc>
- </method>
- <method name="setApplicationAttemptList"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttempts" type="java.util.List"/>
- <doc>
- <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
- @param applicationAttempts
- a list of <code>ApplicationReport</code> of an application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- a list of {@link ApplicationAttemptReport} for application attempts.
- </p>
- <p>
- The <code>ApplicationAttemptReport</code> for each application includes the
- details of an application attempt.
- </p>
- @see ApplicationAttemptReport
- @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
- <class name="GetApplicationReportRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationReportRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the application.
- @return <code>ApplicationId</code> of the application]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the application
- @param applicationId <code>ApplicationId</code> of the application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
- get an {@link ApplicationReport} for an application.</p>
- <p>The request should include the {@link ApplicationId} of the
- application.</p>
- @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
- @see ApplicationReport]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
- <class name="GetApplicationReportResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationReportResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationReport</code> for the application.
- @return <code>ApplicationReport</code> for the application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
- requesting an application report.</p>
- <p>The response includes an {@link ApplicationReport} which has details such
- as user, queue, name, host on which the <code>ApplicationMaster</code> is
- running, RPC port, tracking URL, diagnostics, start time etc.</p>
- @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
- <class name="GetApplicationsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
- <param name="users" type="java.util.Set"/>
- <param name="queues" type="java.util.Set"/>
- <param name="applicationTypes" type="java.util.Set"/>
- <param name="applicationTags" type="java.util.Set"/>
- <param name="applicationStates" type="java.util.EnumSet"/>
- <param name="startRange" type="org.apache.commons.lang.math.LongRange"/>
- <param name="finishRange" type="org.apache.commons.lang.math.LongRange"/>
- <param name="limit" type="java.lang.Long"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving application types in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
- <p>Setting any of the parameters to null, would just disable that
- filter</p>
- @param scope {@link ApplicationsRequestScope} to filter by
- @param users list of users to filter by
- @param queues list of scheduler queues to filter by
- @param applicationTypes types of applications
- @param applicationTags application tags to filter by
- @param applicationStates application states to filter by
- @param startRange range of application start times to filter by
- @param finishRange range of application finish times to filter by
- @param limit number of applications to limit to
- @return {@link GetApplicationsRequest} to be used with
- {@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving application types in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @param scope {@link ApplicationsRequestScope} to filter by
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationTypes" type="java.util.Set"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving application types in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationStates" type="java.util.EnumSet"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving application states in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationTypes" type="java.util.Set"/>
- <param name="applicationStates" type="java.util.EnumSet"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving and application types and application types in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </method>
- <method name="getApplicationTypes" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application types to filter applications on
- @return Set of Application Types to filter on]]>
- </doc>
- </method>
- <method name="getApplicationStates" return="java.util.EnumSet"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application states to filter applications on
- @return Set of Application states to filter on]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request from clients to get a report of Applications
- in the cluster from the <code>ResourceManager</code>.</p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
- <class name="GetApplicationsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>ApplicationReport</code> for applications.
- @return <code>ApplicationReport</code> for applications]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
- requesting an {@link ApplicationReport} for applications.</p>
- <p>The <code>ApplicationReport</code> for each application includes details
- such as user, queue, name, host on which the <code>ApplicationMaster</code>
- is running, RPC port, tracking URL, diagnostics, start time etc.</p>
- @see ApplicationReport
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
- <class name="GetClusterMetricsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterMetricsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>The request sent by clients to get cluster metrics from the
- <code>ResourceManager</code>.</p>
- <p>Currently, this is empty.</p>
- @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
- <class name="GetClusterMetricsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterMetricsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
- @return <code>YarnClusterMetrics</code> for the cluster]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the <code>ResourceManager</code> to a client
- requesting cluster metrics.
- @see YarnClusterMetrics
- @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
- <class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodeLabelsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
- <class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodeLabelsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="labels" type="java.util.Set"/>
- </method>
- <method name="setNodeLabels"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="labels" type="java.util.Set"/>
- </method>
- <method name="getNodeLabels" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
- <class name="GetClusterNodesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="states" type="java.util.EnumSet"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNodeStates" return="java.util.EnumSet"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The state to filter the cluster nodes with.]]>
- </doc>
- </method>
- <method name="setNodeStates"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="states" type="java.util.EnumSet"/>
- <doc>
- <![CDATA[The state to filter the cluster nodes with.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request from clients to get a report of all nodes
- in the cluster from the <code>ResourceManager</code>.</p>
- The request will ask for all nodes in the given {@link NodeState}s.
- @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
- <class name="GetClusterNodesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNodeReports" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
- @return <code>NodeReport</code> for all nodes in the cluster]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
- requesting a {@link NodeReport} for all nodes.</p>
- <p>The <code>NodeReport</code> contains per-node information such as
- available resources, number of containers, tracking url, rack name, health
- status etc.
- @see NodeReport
- @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
- <class name="GetContainerReportRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainerReportRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code> of the Container.
- @return <code>ContainerId</code> of the Container]]>
- </doc>
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <doc>
- <![CDATA[Set the <code>ContainerId</code> of the container
- @param containerId
- <code>ContainerId</code> of the container]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request sent by a client to the <code>ResourceManager</code> to get an
- {@link ContainerReport} for a container.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
- <class name="GetContainerReportResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainerReportResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
- </method>
- <method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerReport</code> for the container.
- @return <code>ContainerReport</code> for the container]]>
- </doc>
- </method>
- <method name="setContainerReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- a container report.
- </p>
- <p>
- The response includes a {@link ContainerReport} which has details of a
- container.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
- <class name="GetContainersRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainersRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- </method>
- <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
- @return <code>ApplicationAttemptId</code> of an application attempt]]>
- </doc>
- </method>
- <method name="setApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
- @param applicationAttemptId
- <code>ApplicationAttemptId</code> of an application attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request from clients to get a list of container reports, which belong to
- an application attempt from the <code>ResourceManager</code>.
- </p>
- @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
- <class name="GetContainersResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainersResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containers" type="java.util.List"/>
- </method>
- <method name="getContainerList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of <code>ContainerReport</code> for all the containers of an
- application attempt.
- @return a list of <code>ContainerReport</code> for all the containers of an
- application attempt]]>
- </doc>
- </method>
- <method name="setContainerList"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containers" type="java.util.List"/>
- <doc>
- <![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
- application attempt.
- @param containers
- a list of <code>ContainerReport</code> for all the containers of
- an application attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- a list of {@link ContainerReport} for containers.
- </p>
- <p>
- The <code>ContainerReport</code> for each container includes the container
- details.
- </p>
- @see ContainerReport
- @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
- <class name="GetContainerStatusesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainerStatusesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIds" type="java.util.List"/>
- </method>
- <method name="getContainerIds" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
- the <code>ContainerStatus</code>.
- @return the list of <code>ContainerId</code>s of containers for which to
- obtain the <code>ContainerStatus</code>.]]>
- </doc>
- </method>
- <method name="setContainerIds"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIds" type="java.util.List"/>
- <doc>
- <![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
- the <code>ContainerStatus</code>
- @param containerIds
- a list of <code>ContainerId</code>s of containers for which to
- obtain the <code>ContainerStatus</code>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The request sent by the <code>ApplicationMaster</code> to the
- <code>NodeManager</code> to get {@link ContainerStatus} of requested
- containers.
- @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
- <class name="GetContainerStatusesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainerStatusesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getContainerStatuses" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
- @return <code>ContainerStatus</code>es of the requested containers.]]>
- </doc>
- </method>
- <method name="getFailedRequests" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the containerId-to-exception map in which the exception indicates error
- from per container for failed requests]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the <code>NodeManager</code> to the
- <code>ApplicationMaster</code> when asked to obtain the
- <code>ContainerStatus</code> of requested containers.
- @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
- <class name="GetDelegationTokenRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetDelegationTokenRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="java.lang.String"/>
- </method>
- <method name="getRenewer" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setRenewer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[The request issued by the client to get a delegation token from
- the {@code ResourceManager}.
- for more information.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
- <class name="GetDelegationTokenResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetDelegationTokenResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Delegation tokens have a identifier which maps to
- {@link AbstractDelegationTokenIdentifier}.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Response to a {@link GetDelegationTokenRequest} request
- from the client. The response contains the token that
- can be used by the containers to talk to ClientRMService.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest -->
- <class name="GetLabelsToNodesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetLabelsToNodesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeLabels" type="java.util.Set"/>
- </method>
- <method name="setNodeLabels"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeLabels" type="java.util.Set"/>
- </method>
- <method name="getNodeLabels" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse -->
- <class name="GetLabelsToNodesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetLabelsToNodesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="map" type="java.util.Map"/>
- </method>
- <method name="setLabelsToNodes"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="map" type="java.util.Map"/>
- </method>
- <method name="getLabelsToNodes" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
- <class name="GetNewApplicationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNewApplicationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
- submitting an application.</p>
- <p>Currently, this is empty.</p>
- @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
- <class name="GetNewApplicationResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNewApplicationResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>new</em> <code>ApplicationId</code> allocated by the
- <code>ResourceManager</code>.
- @return <em>new</em> <code>ApplicationId</code> allocated by the
- <code>ResourceManager</code>]]>
- </doc>
- </method>
- <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
- <code>ResourceManager</code> in the cluster.
- @return maximum capability of allocated resources in the cluster]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
- a request to get a new {@link ApplicationId} for submitting applications.</p>
- <p>Clients can submit an application with the returned
- {@link ApplicationId}.</p>
- @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest -->
- <class name="GetNodesToLabelsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNodesToLabelsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse -->
- <class name="GetNodesToLabelsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNodesToLabelsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="map" type="java.util.Map"/>
- </method>
- <method name="setNodeToLabels"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="map" type="java.util.Map"/>
- </method>
- <method name="getNodeToLabels" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
- <class name="GetQueueInfoRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetQueueInfoRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <param name="includeApplications" type="boolean"/>
- <param name="includeChildQueues" type="boolean"/>
- <param name="recursive" type="boolean"/>
- </method>
- <method name="getQueueName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>queue name</em> for which to get queue information.
- @return <em>queue name</em> for which to get queue information]]>
- </doc>
- </method>
- <method name="setQueueName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>queue name</em> for which to get queue information
- @param queueName <em>queue name</em> for which to get queue information]]>
- </doc>
- </method>
- <method name="getIncludeApplications" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is information about <em>active applications</em> required?
- @return <code>true</code> if applications' information is to be included,
- else <code>false</code>]]>
- </doc>
- </method>
- <method name="setIncludeApplications"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includeApplications" type="boolean"/>
- <doc>
- <![CDATA[Should we get fetch information about <em>active applications</em>?
- @param includeApplications fetch information about <em>active
- applications</em>?]]>
- </doc>
- </method>
- <method name="getIncludeChildQueues" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is information about <em>child queues</em> required?
- @return <code>true</code> if information about child queues is required,
- else <code>false</code>]]>
- </doc>
- </method>
- <method name="setIncludeChildQueues"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includeChildQueues" type="boolean"/>
- <doc>
- <![CDATA[Should we fetch information about <em>child queues</em>?
- @param includeChildQueues fetch information about <em>child queues</em>?]]>
- </doc>
- </method>
- <method name="getRecursive" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is information on the entire <em>child queue hierarchy</em> required?
- @return <code>true</code> if information about entire hierarchy is
- required, <code>false</code> otherwise]]>
- </doc>
- </method>
- <method name="setRecursive"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="recursive" type="boolean"/>
- <doc>
- <![CDATA[Should we fetch information on the entire <em>child queue hierarchy</em>?
- @param recursive fetch information on the entire <em>child queue
- hierarchy</em>?]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by clients to get <em>queue information</em>
- from the <code>ResourceManager</code>.</p>
- @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
- <class name="GetQueueInfoResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetQueueInfoResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.records.QueueInfo"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>QueueInfo</code> for the specified queue.
- @return <code>QueueInfo</code> for the specified queue]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the {@code ResourceManager} to a client
- requesting information about queues in the system.
- <p>
- The response includes a {@link QueueInfo} which has details such as
- queue name, used/total capacities, running applications, child queues etc.
- @see QueueInfo
- @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
- <class name="GetQueueUserAclsInfoRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetQueueUserAclsInfoRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>The request sent by clients to the <code>ResourceManager</code> to
- get queue acls for the <em>current user</em>.</p>
- <p>Currently, this is empty.</p>
- @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
- <class name="GetQueueUserAclsInfoResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetQueueUserAclsInfoResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getUserAclsInfoList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>QueueUserACLInfo</code> per queue for the user.
- @return <code>QueueUserACLInfo</code> per queue for the user]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to clients
- seeking queue acls for the user.</p>
- <p>The response contains a list of {@link QueueUserACLInfo} which
- provides information about {@link QueueACL} per queue.</p>
- @see QueueACL
- @see QueueUserACLInfo
- @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
- <class name="KillApplicationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KillApplicationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the application to be aborted.
- @return <code>ApplicationId</code> of the application to be aborted]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
- to abort a submitted application.</p>
- <p>The request includes the {@link ApplicationId} of the application to be
- aborted.</p>
- @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
- <class name="KillApplicationResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KillApplicationResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getIsKillCompleted" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the flag which indicates that the process of killing application is completed or not.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the <code>ResourceManager</code> to the client aborting
- a submitted application.
- <p>
- The response, includes:
- <ul>
- <li>
- A flag which indicates that the process of killing the application is
- completed or not.
- </li>
- </ul>
- Note: user is recommended to wait until this flag becomes true, otherwise if
- the <code>ResourceManager</code> crashes before the process of killing the
- application is completed, the <code>ResourceManager</code> may retry this
- application on recovery.
- @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
- <class name="MoveApplicationAcrossQueuesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MoveApplicationAcrossQueuesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="queue" type="java.lang.String"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the application to be moved.
- @return <code>ApplicationId</code> of the application to be moved]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the application to be moved.
- @param appId <code>ApplicationId</code> of the application to be moved]]>
- </doc>
- </method>
- <method name="getTargetQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the queue to place the application in.
- @return the name of the queue to place the application in]]>
- </doc>
- </method>
- <method name="setTargetQueue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the queue to place the application in.
- @param queue the name of the queue to place the application in]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
- to move a submitted application to a different queue.</p>
- <p>The request includes the {@link ApplicationId} of the application to be
- moved and the queue to place it in.</p>
- @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
- <class name="MoveApplicationAcrossQueuesResponse" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MoveApplicationAcrossQueuesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to the client moving
- a submitted application to a different queue.
- </p>
- <p>
- A response without exception means that the move has completed successfully.
- </p>
- @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
- <class name="RegisterApplicationMasterRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RegisterApplicationMasterRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="trackingUrl" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a new instance of <code>RegisterApplicationMasterRequest</code>.
- If <em>port, trackingUrl</em> is not used, use the following default value:
- <ul>
- <li>port: -1</li>
- <li>trackingUrl: null</li>
- </ul>
- The port is allowed to be any integer larger than or equal to -1.
- @return the new instance of <code>RegisterApplicationMasterRequest</code>]]>
- </doc>
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code> is
- running.
- @return <em>host</em> on which the <code>ApplicationMaster</code> is running]]>
- </doc>
- </method>
- <method name="setHost"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>host</em> on which the <code>ApplicationMaster</code> is
- running.
- @param host <em>host</em> on which the <code>ApplicationMaster</code>
- is running]]>
- </doc>
- </method>
- <method name="getRpcPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>RPC port</em> on which the {@code ApplicationMaster} is
- responding.
- @return the <em>RPC port</em> on which the {@code ApplicationMaster}
- is responding]]>
- </doc>
- </method>
- <method name="setRpcPort"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="port" type="int"/>
- <doc>
- <![CDATA[Set the <em>RPC port</em> on which the {@code ApplicationMaster} is
- responding.
- @param port <em>RPC port</em> on which the {@code ApplicationMaster}
- is responding]]>
- </doc>
- </method>
- <method name="getTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
- This url if contains scheme then that will be used by resource manager
- web application proxy otherwise it will default to http.
- @return <em>tracking URL</em> for the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setTrackingUrl"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="trackingUrl" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>tracking URL</em>for the <code>ApplicationMaster</code> while
- it is running. This is the web-URL to which ResourceManager or
- web-application proxy will redirect client/users while the application and
- the <code>ApplicationMaster</code> are still running.
- <p>
- If the passed url has a scheme then that will be used by the
- ResourceManager and web-application proxy, otherwise the scheme will
- default to http.
- </p>
- <p>
- Empty, null, "N/A" strings are all valid besides a real URL. In case an url
- isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
- <p>
- @param trackingUrl
- <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The request sent by the {@code ApplicationMaster} to {@code ResourceManager}
- on registration.
- <p>
- The registration includes details such as:
- <ul>
- <li>Hostname on which the AM is running.</li>
- <li>RPC Port</li>
- <li>Tracking URL</li>
- </ul>
- @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
- <class name="RegisterApplicationMasterResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RegisterApplicationMasterResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
- <code>ResourceManager</code> in the cluster.
- @return maximum capability of allocated resources in the cluster]]>
- </doc>
- </method>
- <method name="getApplicationACLs" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationACL</code>s for the application.
- @return all the <code>ApplicationACL</code>s]]>
- </doc>
- </method>
- <method name="getClientToAMTokenMasterKey" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>Get ClientToAMToken master key.</p>
- <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code>
- by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse}
- , used to verify corresponding ClientToAMToken.</p>]]>
- </doc>
- </method>
- <method name="setClientToAMTokenMasterKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.nio.ByteBuffer"/>
- <doc>
- <![CDATA[Set ClientToAMToken master key.]]>
- </doc>
- </method>
- <method name="getQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>Get the queue that the application was placed in.<p>]]>
- </doc>
- </method>
- <method name="setQueue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <doc>
- <![CDATA[<p>Set the queue that the application was placed in.<p>]]>
- </doc>
- </method>
- <method name="getContainersFromPreviousAttempts" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Get the list of running containers as viewed by
- <code>ResourceManager</code> from previous application attempts.
- </p>
- @return the list of running containers as viewed by
- <code>ResourceManager</code> from previous application attempts
- @see RegisterApplicationMasterResponse#getNMTokensFromPreviousAttempts()]]>
- </doc>
- </method>
- <method name="getNMTokensFromPreviousAttempts" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of NMTokens for communicating with the NMs where the
- containers of previous application attempts are running.
- @return the list of NMTokens for communicating with the NMs where the
- containers of previous application attempts are running.
- @see RegisterApplicationMasterResponse#getContainersFromPreviousAttempts()]]>
- </doc>
- </method>
- <method name="getSchedulerResourceTypes" return="java.util.EnumSet"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a set of the resource types considered by the scheduler.
- @return a Map of RM settings]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the {@code ResourceManager} to a new
- {@code ApplicationMaster} on registration.
- <p>
- The response contains critical details such as:
- <ul>
- <li>Maximum capability for allocated resources in the cluster.</li>
- <li>{@code ApplicationACL}s for the application.</li>
- <li>ClientToAMToken master key.</li>
- </ul>
- @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
- <class name="ReleaseSharedCacheResourceRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReleaseSharedCacheResourceRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the resource to be released.
- @return <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="setAppId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the resource to be released.
- @param id <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="getResourceKey" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>key</code> of the resource to be released.
- @return <code>key</code>]]>
- </doc>
- </method>
- <method name="setResourceKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>key</code> of the resource to be released.
- @param key unique identifier for the resource]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request from clients to release a resource in the shared cache.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
- <class name="ReleaseSharedCacheResourceResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReleaseSharedCacheResourceResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[<p>
- The response to clients from the <code>SharedCacheManager</code> when
- releasing a resource in the shared cache.
- </p>
- <p>
- Currently, this is empty.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
- <class name="ReservationDeleteRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationDeleteRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- </method>
- <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @return the {@link ReservationId} representing the unique id of the
- corresponding reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <method name="setReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- <doc>
- <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @param reservationId the {@link ReservationId} representing the the unique
- id of the corresponding reserved resource allocation in the
- scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationDeleteRequest} captures the set of requirements the user
- has to delete an existing reservation.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
- <class name="ReservationDeleteResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationDeleteResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[{@link ReservationDeleteResponse} contains the answer of the admission
- control system in the {@code ResourceManager} to a reservation delete
- operation. Currently response is empty if the operation was successful, if
- not an exception reporting reason for a failure.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
- <class name="ReservationSubmissionRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationSubmissionRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
- <param name="queueName" type="java.lang.String"/>
- </method>
- <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationDefinition} representing the user constraints for
- this reservation
- @return the reservation definition representing user constraints]]>
- </doc>
- </method>
- <method name="setReservationDefinition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
- <doc>
- <![CDATA[Set the {@link ReservationDefinition} representing the user constraints for
- this reservation
- @param reservationDefinition the reservation request representing the
- reservation]]>
- </doc>
- </method>
- <method name="getQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the {@code Plan} that corresponds to the name of the
- {@link QueueInfo} in the scheduler to which the reservation will be
- submitted to.
- @return the name of the {@code Plan} that corresponds to the name of the
- {@link QueueInfo} in the scheduler to which the reservation will be
- submitted to]]>
- </doc>
- </method>
- <method name="setQueue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the name of the {@code Plan} that corresponds to the name of the
- {@link QueueInfo} in the scheduler to which the reservation will be
- submitted to
- @param queueName the name of the parent {@code Plan} that corresponds to
- the name of the {@link QueueInfo} in the scheduler to which the
- reservation will be submitted to]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationSubmissionRequest} captures the set of requirements the
- user has to create a reservation.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
- <class name="ReservationSubmissionResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationSubmissionResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @return the {@link ReservationId} representing the unique id of the
- corresponding reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationSubmissionResponse} contains the answer of the admission
- control system in the {@code ResourceManager} to a reservation create
- operation. Response contains a {@link ReservationId} if the operation was
- successful, if not an exception reporting reason for a failure.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
- <class name="ReservationUpdateRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationUpdateRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
- <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- </method>
- <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationDefinition} representing the updated user
- constraints for this reservation
- @return the reservation definition representing user constraints]]>
- </doc>
- </method>
- <method name="setReservationDefinition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
- <doc>
- <![CDATA[Set the {@link ReservationDefinition} representing the updated user
- constraints for this reservation
- @param reservationDefinition the reservation request representing the
- reservation]]>
- </doc>
- </method>
- <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @return the {@link ReservationId} representing the unique id of the
- corresponding reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <method name="setReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- <doc>
- <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @param reservationId the {@link ReservationId} representing the the unique
- id of the corresponding reserved resource allocation in the
- scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationUpdateRequest} captures the set of requirements the user
- has to update an existing reservation.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
- <class name="ReservationUpdateResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationUpdateResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[{@link ReservationUpdateResponse} contains the answer of the admission
- control system in the {@code ResourceManager} to a reservation update
- operation. Currently response is empty if the operation was successful, if
- not an exception reporting reason for a failure.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
- <class name="StartContainerRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StartContainerRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerLaunchContext</code> for the container to be started
- by the <code>NodeManager</code>.
- @return <code>ContainerLaunchContext</code> for the container to be started
- by the <code>NodeManager</code>]]>
- </doc>
- </method>
- <method name="setContainerLaunchContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <doc>
- <![CDATA[Set the <code>ContainerLaunchContext</code> for the container to be started
- by the <code>NodeManager</code>
- @param context <code>ContainerLaunchContext</code> for the container to be
- started by the <code>NodeManager</code>]]>
- </doc>
- </method>
- <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the container token to be used for authorization during starting
- container.
- <p>
- Note: {@link NMToken} will be used for authenticating communication with
- {@code NodeManager}.
- @return the container token to be used for authorization during starting
- container.
- @see NMToken
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </method>
- <method name="setContainerToken"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
- <code>NodeManager</code> to <em>start</em> a container.</p>
- <p>The <code>ApplicationMaster</code> has to provide details such as
- allocated resource capability, security tokens (if enabled), command
- to be executed to start the container, environment for the process,
- necessary binaries/jar/shared-objects etc. via the
- {@link ContainerLaunchContext}.</p>
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
- <class name="StartContainersRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StartContainersRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="requests" type="java.util.List"/>
- </method>
- <method name="getStartContainerRequests" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of {@link StartContainerRequest} to start containers.
- @return a list of {@link StartContainerRequest} to start containers.]]>
- </doc>
- </method>
- <method name="setStartContainerRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="java.util.List"/>
- <doc>
- <![CDATA[Set a list of {@link StartContainerRequest} to start containers.
- @param request a list of {@link StartContainerRequest} to start containers]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request which contains a list of {@link StartContainerRequest} sent by
- the <code>ApplicationMaster</code> to the <code>NodeManager</code> to
- <em>start</em> containers.
- </p>
- <p>
- In each {@link StartContainerRequest}, the <code>ApplicationMaster</code> has
- to provide details such as allocated resource capability, security tokens (if
- enabled), command to be executed to start the container, environment for the
- process, necessary binaries/jar/shared-objects etc. via the
- {@link ContainerLaunchContext}.
- </p>
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
- <class name="StartContainersResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StartContainersResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSuccessfullyStartedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>ContainerId</code> s of the containers that are
- started successfully.
- @return the list of <code>ContainerId</code> s of the containers that are
- started successfully.
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </method>
- <method name="getFailedRequests" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the containerId-to-exception map in which the exception indicates error
- from per container for failed requests]]>
- </doc>
- </method>
- <method name="getAllServicesMetaData" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Get the meta-data from all auxiliary services running on the
- <code>NodeManager</code>.
- </p>
- <p>
- The meta-data is returned as a Map between the auxiliary service names and
- their corresponding per service meta-data as an opaque blob
- <code>ByteBuffer</code>
- </p>
- <p>
- To be able to interpret the per-service meta-data, you should consult the
- documentation for the Auxiliary-service configured on the NodeManager
- </p>
- @return a Map between the names of auxiliary services and their
- corresponding meta-data]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>NodeManager</code> to the
- <code>ApplicationMaster</code> when asked to <em>start</em> an allocated
- container.
- </p>
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
- <class name="StopContainersRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StopContainersRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIds" type="java.util.List"/>
- </method>
- <method name="getContainerIds" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code>s of the containers to be stopped.
- @return <code>ContainerId</code>s of containers to be stopped]]>
- </doc>
- </method>
- <method name="setContainerIds"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIds" type="java.util.List"/>
- <doc>
- <![CDATA[Set the <code>ContainerId</code>s of the containers to be stopped.
- @param containerIds <code>ContainerId</code>s of the containers to be stopped]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
- <code>NodeManager</code> to <em>stop</em> containers.</p>
- @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
- <class name="StopContainersResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StopContainersResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSuccessfullyStoppedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of containerIds of successfully stopped containers.
- @return the list of containerIds of successfully stopped containers.]]>
- </doc>
- </method>
- <method name="getFailedRequests" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the containerId-to-exception map in which the exception indicates error
- from per container for failed requests]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>NodeManager</code> to the
- <code>ApplicationMaster</code> when asked to <em>stop</em> allocated
- containers.
- </p>
- @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
- <class name="SubmitApplicationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SubmitApplicationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
- </method>
- <method name="getApplicationSubmissionContext" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationSubmissionContext</code> for the application.
- @return <code>ApplicationSubmissionContext</code> for the application]]>
- </doc>
- </method>
- <method name="setApplicationSubmissionContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
- <doc>
- <![CDATA[Set the <code>ApplicationSubmissionContext</code> for the application.
- @param context <code>ApplicationSubmissionContext</code> for the
- application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by a client to <em>submit an application</em> to the
- <code>ResourceManager</code>.</p>
- <p>The request, via {@link ApplicationSubmissionContext}, contains
- details such as queue, {@link Resource} required to run the
- <code>ApplicationMaster</code>, the equivalent of
- {@link ContainerLaunchContext} for launching the
- <code>ApplicationMaster</code> etc.
- @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
- <class name="SubmitApplicationResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SubmitApplicationResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
- application submission.</p>
- <p>Currently, this is empty.</p>
- @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
- <class name="UseSharedCacheResourceRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UseSharedCacheResourceRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAppId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the resource to be used.
- @return <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="setAppId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the resource to be used.
- @param id <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="getResourceKey" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>key</code> of the resource to be used.
- @return <code>key</code>]]>
- </doc>
- </method>
- <method name="setResourceKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>key</code> of the resource to be used.
- @param key unique identifier for the resource]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request from clients to the <code>SharedCacheManager</code> that claims a
- resource in the shared cache.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
- <class name="UseSharedCacheResourceResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UseSharedCacheResourceResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPath" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Path</code> corresponding to the requested resource in the
- shared cache.
- @return String A <code>Path</code> if the resource exists in the shared
- cache, <code>null</code> otherwise]]>
- </doc>
- </method>
- <method name="setPath"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>Path</code> corresponding to a resource in the shared cache.
- @param p A <code>Path</code> corresponding to a resource in the shared
- cache]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response from the SharedCacheManager to the client that indicates whether
- a requested resource exists in the cache.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
- </package>
- <package name="org.apache.hadoop.yarn.api.records">
- <!-- start class org.apache.hadoop.yarn.api.records.AMCommand -->
- <class name="AMCommand" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.AMCommand[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.AMCommand"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Command sent by the Resource Manager to the Application Master in the
- AllocateResponse
- @see AllocateResponse]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.AMCommand -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
- <class name="ApplicationAccessType" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Application access types.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
- <class name="ApplicationAttemptId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ApplicationAttemptId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the <code>ApplicationAttempId</code>.
- @return <code>ApplicationId</code> of the <code>ApplicationAttempId</code>]]>
- </doc>
- </method>
- <method name="getAttemptId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>attempt id</code> of the <code>Application</code>.
- @return <code>attempt id</code> of the <code>Application</code>]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <field name="appAttemptIdStrPrefix" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p><code>ApplicationAttemptId</code> denotes the particular <em>attempt</em>
- of an <code>ApplicationMaster</code> for a given {@link ApplicationId}.</p>
- <p>Multiple attempts might be needed to run an application to completion due
- to temporal failures of the <code>ApplicationMaster</code> such as hardware
- failures, connectivity issues etc. on the node on which it was scheduled.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
- <class name="ApplicationAttemptReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationAttemptReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getYarnApplicationAttemptState" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>YarnApplicationAttemptState</em> of the application attempt.
- @return <em>YarnApplicationAttemptState</em> of the application attempt]]>
- </doc>
- </method>
- <method name="getRpcPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>RPC port</em> of this attempt <code>ApplicationMaster</code>.
- @return <em>RPC port</em> of this attempt <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>host</em> on which this attempt of
- <code>ApplicationMaster</code> is running.
- @return <em>host</em> on which this attempt of
- <code>ApplicationMaster</code> is running]]>
- </doc>
- </method>
- <method name="getDiagnostics" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>diagnositic information</em> of the application attempt in case
- of errors.
- @return <em>diagnositic information</em> of the application attempt in case
- of errors]]>
- </doc>
- </method>
- <method name="getTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>tracking url</em> for the application attempt.
- @return <em>tracking url</em> for the application attempt]]>
- </doc>
- </method>
- <method name="getOriginalTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>original tracking url</em> for the application attempt.
- @return <em>original tracking url</em> for the application attempt]]>
- </doc>
- </method>
- <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of this attempt of the
- application
- @return <code>ApplicationAttemptId</code> of the attempt]]>
- </doc>
- </method>
- <method name="getAMContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code> of AMContainer for this attempt
- @return <code>ContainerId</code> of the attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ApplicationAttemptReport} is a report of an application attempt.
- <p>
- It includes details such as:
- <ul>
- <li>{@link ApplicationAttemptId} of the application.</li>
- <li>Host on which the <code>ApplicationMaster</code> of this attempt is
- running.</li>
- <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li>
- <li>Tracking URL.</li>
- <li>Diagnostic information in case of errors.</li>
- <li>{@link YarnApplicationAttemptState} of the application attempt.</li>
- <li>{@link ContainerId} of the master Container.</li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationId -->
- <class name="ApplicationId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ApplicationId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the short integer identifier of the <code>ApplicationId</code>
- which is unique for all applications started by a particular instance
- of the <code>ResourceManager</code>.
- @return short integer identifier of the <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="getClusterTimestamp" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>start time</em> of the <code>ResourceManager</code> which is
- used to generate globally unique <code>ApplicationId</code>.
- @return <em>start time</em> of the <code>ResourceManager</code>]]>
- </doc>
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <field name="appIdStrPrefix" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p><code>ApplicationId</code> represents the <em>globally unique</em>
- identifier for an application.</p>
- <p>The globally unique nature of the identifier is achieved by using the
- <em>cluster timestamp</em> i.e. start-time of the
- <code>ResourceManager</code> along with a monotonically increasing counter
- for the application.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationId -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationReport -->
- <class name="ApplicationReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the application.
- @return <code>ApplicationId</code> of the application]]>
- </doc>
- </method>
- <method name="getCurrentApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of the current
- attempt of the application
- @return <code>ApplicationAttemptId</code> of the attempt]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>user</em> who submitted the application.
- @return <em>user</em> who submitted the application]]>
- </doc>
- </method>
- <method name="getQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>queue</em> to which the application was submitted.
- @return <em>queue</em> to which the application was submitted]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user-defined <em>name</em> of the application.
- @return <em>name</em> of the application]]>
- </doc>
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code>
- is running.
- @return <em>host</em> on which the <code>ApplicationMaster</code>
- is running]]>
- </doc>
- </method>
- <method name="getRpcPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>RPC port</em> of the <code>ApplicationMaster</code>.
- @return <em>RPC port</em> of the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getClientToAMToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>client token</em> for communicating with the
- <code>ApplicationMaster</code>.
- <p>
- <em>ClientToAMToken</em> is the security token used by the AMs to verify
- authenticity of any <code>client</code>.
- </p>
- <p>
- The <code>ResourceManager</code>, provides a secure token (via
- {@link ApplicationReport#getClientToAMToken()}) which is verified by the
- ApplicationMaster when the client directly talks to an AM.
- </p>
- @return <em>client token</em> for communicating with the
- <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getYarnApplicationState" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>YarnApplicationState</code> of the application.
- @return <code>YarnApplicationState</code> of the application]]>
- </doc>
- </method>
- <method name="getDiagnostics" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>diagnositic information</em> of the application in case of
- errors.
- @return <em>diagnositic information</em> of the application in case
- of errors]]>
- </doc>
- </method>
- <method name="getTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>tracking url</em> for the application.
- @return <em>tracking url</em> for the application]]>
- </doc>
- </method>
- <method name="getStartTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>start time</em> of the application.
- @return <em>start time</em> of the application]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>finish time</em> of the application.
- @return <em>finish time</em> of the application]]>
- </doc>
- </method>
- <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>final finish status</em> of the application.
- @return <em>final finish status</em> of the application]]>
- </doc>
- </method>
- <method name="getApplicationResourceUsageReport" return="org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieve the structure containing the job resources for this application
- @return the job resources structure for this application]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application's progress ( range 0.0 to 1.0 )
- @return application's progress]]>
- </doc>
- </method>
- <method name="getApplicationType" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application's Type
- @return application's Type]]>
- </doc>
- </method>
- <method name="getApplicationTags" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get all tags corresponding to the application
- @return Application's tags]]>
- </doc>
- </method>
- <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the AMRM token of the application.
- <p>
- The AMRM token is required for AM to RM scheduling operations. For
- managed Application Masters Yarn takes care of injecting it. For unmanaged
- Applications Masters, the token must be obtained via this method and set
- in the {@link org.apache.hadoop.security.UserGroupInformation} of the
- current user.
- <p>
- The AMRM token will be returned only if all the following conditions are
- met:
- <ul>
- <li>the requester is the owner of the ApplicationMaster</li>
- <li>the application master is an unmanaged ApplicationMaster</li>
- <li>the application master is in ACCEPTED state</li>
- </ul>
- Else this method returns NULL.
- @return the AM to RM token if available.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ApplicationReport} is a report of an application.
- <p>
- It includes details such as:
- <ul>
- <li>{@link ApplicationId} of the application.</li>
- <li>Applications user.</li>
- <li>Application queue.</li>
- <li>Application name.</li>
- <li>Host on which the <code>ApplicationMaster</code> is running.</li>
- <li>RPC port of the <code>ApplicationMaster</code>.</li>
- <li>Tracking URL.</li>
- <li>{@link YarnApplicationState} of the application.</li>
- <li>Diagnostic information in case of errors.</li>
- <li>Start time of the application.</li>
- <li>Client {@link Token} of the application (if security is enabled).</li>
- </ul>
- @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
- <class name="ApplicationResourceUsageReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationResourceUsageReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNumUsedContainers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of used containers. -1 for invalid/inaccessible reports.
- @return the number of used containers]]>
- </doc>
- </method>
- <method name="getUsedResources" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the used <code>Resource</code>. -1 for invalid/inaccessible reports.
- @return the used <code>Resource</code>]]>
- </doc>
- </method>
- <method name="getReservedResources" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reserved <code>Resource</code>. -1 for invalid/inaccessible reports.
- @return the reserved <code>Resource</code>]]>
- </doc>
- </method>
- <method name="getNeededResources" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the needed <code>Resource</code>. -1 for invalid/inaccessible reports.
- @return the needed <code>Resource</code>]]>
- </doc>
- </method>
- <method name="getMemorySeconds" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the aggregated amount of memory (in megabytes) the application has
- allocated times the number of seconds the application has been running.
- @return the aggregated amount of memory seconds]]>
- </doc>
- </method>
- <method name="getVcoreSeconds" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the aggregated number of vcores that the application has allocated
- times the number of seconds the application has been running.
- @return the aggregated number of vcore seconds]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Contains various scheduling metrics to be reported by UI and CLI.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
- <class name="ApplicationSubmissionContext" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationSubmissionContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- <param name="appLabelExpression" type="java.lang.String"/>
- <param name="amContainerLabelExpression" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- <param name="appLabelExpression" type="java.lang.String"/>
- <param name="resourceRequest" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- <param name="attemptFailuresValidityInterval" type="long"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the submitted application.
- @return <code>ApplicationId</code> of the submitted application]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the submitted application.
- @param applicationId <code>ApplicationId</code> of the submitted
- application]]>
- </doc>
- </method>
- <method name="getApplicationName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application <em>name</em>.
- @return application name]]>
- </doc>
- </method>
- <method name="setApplicationName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the application <em>name</em>.
- @param applicationName application name]]>
- </doc>
- </method>
- <method name="getQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>queue</em> to which the application is being submitted.
- @return <em>queue</em> to which the application is being submitted]]>
- </doc>
- </method>
- <method name="setQueue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>queue</em> to which the application is being submitted
- @param queue <em>queue</em> to which the application is being submitted]]>
- </doc>
- </method>
- <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Priority</code> of the application.
- @return <code>Priority</code> of the application]]>
- </doc>
- </method>
- <method name="getAMContainerSpec" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerLaunchContext</code> to describe the
- <code>Container</code> with which the <code>ApplicationMaster</code> is
- launched.
- @return <code>ContainerLaunchContext</code> for the
- <code>ApplicationMaster</code> container]]>
- </doc>
- </method>
- <method name="setAMContainerSpec"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <doc>
- <![CDATA[Set the <code>ContainerLaunchContext</code> to describe the
- <code>Container</code> with which the <code>ApplicationMaster</code> is
- launched.
- @param amContainer <code>ContainerLaunchContext</code> for the
- <code>ApplicationMaster</code> container]]>
- </doc>
- </method>
- <method name="getUnmanagedAM" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get if the RM should manage the execution of the AM.
- If true, then the RM
- will not allocate a container for the AM and start it. It will expect the
- AM to be launched and connect to the RM within the AM liveliness period and
- fail the app otherwise. The client should launch the AM only after the RM
- has ACCEPTED the application and changed the <code>YarnApplicationState</code>.
- Such apps will not be retried by the RM on app attempt failure.
- The default value is false.
- @return true if the AM is not managed by the RM]]>
- </doc>
- </method>
- <method name="setUnmanagedAM"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[@param value true if RM should not manage the AM]]>
- </doc>
- </method>
- <method name="getMaxAppAttempts" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the number of max attempts of the application to be submitted]]>
- </doc>
- </method>
- <method name="setMaxAppAttempts"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="maxAppAttempts" type="int"/>
- <doc>
- <![CDATA[Set the number of max attempts of the application to be submitted. WARNING:
- it should be no larger than the global number of max attempts in the Yarn
- configuration.
- @param maxAppAttempts the number of max attempts of the application
- to be submitted.]]>
- </doc>
- </method>
- <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the resource required by the <code>ApplicationMaster</code> for this
- application. Please note this will be DEPRECATED, use <em>getResource</em>
- in <em>getAMContainerResourceRequest</em> instead.
- @return the resource required by the <code>ApplicationMaster</code> for
- this application.]]>
- </doc>
- </method>
- <method name="setResource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <doc>
- <![CDATA[Set the resource required by the <code>ApplicationMaster</code> for this
- application.
- @param resource the resource required by the <code>ApplicationMaster</code>
- for this application.]]>
- </doc>
- </method>
- <method name="getApplicationType" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application type
- @return the application type]]>
- </doc>
- </method>
- <method name="setApplicationType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the application type
- @param applicationType the application type]]>
- </doc>
- </method>
- <method name="getKeepContainersAcrossApplicationAttempts" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the flag which indicates whether to keep containers across application
- attempts or not.
- @return the flag which indicates whether to keep containers across
- application attempts or not.]]>
- </doc>
- </method>
- <method name="setKeepContainersAcrossApplicationAttempts"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keepContainers" type="boolean"/>
- <doc>
- <![CDATA[Set the flag which indicates whether to keep containers across application
- attempts.
- <p>
- If the flag is true, running containers will not be killed when application
- attempt fails and these containers will be retrieved by the new application
- attempt on registration via
- {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}.
- </p>
- @param keepContainers
- the flag which indicates whether to keep containers across
- application attempts.]]>
- </doc>
- </method>
- <method name="getApplicationTags" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get tags for the application
- @return the application tags]]>
- </doc>
- </method>
- <method name="setApplicationTags"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tags" type="java.util.Set"/>
- <doc>
- <![CDATA[Set tags for the application. A maximum of
- {@link YarnConfiguration#APPLICATION_MAX_TAGS} are allowed
- per application. Each tag can be at most
- {@link YarnConfiguration#APPLICATION_MAX_TAG_LENGTH}
- characters, and can contain only ASCII characters.
- @param tags tags to set]]>
- </doc>
- </method>
- <method name="getNodeLabelExpression" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get node-label-expression for this app. If this is set, all containers of
- this application without setting node-label-expression in ResurceRequest
- will get allocated resources on only those nodes that satisfy this
- node-label-expression.
- If different node-label-expression of this app and ResourceRequest are set
- at the same time, the one set in ResourceRequest will be used when
- allocating container
- @return node-label-expression for this app]]>
- </doc>
- </method>
- <method name="setNodeLabelExpression"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeLabelExpression" type="java.lang.String"/>
- <doc>
- <![CDATA[Set node-label-expression for this app
- @param nodeLabelExpression node-label-expression of this app]]>
- </doc>
- </method>
- <method name="getAMContainerResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get ResourceRequest of AM container, if this is not null, scheduler will
- use this to acquire resource for AM container.
- If this is null, scheduler will assemble a ResourceRequest by using
- <em>getResource</em> and <em>getPriority</em> of
- <em>ApplicationSubmissionContext</em>.
- Number of containers and Priority will be ignore.
- @return ResourceRequest of AM container]]>
- </doc>
- </method>
- <method name="setAMContainerResourceRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- <doc>
- <![CDATA[Set ResourceRequest of AM container
- @param request of AM container]]>
- </doc>
- </method>
- <method name="getAttemptFailuresValidityInterval" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attemptFailuresValidityInterval in milliseconds for the application
- @return the attemptFailuresValidityInterval]]>
- </doc>
- </method>
- <method name="setAttemptFailuresValidityInterval"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attemptFailuresValidityInterval" type="long"/>
- <doc>
- <![CDATA[Set the attemptFailuresValidityInterval in milliseconds for the application
- @param attemptFailuresValidityInterval]]>
- </doc>
- </method>
- <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>LogAggregationContext</code> of the application
- @return <code>LogAggregationContext</code> of the application]]>
- </doc>
- </method>
- <method name="setLogAggregationContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
- <doc>
- <![CDATA[Set <code>LogAggregationContext</code> for the application
- @param logAggregationContext
- for the application]]>
- </doc>
- </method>
- <method name="getReservationID" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reservation id, that corresponds to a valid resource allocation in
- the scheduler (between start and end time of the corresponding reservation)
- @return the reservation id representing the unique id of the corresponding
- reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <method name="setReservationID"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationID" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- <doc>
- <![CDATA[Set the reservation id, that correspond to a valid resource allocation in
- the scheduler (between start and end time of the corresponding reservation)
- @param reservationID representing the unique id of the
- corresponding reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ApplicationSubmissionContext} represents all of the
- information needed by the {@code ResourceManager} to launch
- the {@code ApplicationMaster} for an application.
- <p>
- It includes details such as:
- <ul>
- <li>{@link ApplicationId} of the application.</li>
- <li>Application user.</li>
- <li>Application name.</li>
- <li>{@link Priority} of the application.</li>
- <li>
- {@link ContainerLaunchContext} of the container in which the
- <code>ApplicationMaster</code> is executed.
- </li>
- <li>
- maxAppAttempts. The maximum number of application attempts.
- It should be no larger than the global number of max attempts in the
- Yarn configuration.
- </li>
- <li>
- attemptFailuresValidityInterval. The default value is -1.
- when attemptFailuresValidityInterval in milliseconds is set to
- {@literal >} 0, the failure number will no take failures which happen
- out of the validityInterval into failure count. If failure count
- reaches to maxAppAttempts, the application will be failed.
- </li>
- <li>Optional, application-specific {@link LogAggregationContext}</li>
- </ul>
- @see ContainerLaunchContext
- @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
- <!-- start class org.apache.hadoop.yarn.api.records.Container -->
- <class name="Container" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Container"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the globally unique identifier for the container.
- @return globally unique identifier for the container]]>
- </doc>
- </method>
- <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the identifier of the node on which the container is allocated.
- @return identifier of the node on which the container is allocated]]>
- </doc>
- </method>
- <method name="getNodeHttpAddress" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the http uri of the node on which the container is allocated.
- @return http uri of the node on which the container is allocated]]>
- </doc>
- </method>
- <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Resource</code> allocated to the container.
- @return <code>Resource</code> allocated to the container]]>
- </doc>
- </method>
- <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Priority</code> at which the <code>Container</code> was
- allocated.
- @return <code>Priority</code> at which the <code>Container</code> was
- allocated]]>
- </doc>
- </method>
- <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerToken</code> for the container.
- <p><code>ContainerToken</code> is the security token used by the framework
- to verify authenticity of any <code>Container</code>.</p>
- <p>The <code>ResourceManager</code>, on container allocation provides a
- secure token which is verified by the <code>NodeManager</code> on
- container launch.</p>
- <p>Applications do not need to care about <code>ContainerToken</code>, they
- are transparently handled by the framework - the allocated
- <code>Container</code> includes the <code>ContainerToken</code>.</p>
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
- @return <code>ContainerToken</code> for the container]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code Container} represents an allocated resource in the cluster.
- <p>
- The {@code ResourceManager} is the sole authority to allocate any
- {@code Container} to applications. The allocated {@code Container}
- is always on a single node and has a unique {@link ContainerId}. It has
- a specific amount of {@link Resource} allocated.
- <p>
- It includes details such as:
- <ul>
- <li>{@link ContainerId} for the container, which is globally unique.</li>
- <li>
- {@link NodeId} of the node on which it is allocated.
- </li>
- <li>HTTP uri of the node.</li>
- <li>{@link Resource} allocated to the container.</li>
- <li>{@link Priority} at which the container was allocated.</li>
- <li>
- Container {@link Token} of the container, used to securely verify
- authenticity of the allocation.
- </li>
- </ul>
- Typically, an {@code ApplicationMaster} receives the {@code Container}
- from the {@code ResourceManager} during resource-negotiation and then
- talks to the {@code NodeManager} to start/stop containers.
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
- @see ContainerManagementProtocol#stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.Container -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
- <class name="ContainerExitStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerExitStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="SUCCESS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INVALID" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ABORTED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Containers killed by the framework, either due to being released by
- the application or being 'lost' due to node failures etc.]]>
- </doc>
- </field>
- <field name="DISKS_FAILED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[When threshold number of the nodemanager-local-directories or
- threshold number of the nodemanager-log-directories become bad.]]>
- </doc>
- </field>
- <field name="PREEMPTED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Containers preempted by the framework.]]>
- </doc>
- </field>
- <field name="KILLED_EXCEEDED_VMEM" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container terminated because of exceeding allocated virtual memory.]]>
- </doc>
- </field>
- <field name="KILLED_EXCEEDED_PMEM" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container terminated because of exceeding allocated physical memory.]]>
- </doc>
- </field>
- <field name="KILLED_BY_APPMASTER" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container was terminated by stop request by the app master.]]>
- </doc>
- </field>
- <field name="KILLED_BY_RESOURCEMANAGER" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container was terminated by the resource manager.]]>
- </doc>
- </field>
- <field name="KILLED_AFTER_APP_COMPLETION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container was terminated after the application finished.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Container exit statuses indicating special exit circumstances.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerId -->
- <class name="ContainerId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ContainerId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of the application to which the
- <code>Container</code> was assigned.
- <p>
- Note: If containers are kept alive across application attempts via
- {@link ApplicationSubmissionContext#setKeepContainersAcrossApplicationAttempts(boolean)}
- the <code>ContainerId</code> does not necessarily contain the current
- running application attempt's <code>ApplicationAttemptId</code> This
- container can be allocated by previously exited application attempt and
- managed by the current running attempt thus have the previous application
- attempt's <code>ApplicationAttemptId</code>.
- </p>
- @return <code>ApplicationAttemptId</code> of the application to which the
- <code>Container</code> was assigned]]>
- </doc>
- </method>
- <method name="getId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the lower 32 bits of identifier of the <code>ContainerId</code>,
- which doesn't include epoch. Note that this method will be marked as
- deprecated, so please use <code>getContainerId</code> instead.
- @return lower 32 bits of identifier of the <code>ContainerId</code>]]>
- </doc>
- </method>
- <method name="getContainerId" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the identifier of the <code>ContainerId</code>. Upper 24 bits are
- reserved as epoch of cluster, and lower 40 bits are reserved as
- sequential number of containers.
- @return identifier of the <code>ContainerId</code>]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return A string representation of containerId. The format is
- container_e*epoch*_*clusterTimestamp*_*appId*_*attemptId*_*containerId*
- when epoch is larger than 0
- (e.g. container_e17_1410901177871_0001_01_000005).
- *epoch* is increased when RM restarts or fails over.
- When epoch is 0, epoch is omitted
- (e.g. container_1410901177871_0001_01_000005).]]>
- </doc>
- </method>
- <method name="fromString" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIdStr" type="java.lang.String"/>
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <field name="CONTAINER_ID_BITMASK" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p><code>ContainerId</code> represents a globally unique identifier
- for a {@link Container} in the cluster.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerId -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
- <class name="ContainerLaunchContext" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerLaunchContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="localResources" type="java.util.Map"/>
- <param name="environment" type="java.util.Map"/>
- <param name="commands" type="java.util.List"/>
- <param name="serviceData" type="java.util.Map"/>
- <param name="tokens" type="java.nio.ByteBuffer"/>
- <param name="acls" type="java.util.Map"/>
- </method>
- <method name="getTokens" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get all the tokens needed by this container. It may include file-system
- tokens, ApplicationMaster related tokens if this container is an
- ApplicationMaster or framework level tokens needed by this container to
- communicate to various services in a secure manner.
- @return tokens needed by this container.]]>
- </doc>
- </method>
- <method name="setTokens"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tokens" type="java.nio.ByteBuffer"/>
- <doc>
- <![CDATA[Set security tokens needed by this container.
- @param tokens security tokens]]>
- </doc>
- </method>
- <method name="getLocalResources" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>LocalResource</code> required by the container.
- @return all <code>LocalResource</code> required by the container]]>
- </doc>
- </method>
- <method name="setLocalResources"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="localResources" type="java.util.Map"/>
- <doc>
- <![CDATA[Set <code>LocalResource</code> required by the container. All pre-existing
- Map entries are cleared before adding the new Map
- @param localResources <code>LocalResource</code> required by the container]]>
- </doc>
- </method>
- <method name="getServiceData" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Get application-specific binary <em>service data</em>. This is a map keyed
- by the name of each {@link AuxiliaryService} that is configured on a
- NodeManager and value correspond to the application specific data targeted
- for the keyed {@link AuxiliaryService}.
- </p>
- <p>
- This will be used to initialize this application on the specific
- {@link AuxiliaryService} running on the NodeManager by calling
- {@link AuxiliaryService#initializeApplication(ApplicationInitializationContext)}
- </p>
- @return application-specific binary <em>service data</em>]]>
- </doc>
- </method>
- <method name="setServiceData"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="serviceData" type="java.util.Map"/>
- <doc>
- <![CDATA[<p>
- Set application-specific binary <em>service data</em>. This is a map keyed
- by the name of each {@link AuxiliaryService} that is configured on a
- NodeManager and value correspond to the application specific data targeted
- for the keyed {@link AuxiliaryService}. All pre-existing Map entries are
- preserved.
- </p>
- @param serviceData
- application-specific binary <em>service data</em>]]>
- </doc>
- </method>
- <method name="getEnvironment" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>environment variables</em> for the container.
- @return <em>environment variables</em> for the container]]>
- </doc>
- </method>
- <method name="setEnvironment"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="environment" type="java.util.Map"/>
- <doc>
- <![CDATA[Add <em>environment variables</em> for the container. All pre-existing Map
- entries are cleared before adding the new Map
- @param environment <em>environment variables</em> for the container]]>
- </doc>
- </method>
- <method name="getCommands" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <em>commands</em> for launching the container.
- @return the list of <em>commands</em> for launching the container]]>
- </doc>
- </method>
- <method name="setCommands"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="commands" type="java.util.List"/>
- <doc>
- <![CDATA[Add the list of <em>commands</em> for launching the container. All
- pre-existing List entries are cleared before adding the new List
- @param commands the list of <em>commands</em> for launching the container]]>
- </doc>
- </method>
- <method name="getApplicationACLs" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationACL</code>s for the application.
- @return all the <code>ApplicationACL</code>s]]>
- </doc>
- </method>
- <method name="setApplicationACLs"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="acls" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the <code>ApplicationACL</code>s for the application. All pre-existing
- Map entries are cleared before adding the new Map
- @param acls <code>ApplicationACL</code>s for the application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ContainerLaunchContext} represents all of the information
- needed by the {@code NodeManager} to launch a container.
- <p>
- It includes details such as:
- <ul>
- <li>{@link ContainerId} of the container.</li>
- <li>{@link Resource} allocated to the container.</li>
- <li>User to whom the container is allocated.</li>
- <li>Security tokens (if security is enabled).</li>
- <li>
- {@link LocalResource} necessary for running the container such
- as binaries, jar, shared-objects, side-files etc.
- </li>
- <li>Optional, application-specific binary service data.</li>
- <li>Environment variables for the launched process.</li>
- <li>Command to launch the container.</li>
- </ul>
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerReport -->
- <class name="ContainerReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code> of the container.
- @return <code>ContainerId</code> of the container.]]>
- </doc>
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getAllocatedResource" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the allocated <code>Resource</code> of the container.
- @return allocated <code>Resource</code> of the container.]]>
- </doc>
- </method>
- <method name="setAllocatedResource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="getAssignedNode" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the allocated <code>NodeId</code> where container is running.
- @return allocated <code>NodeId</code> where container is running.]]>
- </doc>
- </method>
- <method name="setAssignedNode"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
- </method>
- <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the allocated <code>Priority</code> of the container.
- @return allocated <code>Priority</code> of the container.]]>
- </doc>
- </method>
- <method name="setPriority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- </method>
- <method name="getCreationTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the creation time of the container.
- @return creation time of the container]]>
- </doc>
- </method>
- <method name="setCreationTime"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="creationTime" type="long"/>
- </method>
- <method name="getFinishTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Finish time of the container.
- @return Finish time of the container]]>
- </doc>
- </method>
- <method name="setFinishTime"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="finishTime" type="long"/>
- </method>
- <method name="getDiagnosticsInfo" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the DiagnosticsInfo of the container.
- @return DiagnosticsInfo of the container]]>
- </doc>
- </method>
- <method name="setDiagnosticsInfo"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="diagnosticsInfo" type="java.lang.String"/>
- </method>
- <method name="getLogUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the LogURL of the container.
- @return LogURL of the container]]>
- </doc>
- </method>
- <method name="setLogUrl"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logUrl" type="java.lang.String"/>
- </method>
- <method name="getContainerState" return="org.apache.hadoop.yarn.api.records.ContainerState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the final <code>ContainerState</code> of the container.
- @return final <code>ContainerState</code> of the container.]]>
- </doc>
- </method>
- <method name="setContainerState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerState" type="org.apache.hadoop.yarn.api.records.ContainerState"/>
- </method>
- <method name="getContainerExitStatus" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the final <code>exit status</code> of the container.
- @return final <code>exit status</code> of the container.]]>
- </doc>
- </method>
- <method name="setContainerExitStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerExitStatus" type="int"/>
- </method>
- <method name="getNodeHttpAddress" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Node Http address of the container
- @return the node http address of the container]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ContainerReport} is a report of an container.
- <p>
- It includes details such as:
- <ul>
- <li>{@link ContainerId} of the container.</li>
- <li>Allocated Resources to the container.</li>
- <li>Assigned Node id.</li>
- <li>Assigned Priority.</li>
- <li>Creation Time.</li>
- <li>Finish Time.</li>
- <li>Container Exit Status.</li>
- <li>{@link ContainerState} of the container.</li>
- <li>Diagnostic information in case of errors.</li>
- <li>Log URL.</li>
- <li>nodeHttpAddress</li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceDecrease -->
- <class name="ContainerResourceDecrease" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerResourceDecrease"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceDecrease"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[Used by Application Master to ask Node Manager reduce size of a specified
- container]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceDecrease -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceIncrease -->
- <class name="ContainerResourceIncrease" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerResourceIncrease"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceIncrease"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerToken"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[Represent a new increased container accepted by Resource Manager]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceIncrease -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
- <class name="ContainerResourceIncreaseRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerResourceIncreaseRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[Used by Application Master, send a container resource increase request to
- Resource Manager]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerState -->
- <class name="ContainerState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[<p>State of a <code>Container</code>.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerState -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerStatus -->
- <class name="ContainerStatus" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code> of the container.
- @return <code>ContainerId</code> of the container]]>
- </doc>
- </method>
- <method name="getState" return="org.apache.hadoop.yarn.api.records.ContainerState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerState</code> of the container.
- @return <code>ContainerState</code> of the container]]>
- </doc>
- </method>
- <method name="getExitStatus" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>Get the <em>exit status</em> for the container.</p>
- <p>Note: This is valid only for completed containers i.e. containers
- with state {@link ContainerState#COMPLETE}.
- Otherwise, it returns an ContainerExitStatus.INVALID.
- </p>
- <p>Containers killed by the framework, either due to being released by
- the application or being 'lost' due to node failures etc. have a special
- exit code of ContainerExitStatus.ABORTED.</p>
- <p>When threshold number of the nodemanager-local-directories or
- threshold number of the nodemanager-log-directories become bad, then
- container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.
- </p>
- @return <em>exit status</em> for the container]]>
- </doc>
- </method>
- <method name="getDiagnostics" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>diagnostic messages</em> for failed containers.
- @return <em>diagnostic messages</em> for failed containers]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ContainerStatus} represents the current status of a
- {@code Container}.
- <p>
- It provides details such as:
- <ul>
- <li>{@code ContainerId} of the container.</li>
- <li>{@code ContainerState} of the container.</li>
- <li><em>Exit status</em> of a completed container.</li>
- <li><em>Diagnostic</em> message for a failed container.</li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
- <!-- start class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
- <class name="FinalApplicationStatus" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration of various final states of an <code>Application</code>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
- <!-- start class org.apache.hadoop.yarn.api.records.LocalResource -->
- <class name="LocalResource" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LocalResource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
- <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
- <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
- <param name="size" type="long"/>
- <param name="timestamp" type="long"/>
- <param name="pattern" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
- <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
- <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
- <param name="size" type="long"/>
- <param name="timestamp" type="long"/>
- <param name="pattern" type="java.lang.String"/>
- <param name="shouldBeUploadedToSharedCache" type="boolean"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
- <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
- <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
- <param name="size" type="long"/>
- <param name="timestamp" type="long"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
- <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
- <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
- <param name="size" type="long"/>
- <param name="timestamp" type="long"/>
- <param name="shouldBeUploadedToSharedCache" type="boolean"/>
- </method>
- <method name="getResource" return="org.apache.hadoop.yarn.api.records.URL"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>location</em> of the resource to be localized.
- @return <em>location</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="setResource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="org.apache.hadoop.yarn.api.records.URL"/>
- <doc>
- <![CDATA[Set <em>location</em> of the resource to be localized.
- @param resource <em>location</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="getSize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>size</em> of the resource to be localized.
- @return <em>size</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="setSize"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="size" type="long"/>
- <doc>
- <![CDATA[Set the <em>size</em> of the resource to be localized.
- @param size <em>size</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="getTimestamp" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the original <em>timestamp</em> of the resource to be localized, used
- for verification.
- @return <em>timestamp</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="setTimestamp"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timestamp" type="long"/>
- <doc>
- <![CDATA[Set the <em>timestamp</em> of the resource to be localized, used
- for verification.
- @param timestamp <em>timestamp</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="getType" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>LocalResourceType</code> of the resource to be localized.
- @return <code>LocalResourceType</code> of the resource to be localized]]>
- </doc>
- </method>
- <method name="setType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
- <doc>
- <![CDATA[Set the <code>LocalResourceType</code> of the resource to be localized.
- @param type <code>LocalResourceType</code> of the resource to be localized]]>
- </doc>
- </method>
- <method name="getVisibility" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>LocalResourceVisibility</code> of the resource to be
- localized.
- @return <code>LocalResourceVisibility</code> of the resource to be
- localized]]>
- </doc>
- </method>
- <method name="setVisibility"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
- <doc>
- <![CDATA[Set the <code>LocalResourceVisibility</code> of the resource to be
- localized.
- @param visibility <code>LocalResourceVisibility</code> of the resource to be
- localized]]>
- </doc>
- </method>
- <method name="getPattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>pattern</em> that should be used to extract entries from the
- archive (only used when type is <code>PATTERN</code>).
- @return <em>pattern</em> that should be used to extract entries from the
- archive.]]>
- </doc>
- </method>
- <method name="setPattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>pattern</em> that should be used to extract entries from the
- archive (only used when type is <code>PATTERN</code>).
- @param pattern <em>pattern</em> that should be used to extract entries
- from the archive.]]>
- </doc>
- </method>
- <method name="getShouldBeUploadedToSharedCache" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[NM uses it to decide whether if it is necessary to upload the resource to
- the shared cache]]>
- </doc>
- </method>
- <method name="setShouldBeUploadedToSharedCache"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="shouldBeUploadedToSharedCache" type="boolean"/>
- <doc>
- <![CDATA[Inform NM whether upload to SCM is needed.
- @param shouldBeUploadedToSharedCache <em>shouldBeUploadedToSharedCache</em>
- of this request]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>LocalResource</code> represents a local resource required to
- run a container.</p>
- <p>The <code>NodeManager</code> is responsible for localizing the resource
- prior to launching the container.</p>
- <p>Applications can specify {@link LocalResourceType} and
- {@link LocalResourceVisibility}.</p>
- @see LocalResourceType
- @see LocalResourceVisibility
- @see ContainerLaunchContext
- @see ApplicationSubmissionContext
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LocalResource -->
- <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceType -->
- <class name="LocalResourceType" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[{@code LocalResourceType} specifies the <em>type</em>
- of a resource localized by the {@code NodeManager}.
- <p>
- The <em>type</em> can be one of:
- <ul>
- <li>
- {@link #FILE} - Regular file i.e. uninterpreted bytes.
- </li>
- <li>
- {@link #ARCHIVE} - Archive, which is automatically unarchived by the
- <code>NodeManager</code>.
- </li>
- <li>
- {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
- </li>
- </ul>
- @see LocalResource
- @see ContainerLaunchContext
- @see ApplicationSubmissionContext
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceType -->
- <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
- <class name="LocalResourceVisibility" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[{@code LocalResourceVisibility} specifies the <em>visibility</em>
- of a resource localized by the {@code NodeManager}.
- <p>
- The <em>visibility</em> can be one of:
- <ul>
- <li>{@link #PUBLIC} - Shared by all users on the node.</li>
- <li>
- {@link #PRIVATE} - Shared among all applications of the
- <em>same user</em> on the node.
- </li>
- <li>
- {@link #APPLICATION} - Shared only among containers of the
- <em>same application</em> on the node.
- </li>
- </ul>
- @see LocalResource
- @see ContainerLaunchContext
- @see ApplicationSubmissionContext
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
- <!-- start class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
- <class name="LogAggregationContext" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LogAggregationContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includePattern" type="java.lang.String"/>
- <param name="excludePattern" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includePattern" type="java.lang.String"/>
- <param name="excludePattern" type="java.lang.String"/>
- <param name="rolledLogsIncludePattern" type="java.lang.String"/>
- <param name="rolledLogsExcludePattern" type="java.lang.String"/>
- </method>
- <method name="getIncludePattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get include pattern. This includePattern only takes affect
- on logs that exist at the time of application finish.
- @return include pattern]]>
- </doc>
- </method>
- <method name="setIncludePattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includePattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set include pattern. This includePattern only takes affect
- on logs that exist at the time of application finish.
- @param includePattern]]>
- </doc>
- </method>
- <method name="getExcludePattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get exclude pattern. This excludePattern only takes affect
- on logs that exist at the time of application finish.
- @return exclude pattern]]>
- </doc>
- </method>
- <method name="setExcludePattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="excludePattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set exclude pattern. This excludePattern only takes affect
- on logs that exist at the time of application finish.
- @param excludePattern]]>
- </doc>
- </method>
- <method name="getRolledLogsIncludePattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get include pattern in a rolling fashion.
- @return include pattern]]>
- </doc>
- </method>
- <method name="setRolledLogsIncludePattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rolledLogsIncludePattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set include pattern in a rolling fashion.
- @param rolledLogsIncludePattern]]>
- </doc>
- </method>
- <method name="getRolledLogsExcludePattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get exclude pattern for aggregation in a rolling fashion.
- @return exclude pattern]]>
- </doc>
- </method>
- <method name="setRolledLogsExcludePattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rolledLogsExcludePattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set exclude pattern for in a rolling fashion.
- @param rolledLogsExcludePattern]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code LogAggregationContext} represents all of the
- information needed by the {@code NodeManager} to handle
- the logs for an application.
- <p>
- It includes details such as:
- <ul>
- <li>
- includePattern. It uses Java Regex to filter the log files
- which match the defined include pattern and those log files
- will be uploaded when the application finishes.
- </li>
- <li>
- excludePattern. It uses Java Regex to filter the log files
- which match the defined exclude pattern and those log files
- will not be uploaded when application finishes. If the log file
- name matches both the include and the exclude pattern, this file
- will be excluded eventually.
- </li>
- <li>
- rolledLogsIncludePattern. It uses Java Regex to filter the log files
- which match the defined include pattern and those log files
- will be aggregated in a rolling fashion.
- </li>
- <li>
- rolledLogsExcludePattern. It uses Java Regex to filter the log files
- which match the defined exclude pattern and those log files
- will not be aggregated in a rolling fashion. If the log file
- name matches both the include and the exclude pattern, this file
- will be excluded eventually.
- </li>
- </ul>
- @see ApplicationSubmissionContext]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
- <!-- start class org.apache.hadoop.yarn.api.records.NMToken -->
- <class name="NMToken" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NMToken"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link NodeId} of the <code>NodeManager</code> for which the NMToken
- is used to authenticate.
- @return the {@link NodeId} of the <code>NodeManager</code> for which the
- NMToken is used to authenticate.]]>
- </doc>
- </method>
- <method name="setNodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
- </method>
- <method name="getToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link Token} used for authenticating with <code>NodeManager</code>
- @return the {@link Token} used for authenticating with <code>NodeManager</code>]]>
- </doc>
- </method>
- <method name="setToken"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[<p>The NMToken is used for authenticating communication with
- <code>NodeManager</code></p>
- <p>It is issued by <code>ResourceMananger</code> when <code>ApplicationMaster</code>
- negotiates resource with <code>ResourceManager</code> and
- validated on <code>NodeManager</code> side.</p>
- @see AllocateResponse#getNMTokens()]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NMToken -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeId -->
- <class name="NodeId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="NodeId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>hostname</em> of the node.
- @return <em>hostname</em> of the node]]>
- </doc>
- </method>
- <method name="getPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>port</em> for communicating with the node.
- @return <em>port</em> for communicating with the node]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.NodeId"/>
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p><code>NodeId</code> is the unique identifier for a node.</p>
- <p>It includes the <em>hostname</em> and <em>port</em> to uniquely
- identify the node. Thus, it is unique across restarts of any
- <code>NodeManager</code>.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeId -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeReport -->
- <class name="NodeReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NodeReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>NodeId</code> of the node.
- @return <code>NodeId</code> of the node]]>
- </doc>
- </method>
- <method name="getNodeState" return="org.apache.hadoop.yarn.api.records.NodeState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>NodeState</code> of the node.
- @return <code>NodeState</code> of the node]]>
- </doc>
- </method>
- <method name="getHttpAddress" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>http address</em> of the node.
- @return <em>http address</em> of the node]]>
- </doc>
- </method>
- <method name="getRackName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>rack name</em> for the node.
- @return <em>rack name</em> for the node]]>
- </doc>
- </method>
- <method name="getUsed" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>used</em> <code>Resource</code> on the node.
- @return <em>used</em> <code>Resource</code> on the node]]>
- </doc>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>total</em> <code>Resource</code> on the node.
- @return <em>total</em> <code>Resource</code> on the node]]>
- </doc>
- </method>
- <method name="getHealthReport" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>diagnostic health report</em> of the node.
- @return <em>diagnostic health report</em> of the node]]>
- </doc>
- </method>
- <method name="getLastHealthReportTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>last timestamp</em> at which the health report was received.
- @return <em>last timestamp</em> at which the health report was received]]>
- </doc>
- </method>
- <method name="getNodeLabels" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get labels of this node
- @return labels of this node]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code NodeReport} is a summary of runtime information of a node
- in the cluster.
- <p>
- It includes details such as:
- <ul>
- <li>{@link NodeId} of the node.</li>
- <li>HTTP Tracking URL of the node.</li>
- <li>Rack name for the node.</li>
- <li>Used {@link Resource} on the node.</li>
- <li>Total available {@link Resource} of the node.</li>
- <li>Number of running containers on the node.</li>
- </ul>
- @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeState -->
- <class name="NodeState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.NodeState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="isUnusable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>State of a <code>Node</code>.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeState -->
- <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
- <class name="PreemptionContainer" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PreemptionContainer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Container referenced by this handle.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Specific container requested back by the <code>ResourceManager</code>.
- @see PreemptionContract
- @see StrictPreemptionContract]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
- <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContract -->
- <class name="PreemptionContract" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PreemptionContract"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getResourceRequest" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If the AM releases resources matching these requests, then the {@link
- PreemptionContainer}s enumerated in {@link #getContainers()} should not be
- evicted from the cluster. Due to delays in propagating cluster state and
- sending these messages, there are conditions where satisfied contracts may
- not prevent the platform from killing containers.
- @return List of {@link PreemptionResourceRequest} to update the
- <code>ApplicationMaster</code> about resources requested back by the
- <code>ResourceManager</code>.
- @see AllocateRequest#setAskList(List)]]>
- </doc>
- </method>
- <method name="getContainers" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Assign the set of {@link PreemptionContainer} specifying which containers
- owned by the <code>ApplicationMaster</code> that may be reclaimed by the
- <code>ResourceManager</code>. If the AM prefers a different set of
- containers, then it may checkpoint or kill containers matching the
- description in {@link #getResourceRequest}.
- @return Set of containers at risk if the contract is not met.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Description of resources requested back by the <code>ResourceManager</code>.
- The <code>ApplicationMaster</code> (AM) can satisfy this request according
- to its own priorities to prevent containers from being forcibly killed by
- the platform.
- @see PreemptionMessage]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContract -->
- <!-- start class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
- <class name="PreemptionMessage" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PreemptionMessage"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getStrictContract" return="org.apache.hadoop.yarn.api.records.StrictPreemptionContract"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Specific resources that may be killed by the
- <code>ResourceManager</code>]]>
- </doc>
- </method>
- <method name="getContract" return="org.apache.hadoop.yarn.api.records.PreemptionContract"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Contract describing resources to return to the cluster.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by
- the RM to specify resources that the RM wants to reclaim from this
- {@code ApplicationMaster} (AM). The AM receives a {@link
- StrictPreemptionContract} message encoding which containers the platform may
- forcibly kill, granting it an opportunity to checkpoint state or adjust its
- execution plan. The message may also include a {@link PreemptionContract}
- granting the AM more latitude in selecting which resources to return to the
- cluster.
- <p>
- The AM should decode both parts of the message. The {@link
- StrictPreemptionContract} specifies particular allocations that the RM
- requires back. The AM can checkpoint containers' state, adjust its execution
- plan to move the computation, or take no action and hope that conditions that
- caused the RM to ask for the container will change.
- <p>
- In contrast, the {@link PreemptionContract} also includes a description of
- resources with a set of containers. If the AM releases containers matching
- that profile, then the containers enumerated in {@link
- PreemptionContract#getContainers()} may not be killed.
- <p>
- Each preemption message reflects the RM's current understanding of the
- cluster state, so a request to return <em>N</em> containers may not
- reflect containers the AM is releasing, recently exited containers the RM has
- yet to learn about, or new containers allocated before the message was
- generated. Conversely, an RM may request a different profile of containers in
- subsequent requests.
- <p>
- The policy enforced by the RM is part of the scheduler. Generally, only
- containers that have been requested consistently should be killed, but the
- details are not specified.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
- <!-- start class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
- <class name="PreemptionResourceRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PreemptionResourceRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Resource described in this request, to be matched against running
- containers.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Description of resources requested back by the cluster.
- @see PreemptionContract
- @see AllocateRequest#setAskList(java.util.List)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.Priority -->
- <class name="Priority" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Priority"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="int"/>
- </method>
- <method name="getPriority" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the assigned priority
- @return the assigned priority]]>
- </doc>
- </method>
- <method name="setPriority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="int"/>
- <doc>
- <![CDATA[Set the assigned priority
- @param priority the assigned priority]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.Priority"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="UNDEFINED" type="org.apache.hadoop.yarn.api.records.Priority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The priority assigned to a ResourceRequest or Application or Container
- allocation]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.Priority -->
- <!-- start class org.apache.hadoop.yarn.api.records.QueueACL -->
- <class name="QueueACL" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.QueueACL[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueACL"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[{@code QueueACL} enumerates the various ACLs for queues.
- <p>
- The ACL is one of:
- <ul>
- <li>
- {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue.
- </li>
- <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
- </ul>
- @see QueueInfo
- @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.QueueACL -->
- <!-- start class org.apache.hadoop.yarn.api.records.QueueInfo -->
- <class name="QueueInfo" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="QueueInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getQueueName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>name</em> of the queue.
- @return <em>name</em> of the queue]]>
- </doc>
- </method>
- <method name="getCapacity" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>configured capacity</em> of the queue.
- @return <em>configured capacity</em> of the queue]]>
- </doc>
- </method>
- <method name="getMaximumCapacity" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>maximum capacity</em> of the queue.
- @return <em>maximum capacity</em> of the queue]]>
- </doc>
- </method>
- <method name="getCurrentCapacity" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>current capacity</em> of the queue.
- @return <em>current capacity</em> of the queue]]>
- </doc>
- </method>
- <method name="getChildQueues" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>child queues</em> of the queue.
- @return <em>child queues</em> of the queue]]>
- </doc>
- </method>
- <method name="getApplications" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>running applications</em> of the queue.
- @return <em>running applications</em> of the queue]]>
- </doc>
- </method>
- <method name="getQueueState" return="org.apache.hadoop.yarn.api.records.QueueState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>QueueState</code> of the queue.
- @return <code>QueueState</code> of the queue]]>
- </doc>
- </method>
- <method name="getAccessibleNodeLabels" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>accessible node labels</code> of the queue.
- @return <code>accessible node labels</code> of the queue]]>
- </doc>
- </method>
- <method name="getDefaultNodeLabelExpression" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>default node label expression</code> of the queue, this takes
- affect only when the <code>ApplicationSubmissionContext</code> and
- <code>ResourceRequest</code> don't specify their
- <code>NodeLabelExpression</code>.
- @return <code>default node label expression</code> of the queue]]>
- </doc>
- </method>
- <method name="setDefaultNodeLabelExpression"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="defaultLabelExpression" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[QueueInfo is a report of the runtime information of the queue.
- <p>
- It includes information such as:
- <ul>
- <li>Queue name.</li>
- <li>Capacity of the queue.</li>
- <li>Maximum capacity of the queue.</li>
- <li>Current capacity of the queue.</li>
- <li>Child queues.</li>
- <li>Running applications.</li>
- <li>{@link QueueState} of the queue.</li>
- </ul>
- @see QueueState
- @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.QueueInfo -->
- <!-- start class org.apache.hadoop.yarn.api.records.QueueState -->
- <class name="QueueState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.QueueState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[State of a Queue.
- <p>
- A queue is in one of:
- <ul>
- <li>{@link #RUNNING} - normal state.</li>
- <li>{@link #STOPPED} - not accepting new application submissions.</li>
- </ul>
- @see QueueInfo
- @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.QueueState -->
- <!-- start class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
- <class name="QueueUserACLInfo" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="QueueUserACLInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getQueueName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>queue name</em> of the queue.
- @return <em>queue name</em> of the queue]]>
- </doc>
- </method>
- <method name="getUserAcls" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>QueueACL</code> for the given user.
- @return list of <code>QueueACL</code> for the given user]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
- the given user.</p>
- @see QueueACL
- @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
- <class name="ReservationDefinition" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationDefinition"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arrival" type="long"/>
- <param name="deadline" type="long"/>
- <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getArrival" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the arrival time or the earliest time from which the resource(s) can be
- allocated. Time expressed as UTC.
- @return the earliest valid time for this reservation]]>
- </doc>
- </method>
- <method name="setArrival"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="earliestStartTime" type="long"/>
- <doc>
- <![CDATA[Set the arrival time or the earliest time from which the resource(s) can be
- allocated. Time expressed as UTC.
- @param earliestStartTime the earliest valid time for this reservation]]>
- </doc>
- </method>
- <method name="getDeadline" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the deadline or the latest time by when the resource(s) must be
- allocated. Time expressed as UTC.
- @return the deadline or the latest time by when the resource(s) must be
- allocated]]>
- </doc>
- </method>
- <method name="setDeadline"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="latestEndTime" type="long"/>
- <doc>
- <![CDATA[Set the deadline or the latest time by when the resource(s) must be
- allocated. Time expressed as UTC.
- @param latestEndTime the deadline or the latest time by when the
- resource(s) should be allocated]]>
- </doc>
- </method>
- <method name="getReservationRequests" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of {@link ReservationRequests} representing the resources
- required by the application
- @return the list of {@link ReservationRequests}]]>
- </doc>
- </method>
- <method name="setReservationRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
- <doc>
- <![CDATA[Set the list of {@link ReservationRequests} representing the resources
- required by the application
- @param reservationRequests the list of {@link ReservationRequests}]]>
- </doc>
- </method>
- <method name="getReservationName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name for this reservation. The name need-not be unique, and it is
- just a mnemonic for the user (akin to job names). Accepted reservations are
- uniquely identified by a system-generated ReservationId.
- @return string representing the name of the corresponding reserved resource
- allocation in the scheduler]]>
- </doc>
- </method>
- <method name="setReservationName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the name for this reservation. The name need-not be unique, and it is
- just a mnemonic for the user (akin to job names). Accepted reservations are
- uniquely identified by a system-generated ReservationId.
- @param name representing the name of the corresponding reserved resource
- allocation in the scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationDefinition} captures the set of resource and time
- constraints the user cares about regarding a reservation.
- @see ResourceRequest]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationId -->
- <class name="ReservationId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ReservationId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the long identifier of the {@link ReservationId} which is unique for
- all Reservations started by a particular instance of the
- {@code ResourceManager}.
- @return long identifier of the {@link ReservationId}]]>
- </doc>
- </method>
- <method name="getClusterTimestamp" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>start time</em> of the {@code ResourceManager} which is used to
- generate globally unique {@link ReservationId}.
- @return <em>start time</em> of the {@code ResourceManager}]]>
- </doc>
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="parseReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationId" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Parse the string argument as a {@link ReservationId}
- @param reservationId the string representation of the {@link ReservationId}
- @return the {@link ReservationId} corresponding to the input string if
- valid, null if input is null
- @throws IOException if unable to parse the input string]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <field name="reserveIdStrPrefix" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="clusterTimestamp" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="id" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p>
- {@link ReservationId} represents the <em>globally unique</em> identifier for
- a reservation.
- </p>
- <p>
- The globally unique nature of the identifier is achieved by using the
- <em>cluster timestamp</em> i.e. start-time of the {@code ResourceManager}
- along with a monotonically increasing counter for the reservation.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationId -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest -->
- <class name="ReservationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ReservationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- <param name="concurrency" type="int"/>
- <param name="duration" type="long"/>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link Resource} capability of the request.
- @return {@link Resource} capability of the request]]>
- </doc>
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <doc>
- <![CDATA[Set the {@link Resource} capability of the request
- @param capability {@link Resource} capability of the request]]>
- </doc>
- </method>
- <method name="getNumContainers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of containers required with the given specifications.
- @return number of containers required with the given specifications]]>
- </doc>
- </method>
- <method name="setNumContainers"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numContainers" type="int"/>
- <doc>
- <![CDATA[Set the number of containers required with the given specifications
- @param numContainers number of containers required with the given
- specifications]]>
- </doc>
- </method>
- <method name="getConcurrency" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of containers that need to be scheduled concurrently. The
- default value of 1 would fall back to the current non concurrency
- constraints on the scheduling behavior.
- @return the number of containers to be concurrently scheduled]]>
- </doc>
- </method>
- <method name="setConcurrency"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numContainers" type="int"/>
- <doc>
- <![CDATA[Set the number of containers that need to be scheduled concurrently. The
- default value of 1 would fall back to the current non concurrency
- constraints on the scheduling behavior.
- @param numContainers the number of containers to be concurrently scheduled]]>
- </doc>
- </method>
- <method name="getDuration" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the duration in milliseconds for which the resource is required. A
- default value of -1, indicates an unspecified lease duration, and fallback
- to current behavior.
- @return the duration in milliseconds for which the resource is required]]>
- </doc>
- </method>
- <method name="setDuration"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="duration" type="long"/>
- <doc>
- <![CDATA[Set the duration in milliseconds for which the resource is required.
- @param duration the duration in milliseconds for which the resource is
- required]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
- </method>
- <doc>
- <![CDATA[{@link ReservationRequest} represents the request made by an application to
- the {@code ResourceManager} to reserve {@link Resource}s.
- <p>
- It includes:
- <ul>
- <li>{@link Resource} required for each request.</li>
- <li>
- Number of containers, of above specifications, which are required by the
- application.
- </li>
- <li>Concurrency that indicates the gang size of the request.</li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
- <class name="ReservationRequest.ReservationRequestComparator" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.Comparator"/>
- <implements name="java.io.Serializable"/>
- <constructor name="ReservationRequest.ReservationRequestComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r1" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
- <param name="r2" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
- <class name="ReservationRequestInterpreter" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration of various types of dependencies among multiple
- {@link ReservationRequests} within one {@link ReservationDefinition} (from
- least constraining to most constraining).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequests -->
- <class name="ReservationRequests" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationRequests"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationResources" type="java.util.List"/>
- <param name="type" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
- </method>
- <method name="getReservationResources" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of {@link ReservationRequest} representing the resources
- required by the application
- @return the list of {@link ReservationRequest}]]>
- </doc>
- </method>
- <method name="setReservationResources"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationResources" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list of {@link ReservationRequest} representing the resources
- required by the application
- @param reservationResources the list of {@link ReservationRequest}]]>
- </doc>
- </method>
- <method name="getInterpreter" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationRequestInterpreter}, representing how the list of
- resources should be allocated, this captures temporal ordering and other
- constraints.
- @return the list of {@link ReservationRequestInterpreter}]]>
- </doc>
- </method>
- <method name="setInterpreter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="interpreter" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
- <doc>
- <![CDATA[Set the {@link ReservationRequestInterpreter}, representing how the list of
- resources should be allocated, this captures temporal ordering and other
- constraints.
- @param interpreter the {@link ReservationRequestInterpreter} for this
- reservation]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationRequests} captures the set of resource and constraints the
- user cares about regarding a reservation.
- @see ReservationRequest]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequests -->
- <!-- start class org.apache.hadoop.yarn.api.records.Resource -->
- <class name="Resource" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Resource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memory" type="int"/>
- <param name="vCores" type="int"/>
- </method>
- <method name="getMemory" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>memory</em> of the resource.
- @return <em>memory</em> of the resource]]>
- </doc>
- </method>
- <method name="setMemory"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memory" type="int"/>
- <doc>
- <![CDATA[Set <em>memory</em> of the resource.
- @param memory <em>memory</em> of the resource]]>
- </doc>
- </method>
- <method name="getVirtualCores" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>number of virtual cpu cores</em> of the resource.
- Virtual cores are a unit for expressing CPU parallelism. A node's capacity
- should be configured with virtual cores equal to its number of physical cores.
- A container should be requested with the number of cores it can saturate, i.e.
- the average number of threads it expects to have runnable at a time.
- @return <em>num of virtual cpu cores</em> of the resource]]>
- </doc>
- </method>
- <method name="setVirtualCores"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="vCores" type="int"/>
- <doc>
- <![CDATA[Set <em>number of virtual cpu cores</em> of the resource.
- Virtual cores are a unit for expressing CPU parallelism. A node's capacity
- should be configured with virtual cores equal to its number of physical cores.
- A container should be requested with the number of cores it can saturate, i.e.
- the average number of threads it expects to have runnable at a time.
- @param vCores <em>number of virtual cpu cores</em> of the resource]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p><code>Resource</code> models a set of computer resources in the
- cluster.</p>
- <p>Currently it models both <em>memory</em> and <em>CPU</em>.</p>
- <p>The unit for memory is megabytes. CPU is modeled with virtual cores
- (vcores), a unit for expressing parallelism. A node's capacity should
- be configured with virtual cores equal to its number of physical cores. A
- container should be requested with the number of cores it can saturate, i.e.
- the average number of threads it expects to have runnable at a time.</p>
- <p>Virtual cores take integer values and thus currently CPU-scheduling is
- very coarse. A complementary axis for CPU requests that represents processing
- power will likely be added in the future to enable finer-grained resource
- configuration.</p>
- <p>Typically, applications request <code>Resource</code> of suitable
- capability to run their component tasks.</p>
- @see ResourceRequest
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.Resource -->
- <!-- start class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
- <class name="ResourceBlacklistRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceBlacklistRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="additions" type="java.util.List"/>
- <param name="removals" type="java.util.List"/>
- </method>
- <method name="getBlacklistAdditions" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of resource-names which should be added to the
- application blacklist.
- @return list of resource-names which should be added to the
- application blacklist]]>
- </doc>
- </method>
- <method name="setBlacklistAdditions"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceNames" type="java.util.List"/>
- <doc>
- <![CDATA[Set list of resource-names which should be added to the application blacklist.
- @param resourceNames list of resource-names which should be added to the
- application blacklist]]>
- </doc>
- </method>
- <method name="getBlacklistRemovals" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of resource-names which should be removed from the
- application blacklist.
- @return list of resource-names which should be removed from the
- application blacklist]]>
- </doc>
- </method>
- <method name="setBlacklistRemovals"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceNames" type="java.util.List"/>
- <doc>
- <![CDATA[Set list of resource-names which should be removed from the
- application blacklist.
- @param resourceNames list of resource-names which should be removed from the
- application blacklist]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ResourceBlacklistRequest} encapsulates the list of resource-names
- which should be added or removed from the <em>blacklist</em> of resources
- for the application.
- @see ResourceRequest
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.ResourceOption -->
- <class name="ResourceOption" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceOption"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceOption"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="overCommitTimeout" type="int"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceOption -->
- <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest -->
- <class name="ResourceRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ResourceRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- <param name="relaxLocality" type="boolean"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- <param name="relaxLocality" type="boolean"/>
- <param name="labelExpression" type="java.lang.String"/>
- </method>
- <method name="isAnyLocation" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostName" type="java.lang.String"/>
- <doc>
- <![CDATA[Check whether the given <em>host/rack</em> string represents an arbitrary
- host name.
- @param hostName <em>host/rack</em> on which the allocation is desired
- @return whether the given <em>host/rack</em> string represents an arbitrary
- host name]]>
- </doc>
- </method>
- <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Priority</code> of the request.
- @return <code>Priority</code> of the request]]>
- </doc>
- </method>
- <method name="setPriority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <doc>
- <![CDATA[Set the <code>Priority</code> of the request
- @param priority <code>Priority</code> of the request]]>
- </doc>
- </method>
- <method name="getResourceName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the resource (e.g. <em>host/rack</em>) on which the allocation
- is desired.
- A special value of <em>*</em> signifies that <em>any</em> resource
- (host/rack) is acceptable.
- @return resource (e.g. <em>host/rack</em>) on which the allocation
- is desired]]>
- </doc>
- </method>
- <method name="setResourceName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the resource name (e.g. <em>host/rack</em>) on which the allocation
- is desired.
- A special value of <em>*</em> signifies that <em>any</em> resource name
- (e.g. host/rack) is acceptable.
- @param resourceName (e.g. <em>host/rack</em>) on which the
- allocation is desired]]>
- </doc>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Resource</code> capability of the request.
- @return <code>Resource</code> capability of the request]]>
- </doc>
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <doc>
- <![CDATA[Set the <code>Resource</code> capability of the request
- @param capability <code>Resource</code> capability of the request]]>
- </doc>
- </method>
- <method name="getNumContainers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of containers required with the given specifications.
- @return number of containers required with the given specifications]]>
- </doc>
- </method>
- <method name="setNumContainers"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numContainers" type="int"/>
- <doc>
- <![CDATA[Set the number of containers required with the given specifications
- @param numContainers number of containers required with the given
- specifications]]>
- </doc>
- </method>
- <method name="getRelaxLocality" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get whether locality relaxation is enabled with this
- <code>ResourceRequest</code>. Defaults to true.
- @return whether locality relaxation is enabled with this
- <code>ResourceRequest</code>.]]>
- </doc>
- </method>
- <method name="setRelaxLocality"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relaxLocality" type="boolean"/>
- <doc>
- <![CDATA[<p>For a request at a network hierarchy level, set whether locality can be relaxed
- to that level and beyond.<p>
- <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
- containers at that request's priority will not be assigned to nodes on that
- request's rack unless requests specifically for those nodes have also been
- submitted.<p>
- <p>If the flag is off on an {@link ResourceRequest#ANY}-level
- <code>ResourceRequest</code>, containers at that request's priority will
- only be assigned on racks for which specific requests have also been
- submitted.<p>
- <p>For example, to request a container strictly on a specific node, the
- corresponding rack-level and any-level requests should have locality
- relaxation set to false. Similarly, to request a container strictly on a
- specific rack, the corresponding any-level request should have locality
- relaxation set to false.<p>
- @param relaxLocality whether locality relaxation is enabled with this
- <code>ResourceRequest</code>.]]>
- </doc>
- </method>
- <method name="getNodeLabelExpression" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get node-label-expression for this Resource Request. If this is set, all
- containers allocated to satisfy this resource-request will be only on those
- nodes that satisfy this node-label-expression.
- Please note that node label expression now can only take effect when the
- resource request has resourceName = ANY
- @return node-label-expression]]>
- </doc>
- </method>
- <method name="setNodeLabelExpression"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodelabelExpression" type="java.lang.String"/>
- <doc>
- <![CDATA[Set node label expression of this resource request. Now only support
- specifying a single node label. In the future we will support more complex
- node label expression specification like {@code AND(&&), OR(||)}, etc.
- Any please note that node label expression now can only take effect when
- the resource request has resourceName = ANY
- @param nodelabelExpression
- node-label-expression of this ResourceRequest]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- </method>
- <field name="ANY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The constant string representing no locality.
- It should be used by all references that want to pass an arbitrary host
- name in.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[{@code ResourceRequest} represents the request made
- by an application to the {@code ResourceManager}
- to obtain various {@code Container} allocations.
- <p>
- It includes:
- <ul>
- <li>{@link Priority} of the request.</li>
- <li>
- The <em>name</em> of the machine or rack on which the allocation is
- desired. A special value of <em>*</em> signifies that
- <em>any</em> host/rack is acceptable to the application.
- </li>
- <li>{@link Resource} required for each request.</li>
- <li>
- Number of containers, of above specifications, which are required
- by the application.
- </li>
- <li>
- A boolean <em>relaxLocality</em> flag, defaulting to {@code true},
- which tells the {@code ResourceManager} if the application wants
- locality to be loose (i.e. allows fall-through to rack or <em>any</em>)
- or strict (i.e. specify hard constraint on resource allocation).
- </li>
- </ul>
- @see Resource
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
- <class name="ResourceRequest.ResourceRequestComparator" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.Comparator"/>
- <implements name="java.io.Serializable"/>
- <constructor name="ResourceRequest.ResourceRequestComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r1" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- <param name="r2" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
- <!-- start class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
- <class name="StrictPreemptionContract" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StrictPreemptionContract"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getContainers" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the set of {@link PreemptionContainer} specifying containers owned by
- the <code>ApplicationMaster</code> that may be reclaimed by the
- <code>ResourceManager</code>.
- @return the set of {@link ContainerId} to be preempted.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Enumeration of particular allocations to be reclaimed. The platform will
- reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM)
- may attempt to checkpoint work or adjust its execution plan to accommodate
- it. In contrast to {@link PreemptionContract}, the AM has no flexibility in
- selecting which resources to return to the cluster.
- @see PreemptionMessage]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
- <!-- start class org.apache.hadoop.yarn.api.records.Token -->
- <class name="Token" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getIdentifier" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token identifier.
- @return token identifier]]>
- </doc>
- </method>
- <method name="getPassword" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token password
- @return token password]]>
- </doc>
- </method>
- <method name="getKind" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token kind.
- @return token kind]]>
- </doc>
- </method>
- <method name="getService" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the service to which the token is allocated.
- @return service to which the token is allocated]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>Token</code> is the security entity used by the framework
- to verify authenticity of any resource.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.Token -->
- <!-- start class org.apache.hadoop.yarn.api.records.URL -->
- <class name="URL" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="URL"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.URL"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scheme" type="java.lang.String"/>
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="file" type="java.lang.String"/>
- </method>
- <method name="getScheme" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the scheme of the URL.
- @return scheme of the URL]]>
- </doc>
- </method>
- <method name="setScheme"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scheme" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the scheme of the URL
- @param scheme scheme of the URL]]>
- </doc>
- </method>
- <method name="getUserInfo" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user info of the URL.
- @return user info of the URL]]>
- </doc>
- </method>
- <method name="setUserInfo"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="userInfo" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the user info of the URL.
- @param userInfo user info of the URL]]>
- </doc>
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the host of the URL.
- @return host of the URL]]>
- </doc>
- </method>
- <method name="setHost"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the host of the URL.
- @param host host of the URL]]>
- </doc>
- </method>
- <method name="getPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the port of the URL.
- @return port of the URL]]>
- </doc>
- </method>
- <method name="setPort"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="port" type="int"/>
- <doc>
- <![CDATA[Set the port of the URL
- @param port port of the URL]]>
- </doc>
- </method>
- <method name="getFile" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the file of the URL.
- @return file of the URL]]>
- </doc>
- </method>
- <method name="setFile"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the file of the URL.
- @param file file of the URL]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>URL</code> represents a serializable {@link java.net.URL}.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.URL -->
- <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
- <class name="YarnApplicationAttemptState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration of various states of a <code>RMAppAttempt</code>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
- <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
- <class name="YarnApplicationState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration of various states of an <code>ApplicationMaster</code>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
- <!-- start class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
- <class name="YarnClusterMetrics" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="YarnClusterMetrics"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNumNodeManagers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of <code>NodeManager</code>s in the cluster.
- @return number of <code>NodeManager</code>s in the cluster]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
- <p>Currently only number of <code>NodeManager</code>s is provided.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
- </package>
- <package name="org.apache.hadoop.yarn.api.records.timeline">
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
- <class name="TimelineDelegationTokenResponse" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineDelegationTokenResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="java.lang.String"/>
- </method>
- <method name="getContent" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="content" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[The response of delegation token related request]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
- <class name="TimelineDomain" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineDomain"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the domain ID
- @return the domain ID]]>
- </doc>
- </method>
- <method name="setId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the domain ID
- @param id the domain ID]]>
- </doc>
- </method>
- <method name="getDescription" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the domain description
- @return the domain description]]>
- </doc>
- </method>
- <method name="setDescription"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="description" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the domain description
- @param description the domain description]]>
- </doc>
- </method>
- <method name="getOwner" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the domain owner
- @return the domain owner]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="owner" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the domain owner. The user doesn't need to set it, which will
- automatically set to the user who puts the domain.
- @param owner the domain owner]]>
- </doc>
- </method>
- <method name="getReaders" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reader (and/or reader group) list string
- @return the reader (and/or reader group) list string]]>
- </doc>
- </method>
- <method name="setReaders"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="readers" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the reader (and/or reader group) list string
- @param readers the reader (and/or reader group) list string]]>
- </doc>
- </method>
- <method name="getWriters" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the writer (and/or writer group) list string
- @return the writer (and/or writer group) list string]]>
- </doc>
- </method>
- <method name="setWriters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writers" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the writer (and/or writer group) list string
- @param writers the writer (and/or writer group) list string]]>
- </doc>
- </method>
- <method name="getCreatedTime" return="java.lang.Long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the created time of the domain
- @return the created time of the domain]]>
- </doc>
- </method>
- <method name="setCreatedTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="createdTime" type="java.lang.Long"/>
- <doc>
- <![CDATA[Set the created time of the domain
- @param createdTime the created time of the domain]]>
- </doc>
- </method>
- <method name="getModifiedTime" return="java.lang.Long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the modified time of the domain
- @return the modified time of the domain]]>
- </doc>
- </method>
- <method name="setModifiedTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="modifiedTime" type="java.lang.Long"/>
- <doc>
- <![CDATA[Set the modified time of the domain
- @param modifiedTime the modified time of the domain]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- This class contains the information about a timeline domain, which is used
- to a user to host a number of timeline entities, isolating them from others'.
- The user can also define the reader and writer users/groups for the the
- domain, which is used to control the access to its entities.
- </p>
- <p>
- The reader and writer users/groups pattern that the user can supply is the
- same as what <code>AccessControlList</code> takes.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
- <class name="TimelineDomains" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineDomains"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getDomains" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of domains
- @return a list of domains]]>
- </doc>
- </method>
- <method name="addDomain"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
- <doc>
- <![CDATA[Add a single domain into the existing domain list
- @param domain
- a single domain]]>
- </doc>
- </method>
- <method name="addDomains"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="domains" type="java.util.List"/>
- <doc>
- <![CDATA[All a list of domains into the existing domain list
- @param domains
- a list of domains]]>
- </doc>
- </method>
- <method name="setDomains"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="domains" type="java.util.List"/>
- <doc>
- <![CDATA[Set the domain list to the given list of domains
- @param domains
- a list of domains]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The class that hosts a list of timeline domains.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
- <class name="TimelineEntities" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineEntities"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getEntities" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of entities
- @return a list of entities]]>
- </doc>
- </method>
- <method name="addEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
- <doc>
- <![CDATA[Add a single entity into the existing entity list
- @param entity
- a single entity]]>
- </doc>
- </method>
- <method name="addEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entities" type="java.util.List"/>
- <doc>
- <![CDATA[All a list of entities into the existing entity list
- @param entities
- a list of entities]]>
- </doc>
- </method>
- <method name="setEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entities" type="java.util.List"/>
- <doc>
- <![CDATA[Set the entity list to the given list of entities
- @param entities
- a list of entities]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The class that hosts a list of timeline entities.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
- <class name="TimelineEntity" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getEntityType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity type
- @return the entity type]]>
- </doc>
- </method>
- <method name="setEntityType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity type
- @param entityType
- the entity type]]>
- </doc>
- </method>
- <method name="getEntityId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity Id
- @return the entity Id]]>
- </doc>
- </method>
- <method name="setEntityId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity Id
- @param entityId
- the entity Id]]>
- </doc>
- </method>
- <method name="getStartTime" return="java.lang.Long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the start time of the entity
- @return the start time of the entity]]>
- </doc>
- </method>
- <method name="setStartTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="startTime" type="java.lang.Long"/>
- <doc>
- <![CDATA[Set the start time of the entity
- @param startTime
- the start time of the entity]]>
- </doc>
- </method>
- <method name="getEvents" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of events related to the entity
- @return a list of events related to the entity]]>
- </doc>
- </method>
- <method name="addEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
- <doc>
- <![CDATA[Add a single event related to the entity to the existing event list
- @param event
- a single event related to the entity]]>
- </doc>
- </method>
- <method name="addEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="events" type="java.util.List"/>
- <doc>
- <![CDATA[Add a list of events related to the entity to the existing event list
- @param events
- a list of events related to the entity]]>
- </doc>
- </method>
- <method name="setEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="events" type="java.util.List"/>
- <doc>
- <![CDATA[Set the event list to the given list of events related to the entity
- @param events
- events a list of events related to the entity]]>
- </doc>
- </method>
- <method name="getRelatedEntities" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the related entities
- @return the related entities]]>
- </doc>
- </method>
- <method name="addRelatedEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityType" type="java.lang.String"/>
- <param name="entityId" type="java.lang.String"/>
- <doc>
- <![CDATA[Add an entity to the existing related entity map
- @param entityType
- the entity type
- @param entityId
- the entity Id]]>
- </doc>
- </method>
- <method name="addRelatedEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relatedEntities" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a map of related entities to the existing related entity map
- @param relatedEntities
- a map of related entities]]>
- </doc>
- </method>
- <method name="setRelatedEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relatedEntities" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the related entity map to the given map of related entities
- @param relatedEntities
- a map of related entities]]>
- </doc>
- </method>
- <method name="getPrimaryFilters" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the primary filters
- @return the primary filters]]>
- </doc>
- </method>
- <method name="addPrimaryFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Add a single piece of primary filter to the existing primary filter map
- @param key
- the primary filter key
- @param value
- the primary filter value]]>
- </doc>
- </method>
- <method name="addPrimaryFilters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="primaryFilters" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a map of primary filters to the existing primary filter map
- @param primaryFilters
- a map of primary filters]]>
- </doc>
- </method>
- <method name="setPrimaryFilters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="primaryFilters" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the primary filter map to the given map of primary filters
- @param primaryFilters
- a map of primary filters]]>
- </doc>
- </method>
- <method name="getOtherInfo" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the other information of the entity
- @return the other information of the entity]]>
- </doc>
- </method>
- <method name="addOtherInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Add one piece of other information of the entity to the existing other info
- map
- @param key
- the other information key
- @param value
- the other information value]]>
- </doc>
- </method>
- <method name="addOtherInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="otherInfo" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a map of other information of the entity to the existing other info map
- @param otherInfo
- a map of other information]]>
- </doc>
- </method>
- <method name="setOtherInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="otherInfo" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the other info map to the given map of other information
- @param otherInfo
- a map of other information]]>
- </doc>
- </method>
- <method name="getDomainId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the ID of the domain that the entity is to be put
- @return the domain ID]]>
- </doc>
- </method>
- <method name="setDomainId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="domainId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the ID of the domain that the entity is to be put
- @param domainId
- the name space ID]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
- </method>
- <doc>
- <![CDATA[<p>
- The class that contains the the meta information of some conceptual entity
- and its related events. The entity can be an application, an application
- attempt, a container or whatever the user-defined object.
- </p>
- <p>
- Primary filters will be used to index the entities in
- <code>TimelineStore</code>, such that users should carefully choose the
- information they want to store as the primary filters. The remaining can be
- stored as other information.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
- <class name="TimelineEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="TimelineEvent"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTimestamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the timestamp of the event
- @return the timestamp of the event]]>
- </doc>
- </method>
- <method name="setTimestamp"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timestamp" type="long"/>
- <doc>
- <![CDATA[Set the timestamp of the event
- @param timestamp
- the timestamp of the event]]>
- </doc>
- </method>
- <method name="getEventType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type
- @return the event type]]>
- </doc>
- </method>
- <method name="setEventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the event type
- @param eventType
- the event type]]>
- </doc>
- </method>
- <method name="getEventInfo" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set the information of the event
- @return the information of the event]]>
- </doc>
- </method>
- <method name="addEventInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Add one piece of the information of the event to the existing information
- map
- @param key
- the information key
- @param value
- the information value]]>
- </doc>
- </method>
- <method name="addEventInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventInfo" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a map of the information of the event to the existing information map
- @param eventInfo
- a map of of the information of the event]]>
- </doc>
- </method>
- <method name="setEventInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventInfo" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the information map to the given map of the information of the event
- @param eventInfo
- a map of of the information of the event]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[The class that contains the information of an event that is related to some
- conceptual entity of an application. Users are free to define what the event
- means, such as starting an application, getting allocated a container and
- etc.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
- <class name="TimelineEvents" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineEvents"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAllEvents" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of {@link EventsOfOneEntity} instances
- @return a list of {@link EventsOfOneEntity} instances]]>
- </doc>
- </method>
- <method name="addEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventsOfOneEntity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity"/>
- <doc>
- <![CDATA[Add a single {@link EventsOfOneEntity} instance into the existing list
- @param eventsOfOneEntity
- a single {@link EventsOfOneEntity} instance]]>
- </doc>
- </method>
- <method name="addEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allEvents" type="java.util.List"/>
- <doc>
- <![CDATA[Add a list of {@link EventsOfOneEntity} instances into the existing list
- @param allEvents
- a list of {@link EventsOfOneEntity} instances]]>
- </doc>
- </method>
- <method name="setEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allEvents" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list to the given list of {@link EventsOfOneEntity} instances
- @param allEvents
- a list of {@link EventsOfOneEntity} instances]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The class that hosts a list of events, which are categorized according to
- their related entities.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
- <class name="TimelineEvents.EventsOfOneEntity" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineEvents.EventsOfOneEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getEntityId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity Id
- @return the entity Id]]>
- </doc>
- </method>
- <method name="setEntityId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity Id
- @param entityId
- the entity Id]]>
- </doc>
- </method>
- <method name="getEntityType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity type
- @return the entity type]]>
- </doc>
- </method>
- <method name="setEntityType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity type
- @param entityType
- the entity type]]>
- </doc>
- </method>
- <method name="getEvents" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of events
- @return a list of events]]>
- </doc>
- </method>
- <method name="addEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
- <doc>
- <![CDATA[Add a single event to the existing event list
- @param event
- a single event]]>
- </doc>
- </method>
- <method name="addEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="events" type="java.util.List"/>
- <doc>
- <![CDATA[Add a list of event to the existing event list
- @param events
- a list of events]]>
- </doc>
- </method>
- <method name="setEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="events" type="java.util.List"/>
- <doc>
- <![CDATA[Set the event list to the given list of events
- @param events
- a list of events]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The class that hosts a list of events that are only related to one entity.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
- <class name="TimelinePutResponse" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelinePutResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getErrors" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of {@link TimelinePutError} instances
- @return a list of {@link TimelinePutError} instances]]>
- </doc>
- </method>
- <method name="addError"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="error" type="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError"/>
- <doc>
- <![CDATA[Add a single {@link TimelinePutError} instance into the existing list
- @param error
- a single {@link TimelinePutError} instance]]>
- </doc>
- </method>
- <method name="addErrors"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="errors" type="java.util.List"/>
- <doc>
- <![CDATA[Add a list of {@link TimelinePutError} instances into the existing list
- @param errors
- a list of {@link TimelinePutError} instances]]>
- </doc>
- </method>
- <method name="setErrors"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="errors" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list to the given list of {@link TimelinePutError} instances
- @param errors
- a list of {@link TimelinePutError} instances]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A class that holds a list of put errors. This is the response returned when a
- list of {@link TimelineEntity} objects is added to the timeline. If there are errors
- in storing individual entity objects, they will be indicated in the list of
- errors.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
- <class name="TimelinePutResponse.TimelinePutError" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelinePutResponse.TimelinePutError"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getEntityId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity Id
- @return the entity Id]]>
- </doc>
- </method>
- <method name="setEntityId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity Id
- @param entityId
- the entity Id]]>
- </doc>
- </method>
- <method name="getEntityType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity type
- @return the entity type]]>
- </doc>
- </method>
- <method name="setEntityType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity type
- @param entityType
- the entity type]]>
- </doc>
- </method>
- <method name="getErrorCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the error code
- @return an error code]]>
- </doc>
- </method>
- <method name="setErrorCode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="errorCode" type="int"/>
- <doc>
- <![CDATA[Set the error code to the given error code
- @param errorCode
- an error code]]>
- </doc>
- </method>
- <field name="NO_START_TIME" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned when no start time can be found when putting an
- entity. This occurs when the entity does not already exist in the store
- and it is put with no start time or events specified.]]>
- </doc>
- </field>
- <field name="IO_EXCEPTION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if an IOException is encountered when putting an
- entity.]]>
- </doc>
- </field>
- <field name="SYSTEM_FILTER_CONFLICT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if the user specifies the timeline system reserved
- filter key]]>
- </doc>
- </field>
- <field name="ACCESS_DENIED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if the user is denied to access the timeline data]]>
- </doc>
- </field>
- <field name="NO_DOMAIN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if the entity doesn't have an valid domain ID]]>
- </doc>
- </field>
- <field name="FORBIDDEN_RELATION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if the user is denied to relate the entity to another
- one in different domain]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A class that holds the error code for one entity.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
- </package>
- <package name="org.apache.hadoop.yarn.conf">
- <!-- start class org.apache.hadoop.yarn.conf.YarnConfiguration -->
- <class name="YarnConfiguration" extends="org.apache.hadoop.conf.Configuration"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="YarnConfiguration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YarnConfiguration" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSocketAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultAddress" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Get the socket address for <code>name</code> property as a
- <code>InetSocketAddress</code>. On a HA cluster,
- this fetches the address corresponding to the RM identified by
- {@link #RM_HA_ID}.
- @param name property name.
- @param defaultAddress the default value
- @param defaultPort the default port
- @return InetSocketAddress]]>
- </doc>
- </method>
- <method name="updateConnectAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- </method>
- <method name="useHttps" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="shouldRMFailFast" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <field name="CS_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_POLICY_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SITE_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CORE_SITE_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CONFIGURATION_FILES" type="java.util.List"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_MAX_TAGS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_MAX_TAG_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEBUG_NM_DELETE_DELAY_SEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Delay before deleting resource to ease debugging of NM issues]]>
- </doc>
- </field>
- <field name="IPC_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Factory to create client IPC classes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Factory to create server IPC classes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Factory to create serializeable records.]]>
- </doc>
- </field>
- <field name="DEFAULT_IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_RPC_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[RPC class implementation]]>
- </doc>
- </field>
- <field name="DEFAULT_IPC_RPC_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CLUSTER_ID" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_HOSTNAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the applications manager interface in the RM.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The actual bind address for the RM.]]>
- </doc>
- </field>
- <field name="RM_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of threads used to handle applications manager requests.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_AMLAUNCHER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads used to launch/cleanup AM.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_AMLAUNCHER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODEMANAGER_CONNECT_RETIRES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retry times to connect with NM.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NODEMANAGER_CONNECT_RETIRES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PRINCIPAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Kerberos principal for the resource manager.]]>
- </doc>
- </field>
- <field name="RM_SCHEDULER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the scheduler interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SCHEDULER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Miniumum request grant-able by the RM scheduler.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Maximum request grant-able by the RM scheduler.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads to handle scheduler interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If the port should be included or not in the node name. The node name
- is used by the scheduler for resource requests allocation location
- matching. Typically this is just the hostname, using the port is needed
- when using minicluster and specific NM are required.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_WEBAPP_UI_ACTIONS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable Resource Manager webapp ui actions]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_WEBAPP_UI_ACTIONS_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_RESERVATION_SYSTEM_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the RM should enable Reservation System]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_RESERVATION_SYSTEM_ENABLE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_RESERVATION_SYSTEM_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The class to use as the Reservation System.]]>
- </doc>
- </field>
- <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The PlanFollower for the Reservation System.]]>
- </doc>
- </field>
- <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The step size of the Reservation System.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_ENABLE_MONITORS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable periodic monitor threads.
- @see #RM_SCHEDULER_MONITOR_POLICIES]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_ENABLE_MONITORS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MONITOR_POLICIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[List of SchedulingEditPolicy classes affecting the scheduler.]]>
- </doc>
- </field>
- <field name="RM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the RM web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_WEBAPP_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The https address of the RM web application.]]>
- </doc>
- </field>
- <field name="YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SSL_SERVER_RESOURCE_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WEBAPP_HTTPS_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_RESOURCE_TRACKER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_AM_EXPIRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The expiry interval for application master reporting.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_AM_EXPIRY_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NM_EXPIRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long to wait until a node manager is considered dead.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NM_EXPIRY_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_ACL_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Are acls enabled.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_ACL_ENABLE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_ADMIN_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ACL of who can be admin of YARN cluster.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_ADMIN_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_YARN_APP_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ACL used in case none is found. Allows nothing.]]>
- </doc>
- </field>
- <field name="YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/disable intermediate-data encryption at YARN level. For now, this
- only is used by the FileSystemRMStateStore to setup right file-system
- security attributes.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.Boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ADMIN_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the RM admin interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_ADMIN_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ADMIN_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads used to handle RM admin interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_AM_MAX_ATTEMPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum number of application attempts.
- It's a global setting for all application masters.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_AM_MAX_ATTEMPTS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_KEYTAB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The keytab for the resource manager.]]>
- </doc>
- </field>
- <field name="RM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos principal to be used for spnego filter for RM.]]>
- </doc>
- </field>
- <field name="RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos keytab to be used for spnego filter for RM.]]>
- </doc>
- </field>
- <field name="RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flag to enable override of the default kerberos authentication filter with
- the RM authentication filter to allow authentication using delegation
- tokens(fallback to kerberos if the tokens are missing). Only applicable
- when the http authentication type is kerberos.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable cross origin (CORS) support.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long to wait until a container is considered dead.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Path to file with nodes to include.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Path to file with nodes to exclude.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads to handle resource tracker calls.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The class to use as the resource scheduler.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NM_HEARTBEAT_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[RM set next Heartbeat interval for NM]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of worker threads that write the history data.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting that controls whether yarn system metrics is published on the
- timeline server or not by RM.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RECOVERY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_RECOVERY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_FAIL_FAST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_YARN_FAIL_FAST" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_FAIL_FAST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_WORK_PRESERVING_RECOVERY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Zookeeper interaction configs]]>
- </doc>
- </field>
- <field name="RM_ZK_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_NUM_RETRIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ZK_RM_NUM_RETRIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_RETRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ZK_RETRY_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_TIMEOUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ZK_TIMEOUT_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ZK_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_AUTH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ZK_STATE_STORE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Parent znode path under which ZKRMStateStore will create znodes]]>
- </doc>
- </field>
- <field name="DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ZK_RM_STATE_STORE_ROOT_NODE_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Root node ACLs for fencing]]>
- </doc>
- </field>
- <field name="RM_HA_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[HA related configs]]>
- </doc>
- </field>
- <field name="RM_HA_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_HA_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_HA_IDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_HA_ID" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_BASED_RM_CONF_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Store the related configuration files in File System]]>
- </doc>
- </field>
- <field name="DEFAULT_FS_BASED_RM_CONF_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_AUTHORIZATION_PROVIDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AUTO_FAILOVER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AUTO_FAILOVER_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AUTO_FAILOVER_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AUTO_FAILOVER_EMBEDDED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_MAX_ATTEMPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_SLEEPTIME_BASE_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_SLEEPTIME_MAX_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_RETRIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CLIENT_FAILOVER_RETRIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The class to use as the persistent store.]]>
- </doc>
- </field>
- <field name="FS_RM_STATE_STORE_URI" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[URI for FileSystemRMStateStore]]>
- </doc>
- </field>
- <field name="FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_RM_STATE_STORE_NUM_RETRIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FS_RM_STATE_STORE_NUM_RETRIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_LEVELDB_STORE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum number of completed applications RM keeps.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_MAX_COMPLETED_APPLICATIONS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum number of completed applications RM state store keeps, by
- default equals to DEFAULT_RM_MAX_COMPLETED_APPLICATIONS]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_APPLICATION_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default application name]]>
- </doc>
- </field>
- <field name="DEFAULT_APPLICATION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default application type]]>
- </doc>
- </field>
- <field name="APPLICATION_TYPE_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default application type length]]>
- </doc>
- </field>
- <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default queue name]]>
- </doc>
- </field>
- <field name="RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Buckets (in minutes) for the number of apps running in each queue.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default sizes of the runtime metric buckets in minutes.]]>
- </doc>
- </field>
- <field name="RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PROXY_USER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[RM proxy users' prefix]]>
- </doc>
- </field>
- <field name="NM_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prefix for all node manager configs.]]>
- </doc>
- </field>
- <field name="NM_ADMIN_USER_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Environment variables that will be sent to containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_ADMIN_USER_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_ENV_WHITELIST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Environment variables that containers may override rather than use NodeManager's default.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_ENV_WHITELIST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[address of node manager IPC.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The actual bind address or the NM.]]>
- </doc>
- </field>
- <field name="NM_CONTAINER_EXECUTOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[who will execute(launch) the containers.]]>
- </doc>
- </field>
- <field name="NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Adjustment to make to the container os scheduling priority.
- The valid values for this could vary depending on the platform.
- On Linux, higher values mean run the containers at a less
- favorable priority than the NM.
- The value specified is an int.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_MGR_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads container manager uses.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_DELETE_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads used in cleanup.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DELETE_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_KEYTAB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Keytab for NM.]]>
- </doc>
- </field>
- <field name="NM_LOCAL_DIRS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[List of directories to store localized files in.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCAL_DIRS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of files in each localized directories
- Avoid tuning this too low.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Address where the localizer IPC is.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_LOCALIZER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Interval in between cache cleanups.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Target size of localizer cache in MB, per nodemanager. It is a target
- retention size that only includes resources with PUBLIC and PRIVATE
- visibility and excludes resources with APPLICATION visibility]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads to handle localization requests.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_FETCH_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads to use for localization fetching.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_DIRS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Where to store container logs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_DIRS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Interval at which the delayed token removal thread runs]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Delegation Token renewer thread count]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PROXY_USER_PRIVILEGES_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG_AGGREGATION_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether to enable log aggregation]]>
- </doc>
- </field>
- <field name="DEFAULT_LOG_AGGREGATION_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG_AGGREGATION_RETAIN_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long to wait before deleting aggregated logs, -1 disables.
- Be careful set this too small and you will spam the name node.]]>
- </doc>
- </field>
- <field name="DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long to wait between aggregated log retention checks. If set to
- a value {@literal <=} 0 then the value is computed as one-tenth of the
- log retention setting. Be careful set this too small and you will spam
- the name node.]]>
- </doc>
- </field>
- <field name="DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_RETAIN_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of seconds to retain logs on the NodeManager. Only applicable if Log
- aggregation is disabled]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_RETAIN_SECONDS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Define how often NMs wake up and upload log files]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_DELETION_THREADS_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads used in log cleanup. Only applicable if Log aggregation
- is disabled]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_DELETE_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Where to aggregate logs to.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The remote log dir will be created at
- NM_REMOTE_APP_LOG_DIR/${user}/NM_REMOTE_APP_LOG_DIR_SUFFIX/${appId}]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_LOG_SERVER_URL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_TRACKING_URL_GENERATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PMEM_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Amount of memory in GB that can be allocated for containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PMEM_MB" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PMEM_CHECK_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies whether physical memory check is enabled.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PMEM_CHECK_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_VMEM_CHECK_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies whether physical memory check is enabled.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_VMEM_CHECK_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_VMEM_PMEM_RATIO" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Conversion ratio for physical memory to virtual memory.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_VMEM_PMEM_RATIO" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_VCORES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of Virtual CPU Cores which can be allocated for containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_VCORES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Percentage of overall CPU which can be allocated for containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[NM Webapp address.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_WEBAPP_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[NM Webapp https address.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_WEBAPP_HTTPS_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/disable CORS filter.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_MON_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How often to monitor containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_MON_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_MON_RESOURCE_CALCULATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Class that calculates containers current resource utilization.]]>
- </doc>
- </field>
- <field name="NM_CONTAINER_MON_PROCESS_TREE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Class that calculates process tree resource utilization.]]>
- </doc>
- </field>
- <field name="PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_METRICS_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/disable container metrics.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_METRICS_ENABLE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_METRICS_PERIOD_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container metrics flush period. -1 for flush on completion.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_METRICS_PERIOD_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The delay time ms to unregister container metrics after completion.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_DISK_HEALTH_CHECK_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/Disable disks' health checker. Default is true. An expert level
- configuration property.]]>
- </doc>
- </field>
- <field name="NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Frequency of running disks' health checker.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[By default, disks' health is checked every 2 minutes.]]>
- </doc>
- </field>
- <field name="NM_MIN_HEALTHY_DISKS_FRACTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The minimum fraction of number of disks to be healthy for the nodemanager
- to launch new containers. This applies to nm-local-dirs and nm-log-dirs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[By default, at least 25% of disks are to be healthy to say that the node is
- healthy in terms of disks.]]>
- </doc>
- </field>
- <field name="NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum percentage of disk space that can be used after which a disk is
- marked as offline. Values can range from 0.0 to 100.0. If the value is
- greater than or equal to 100, NM will check for full disk. This applies to
- nm-local-dirs and nm-log-dirs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[By default, 90% of the disk can be used before it is marked as offline.]]>
- </doc>
- </field>
- <field name="NM_MIN_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The minimum space that must be available on a local dir for it to be used.
- This applies to nm-local-dirs and nm-log-dirs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[By default, all of the disk can be used before it is marked as offline.]]>
- </doc>
- </field>
- <field name="NM_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Frequency of running node health script.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Health check script time out period.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_HEALTH_CHECK_SCRIPT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The health check script to run.]]>
- </doc>
- </field>
- <field name="NM_HEALTH_CHECK_SCRIPT_OPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The arguments to pass to the health check script.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_CONTAINER_EXECUTOR_IMAGE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Docker image name(For DockerContainerExecutor).]]>
- </doc>
- </field>
- <field name="NM_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name of the docker executor (For DockerContainerExecutor).]]>
- </doc>
- </field>
- <field name="NM_DEFAULT_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default docker executor (For DockerContainerExecutor).]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_EXECUTOR_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The path to the Linux container executor.]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_GROUP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The UNIX group that the linux-container-executor should run as.
- This is intended to be set as part of container-executor.cfg.]]>
- </doc>
- </field>
- <field name="NM_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If linux-container-executor should limit itself to one user
- when running in non-secure mode.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NONSECURE_MODE_LOCAL_USER_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The UNIX user that containers will run as when Linux-container-executor
- is used in nonsecure mode (a use case for this is using cgroups).]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NONSECURE_MODE_LOCAL_USER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NONSECURE_MODE_USER_PATTERN_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The allowed pattern for UNIX user names enforced by
- Linux-container-executor when used in nonsecure mode (use case for this
- is using cgroups). The default value is taken from /usr/sbin/adduser]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NONSECURE_MODE_USER_PATTERN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LINUX_CONTAINER_RESOURCES_HANDLER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The type of resource enforcement to use with the
- linux container executor.]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_HIERARCHY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The path the linux container executor should use for cgroups]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the linux container executor should mount cgroups if not found]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Where the linux container executor should mount cgroups if not found]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the apps should run in strict resource usage mode(not allowed to
- use spare CPU)]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Interval of time the linux container executor should try cleaning up
- cgroups entry when cleaning up a container. This is required due to what
- it seems a race condition because the SIGTERM/SIGKILL is asynch.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Delay between attempts to remove linux cgroup.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Indicates if memory and CPU limits will be set for the Windows Job
- Object for the containers launched by the default container executor.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WINDOWS_SECURE_CONTAINER_GROUP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[/* The Windows group that the windows-secure-container-executor should run as.]]>
- </doc>
- </field>
- <field name="NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[T-file compression types used to compress aggregated logs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PRINCIPAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos principal for the node manager.]]>
- </doc>
- </field>
- <field name="NM_AUX_SERVICES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_AUX_SERVICE_FMT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_USER_HOME_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos principal to be used for spnego filter for NM.]]>
- </doc>
- </field>
- <field name="NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos keytab to be used for spnego filter for NM.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_USER_HOME_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RECOVERY_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RECOVERY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_RECOVERY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RECOVERY_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PROXY_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PROXY_PRINCIPAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos principal for the proxy.]]>
- </doc>
- </field>
- <field name="PROXY_KEYTAB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Keytab for Proxy.]]>
- </doc>
- </field>
- <field name="PROXY_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address for the web proxy.]]>
- </doc>
- </field>
- <field name="DEFAULT_PROXY_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_PROXY_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[YARN Service Level Authorization]]>
- </doc>
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[No. of milliseconds to wait between sending a SIGTERM and SIGKILL
- to a running container]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PROCESS_KILL_WAIT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max time to wait for a process to come up when trying to cleanup
- container resources]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PROCESS_KILL_WAIT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max time to wait to establish a connection to RM]]>
- </doc>
- </field>
- <field name="DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Time interval between each attempt to connect to RM]]>
- </doc>
- </field>
- <field name="DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_APPLICATION_CLASSPATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
- entries]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default platform-agnostic CLASSPATH for YARN applications. A
- comma-separated list of CLASSPATH entries. The parameter expansion marker
- will be replaced with real parameter expansion marker ('%' for Windows and
- '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
- will be replaced as $VAR on Linux, and %VAR% on Windows.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_APPLICATION_CLASSPATH" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Default platform-specific CLASSPATH for YARN applications. A
- comma-separated list of CLASSPATH entries constructed based on the client
- OS environment expansion syntax.
- </p>
- <p>
- Note: Use {@link #DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
- cross-platform practice i.e. submit an application from a Windows client to
- a Linux/Unix server or vice versa.
- </p>]]>
- </doc>
- </field>
- <field name="DEFAULT_CONTAINER_TEMP_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container temp directory]]>
- </doc>
- </field>
- <field name="IS_MINI_YARN_CLUSTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_MC_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_MINICLUSTER_FIXED_PORTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether to use fixed ports with the minicluster.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_MINICLUSTER_FIXED_PORTS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default is false to be able to run tests concurrently without port
- conflicts.]]>
- </doc>
- </field>
- <field name="YARN_MINICLUSTER_USE_RPC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the NM should use RPC to connect to the RM. Default is false.
- Can be set to true only when using fixed ports.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_MINICLUSTER_USE_RPC" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether users are explicitly trying to control resource monitoring
- configuration for the MiniYARNCluster. Disabled by default.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_MINICLUSTER_NM_PMEM_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Allow changing the memory for the NodeManager in the MiniYARNCluster]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_MINICLUSTER_NM_PMEM_MB" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_APP_CONTAINER_LOG_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The log directory for the containers]]>
- </doc>
- </field>
- <field name="YARN_APP_CONTAINER_LOG_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_APP_CONTAINER_LOG_BACKUPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_UI_NAMES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Comma seperated list of names for UIs hosted in the timeline server
- (For pluggable UIs).]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_UI_WEB_PATH_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Relative web path that will serve up this UI (For pluggable UIs).]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_UI_ON_DISK_PATH_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Path to war file or static content directory for this UI
- (For pluggable UIs).]]>
- </doc>
- </field>
- <field name="APPLICATION_HISTORY_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_HISTORY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting that controls whether application history service is
- enabled or not.]]>
- </doc>
- </field>
- <field name="DEFAULT_APPLICATION_HISTORY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_HISTORY_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Application history store class]]>
- </doc>
- </field>
- <field name="APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Save container meta-info in the application history store.]]>
- </doc>
- </field>
- <field name="DEFAULT_APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_APPLICATION_HISTORY_STORE_URI" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[URI for FileSystemApplicationHistoryStore]]>
- </doc>
- </field>
- <field name="FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[T-file compression types used to compress history data.]]>
- </doc>
- </field>
- <field name="DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting that controls whether timeline service is enabled or not.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[host:port address for timeline service RPC APIs.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The listening endpoint for the timeline service application.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_HANDLER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of threads to handle client RPC API requests.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the timeline service web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The https address of the timeline service web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_HISTORY_MAX_APPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Defines the max number of applications could be fetched using
- REST API or application history protocol and shown in timeline
- server web ui.]]>
- </doc>
- </field>
- <field name="DEFAULT_APPLICATION_HISTORY_MAX_APPS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service store class]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_TTL_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service enable data age off]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_TTL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service length of time to retain data]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_TTL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb path]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb read cache (uncompressed blocks)]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb start time read cache (number of entities)]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb start time write cache (number of entities)]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb interval to wait between deletion rounds]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_PRINCIPAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Kerberos principal for the timeline server.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_KEYTAB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Kerberos keytab for the timeline server.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enables cross origin support for timeline server.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for cross origin support for timeline server.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline client settings]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline client call, max retries (-1 means no limit)]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline client call, retry interval]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline client policy for whether connections are fatal]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_RECOVERY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flag to enable recovery of timeline service]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_RECOVERY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_STATE_STORE_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service state store class]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service state store leveldb path]]>
- </doc>
- </field>
- <field name="TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[whether the shared cache is enabled/disabled]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_ROOT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The config key for the shared cache root directory.]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_ROOT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_NESTED_LEVEL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The config key for the level of nested directories before getting to the
- checksum directory.]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_NESTED_LEVEL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_STORE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_STORE_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_STORE_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_APP_CHECKER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_APP_CHECKER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_ADMIN_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the SCM admin interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_ADMIN_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_ADMIN_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads used to handle SCM admin interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_ADMIN_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the SCM web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_WEBAPP_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_MEMORY_STORE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_MEMORY_STALENESS_PERIOD_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A resource in the InMemorySCMStore is considered stale if the time since
- the last reference exceeds the staleness period. This value is specified in
- minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IN_MEMORY_STALENESS_PERIOD_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_MEMORY_INITIAL_DELAY_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Initial delay before the in-memory store runs its first check to remove
- dead initial applications. Specified in minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IN_MEMORY_INITIAL_DELAY_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_MEMORY_CHECK_PERIOD_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The frequency at which the in-memory store checks to remove dead initial
- applications. Specified in minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IN_MEMORY_CHECK_PERIOD_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLEANER_PERIOD_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The frequency at which a cleaner task runs. Specified in minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLEANER_PERIOD_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLEANER_INITIAL_DELAY_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Initial delay before the first cleaner task is scheduled. Specified in
- minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLEANER_INITIAL_DELAY_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLEANER_RESOURCE_SLEEP_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The time to sleep between processing each shared cache resource. Specified
- in milliseconds.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLEANER_RESOURCE_SLEEP_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the node manager interface in the SCM.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_UPLOADER_SERVER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_UPLOADER_SERVER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of SCM threads used to handle notify requests from the node
- manager.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_UPLOADER_SERVER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the client interface in the SCM.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLIENT_SERVER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLIENT_SERVER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of threads used to handle shared cache manager requests.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLIENT_SERVER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the checksum algorithm implementation]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The replication factor for the node manager uploader for the shared cache.]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
- The interval of the yarn client's querying application state after
- application submission. The unit is millisecond.]]>
- </doc>
- </field>
- <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The interval that the yarn client library uses to poll the completion
- status of the asynchronous API of application client protocol.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The duration that the yarn client library waits, cumulatively across polls,
- for an expected state change to occur. Defaults to -1, which indicates no
- limit.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max number of threads in NMClientAsync to process container management
- events]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CLIENT_MAX_NM_PROXIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Maximum number of proxy connections to cache for node managers. If set
- to a value greater than zero then the cache is enabled and the NMClient
- and MRAppMaster will cache the specified number of node manager proxies.
- There will be at max one proxy per node manager. Ex. configuring it to a
- value of 5 will make sure that client will at max have 5 proxies cached
- with 5 different node managers. These connections for these proxies will
- be timed out if idle for more than the system wide idle timeout period.
- Note that this could cause issues on large clusters as many connections
- could linger simultaneously and lead to a large number of connection
- threads. The token used for authentication will be used only at
- connection creation time. If a new token is received then the earlier
- connection should be closed in order to use the new token. This and
- {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
- and should be in sync (no need for them to be equal).
- If the value of this property is zero then the connection cache is
- disabled and connections will use a zero idle timeout to prevent too
- many connection threads on large clusters.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CLIENT_MAX_NM_PROXIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_NM_CONNECT_MAX_WAIT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max time to wait to establish a connection to NM]]>
- </doc>
- </field>
- <field name="DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Time interval between each attempt to connect to NM]]>
- </doc>
- </field>
- <field name="DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_HTTP_POLICY_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_HTTP_POLICY_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NODE_LABELS_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Node-labels configurations]]>
- </doc>
- </field>
- <field name="FS_NODE_LABELS_STORE_ROOT_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[URI for NodeLabelManager]]>
- </doc>
- </field>
- <field name="FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NODE_LABELS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flag to indicate if the node labels feature enabled, by default it's
- disabled]]>
- </doc>
- </field>
- <field name="DEFAULT_NODE_LABELS_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.yarn.conf.YarnConfiguration -->
- </package>
- <package name="org.apache.hadoop.yarn.exceptions">
- <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
- <class name="ApplicationAttemptNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationAttemptNotFoundException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown on
- {@link ApplicationHistoryProtocol#getApplicationAttemptReport (GetApplicationAttemptReportRequest)}
- API when the Application Attempt doesn't exist in Application History Server or
- {@link ApplicationMasterProtocol#allocate(AllocateRequest)} if application
- doesn't exist in RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
- <class name="ApplicationIdNotProvidedException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationIdNotProvidedException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationIdNotProvidedException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationIdNotProvidedException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Exception to be thrown when Client submit an application without
- providing {@link ApplicationId} in {@link ApplicationSubmissionContext}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationMasterNotRegisteredException -->
- <class name="ApplicationMasterNotRegisteredException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when an Application Master tries to unregister by calling
- {@link ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)}
- API without first registering by calling
- {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
- or after an RM restart. The ApplicationMaster is expected to call
- {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
- and retry.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationMasterNotRegisteredException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
- <class name="ApplicationNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationNotFoundException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationNotFoundException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationNotFoundException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown on
- {@link ApplicationClientProtocol#getApplicationReport
- (GetApplicationReportRequest)} API
- when the Application doesn't exist in RM and AHS]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
- <class name="ContainerNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerNotFoundException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerNotFoundException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerNotFoundException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown on
- {@link ApplicationHistoryProtocol#getContainerReport (GetContainerReportRequest)}
- API when the container doesn't exist in AHS]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidApplicationMasterRequestException -->
- <class name="InvalidApplicationMasterRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidApplicationMasterRequestException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidApplicationMasterRequestException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidApplicationMasterRequestException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when an ApplicationMaster asks for resources by
- calling {@link ApplicationMasterProtocol#allocate(AllocateRequest)}
- without first registering by calling
- {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
- or if it tries to register more than once.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidApplicationMasterRequestException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidAuxServiceException -->
- <class name="InvalidAuxServiceException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidAuxServiceException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown by a NodeManager that is rejecting start-container
- requests via
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
- for auxservices does not exist.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidAuxServiceException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidContainerException -->
- <class name="InvalidContainerException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidContainerException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown by a NodeManager that is rejecting start-container
- requests via
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
- for containers allocated by a previous instance of the RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidContainerException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidContainerReleaseException -->
- <class name="InvalidContainerReleaseException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidContainerReleaseException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidContainerReleaseException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidContainerReleaseException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when an Application Master tries to release
- containers not belonging to it using
- {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidContainerReleaseException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidResourceBlacklistRequestException -->
- <class name="InvalidResourceBlacklistRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when an application provides an invalid
- {@link ResourceBlacklistRequest} specification for blacklisting of resources
- in {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API.
- Currently this exceptions is thrown when an application tries to
- blacklist {@link ResourceRequest#ANY}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidResourceBlacklistRequestException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException -->
- <class name="InvalidResourceRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidResourceRequestException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidResourceRequestException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidResourceRequestException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when a resource requested via
- {@link ResourceRequest} in the
- {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API is out of the
- range of the configured lower and upper limits on resources.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.NMNotYetReadyException -->
- <class name="NMNotYetReadyException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NMNotYetReadyException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown on
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)} API
- when an NM starts from scratch but has not yet connected with RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.NMNotYetReadyException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.YarnException -->
- <class name="YarnException" extends="java.lang.Exception"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="YarnException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YarnException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YarnException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YarnException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[YarnException indicates exceptions from yarn servers. On the other hand,
- IOExceptions indicates exceptions from RPC layer.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.YarnException -->
- </package>
- <package name="org.apache.hadoop.yarn.server.api">
- <!-- start class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
- <class name="ApplicationInitializationContext" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ApplicationId, java.nio.ByteBuffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user-name of the application-submitter
- @return user-name]]>
- </doc>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link ApplicationId} of the application
- @return applications ID]]>
- </doc>
- </method>
- <method name="getApplicationDataForService" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the data sent to the NodeManager via
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
- as part of {@link ContainerLaunchContext#getServiceData()}
- @return the servicesData for this application.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Initialization context for {@link AuxiliaryService} when starting an
- application.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
- <!-- start class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
- <class name="ApplicationTerminationContext" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationTerminationContext" type="org.apache.hadoop.yarn.api.records.ApplicationId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link ApplicationId} of the application being stopped.
- @return applications ID]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Initialization context for {@link AuxiliaryService} when stopping an
- application.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
- <!-- start class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
- <class name="AuxiliaryService" extends="org.apache.hadoop.service.AbstractService"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AuxiliaryService" type="java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecoveryPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the path specific to this auxiliary service to use for recovery.
- @return state storage path or null if recovery is not enabled]]>
- </doc>
- </method>
- <method name="initializeApplication"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="initAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationInitializationContext"/>
- <doc>
- <![CDATA[A new application is started on this NodeManager. This is a signal to
- this {@link AuxiliaryService} about the application initialization.
- @param initAppContext context for the application's initialization]]>
- </doc>
- </method>
- <method name="stopApplication"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stopAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationTerminationContext"/>
- <doc>
- <![CDATA[An application is finishing on this NodeManager. This is a signal to this
- {@link AuxiliaryService} about the same.
- @param stopAppContext context for the application termination]]>
- </doc>
- </method>
- <method name="getMetaData" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieve meta-data for this {@link AuxiliaryService}. Applications using
- this {@link AuxiliaryService} SHOULD know the format of the meta-data -
- ideally each service should provide a method to parse out the information
- to the applications. One example of meta-data is contact information so
- that applications can access the service remotely. This will only be called
- after the service's {@link #start()} method has finished. the result may be
- cached.
- <p>
- The information is passed along to applications via
- {@link StartContainersResponse#getAllServicesMetaData()} that is returned by
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
- </p>
- @return meta-data for this service that should be made available to
- applications.]]>
- </doc>
- </method>
- <method name="initializeContainer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="initContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerInitializationContext"/>
- <doc>
- <![CDATA[A new container is started on this NodeManager. This is a signal to
- this {@link AuxiliaryService} about the container initialization.
- This method is called when the NodeManager receives the container launch
- command from the ApplicationMaster and before the container process is
- launched.
- @param initContainerContext context for the container's initialization]]>
- </doc>
- </method>
- <method name="stopContainer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stopContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerTerminationContext"/>
- <doc>
- <![CDATA[A container is finishing on this NodeManager. This is a signal to this
- {@link AuxiliaryService} about the same.
- @param stopContainerContext context for the container termination]]>
- </doc>
- </method>
- <method name="setRecoveryPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="recoveryPath" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the path for this auxiliary service to use for storing state
- that will be used during recovery.
- @param recoveryPath where recoverable state should be stored]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A generic service that will be started by the NodeManager. This is a service
- that administrators have to configure on each node by setting
- {@link YarnConfiguration#NM_AUX_SERVICES}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
- <!-- start class org.apache.hadoop.yarn.server.api.ContainerContext -->
- <class name="ContainerContext" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get user of the container being initialized or stopped.
- @return the user]]>
- </doc>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link ContainerId} of the container being initialized or stopped.
- @return the container ID]]>
- </doc>
- </method>
- <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link Resource} the resource capability allocated to the container
- being initialized or stopped.
- @return the resource capability.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Base context class for {@link AuxiliaryService} initializing and stopping a
- container.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ContainerContext -->
- <!-- start class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
- <class name="ContainerInitializationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Initialization context for {@link AuxiliaryService} when starting a
- container.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
- <!-- start class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
- <class name="ContainerTerminationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Termination context for {@link AuxiliaryService} when stopping a
- container.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
- <!-- start interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
- <interface name="SCMAdminProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="runCleanerTask" return="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The method used by administrators to ask SCM to run cleaner task right away
- </p>
- @param request request <code>SharedCacheManager</code> to run a cleaner task
- @return <code>SharedCacheManager</code> returns an empty response
- on success and throws an exception on rejecting the request
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The protocol between administrators and the <code>SharedCacheManager</code>
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
- </package>
- <package name="org.apache.hadoop.yarn.util">
- </package>
- </api>
|